Running VMs

Prerequisites

• Access Level: Admin, Super-admin.
• Permission Requirements:
• . Basic Project Interaction
  • View projects they are a member of
  • Classify resources with projects they are active in
• . Project Management
  • Declassify resources tagged with projects they manage
• . Basic VM Interaction
  • View drives (inconsistent, see notes)
  • Create drives
  • Edit drives (name and whether to disable backup)
  • View drive keys (necessary to share/attach)
  • Share drives
  • Unshare drives
  • Attach drives to VMs
  • Detach drives from VMs
  • View hardware/image setups made available to them
  • View own VM configs and configs shared with them
  • Create (and edit) VM configs
  • Spawn VMs from VM configs
  • Stop VMs spawned from VM configs
  • View own VM username
  • View anyone's VM username (necessary for sharing VMs)
  • Create sub-session for VM->Vault direct transfer
  • View own VMs and VMs shared with them
  • Spawn VMs(without a config)
  • Connect to own VMs and VMs shared with them
  • Share VMs with other users
  • Shutdown own VMs
• . VM Administration
  • View all VM images
  • View all hardware/image setups in the system
  • View all VM configs in the system
  • Arbitrarily edit any VM config
  • Arbitrarily delete any VM config
  • Modify any user's VM username
  • Arbitrarily view logs from any VM

Start an RDP Connection of a Running VM Configuration from Management

Method one:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to open an RDP connection.
5. Click the Open Remote Application button in the top right panel.
6. In the new local window, click Connect.
7. In the tiCrypt pop-up, click Copy to copy the password.
8. In the new local window, paste the password.
9. Click OK.
10. Click Yes to confirm the remote desktop connection.
11. Once your work is done, click Close to exit the RDP connection.

Method two:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to open an RDP connection.
5. Click the View button in the top right panel.
6. In the left panel, click the Start Remote Desktop button.
7. In the new local window, click Connect.
8. In the tiCrypt pop-up, click Copy to copy the password.
9. In the new local window, paste the password.
10. Click OK.
11. Click Yes to confirm the remote desktop connection.
12. Once your work is done, click Close to exit the RDP connection.

info

You must Connect your VM before starting an RDP connection.

Move Files Between Vault and the Running VM Configuration from Management

Method one:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to transfer the files.
5. Click the Transfer files to/from Vault button in the top right panel.
6. In the new prompt, drag-and-drop files from the Vault (left panel) to the VM drives and access directories (right panel) and vice-versa.

Method two:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to transfer its files.
5. Click the View button in the top right panel.
6. In the left panel, click the File Transfer button.
7. In the new prompt, drag-and-drop files from the Vault (left panel) to the VM drives and access directories (right panel) and vice-versa.

info

View more details about transfer options in Transfer.

Explore Files of a Running VM Configuration from Management

Method one:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to explore its files.
5. Click the File Explorer button in the top right panel.
6. In the left panel, explore all drives and access directories associated with the VM configuration.

Method two:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to explore its files.
5. Click the View button in the top right panel.
6. In the left panel, click the File Explorer button.
7. Explore all drives and access directories associated with the VM configuration in the left panel.

Open Terminal of a Running VM Configuration from Management

Method one:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to open the terminal.
5. Click the Open Terminal Hub button in the top right panel.

Method two:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to open the terminal.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Terminal button.

info

View the terminal settings in the left panel as described in Terminals.

Perform an SFTP to VM Transfer of a Running VM Configuration from Management

Method one:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to perform the SFTP transfer.
5. Click the Open SFTP pathway button in the top right panel.
6. In the pop-up, click Copy to copy the username, password, host and port to your SFTP client.

Method two:

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to perform the SFTP transfer.
5. Click the View button in the top right panel.
6. In the left panel, click the SFTP to VM button.
7. In the pop-up, click Copy to copy the username, password, host and port to your SFTP client.

info

For LFTP or SSHFS transfers, visit the Remote File System section.

Access VM Settings and Details of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to view its details.
5. Click the View button in the top right panel.
6. In the left panel, click VM Settings and Details section.
7. In the new window, view the following sections.

• . Overview: view basic VM information and live quotas.
• . Drives: view the read-write and read-only drives associated with the VM.
• . Users: view the users who belong to the VM.
• . Profiles: view all VM profiles.
• . Groups: view groups that are using the VM.
• . Access Directories: access the VM directories.
• . Logs: view past VM log entries.
• . Video annotation types: access video annotation tools for custom use cases.

View Quotas of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view quotas.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, in the Overview section, view the CPU, Memory Used, Kilobytes Received, Kilobytes Send, Home/Attached Drives Usage, VM Basic Information and Last 50 Logs entry.

View Drives of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view drives.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Drives section in the left panel.
8. View your drive(s) in the list by name, owner, state, ID, format, type mount path, read-only status, usage, attached date and backup status.

Attach Existing Drive(s) to a Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to attache a drive.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Drives section in the left panel.
8. Click the Attach drive(s) button in the top panel.
9. In the prompt, select Add a new drive.
10. Next, enter the drive name and its type.
11. Repeat the action to add as many drives as needed.
12. Once done, click Attach and mount.

tip

For best practice, tick the box Add drive(s) to the VM configuration and share drive(s) with co-owners.

Create a New Drive for a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to create a new drive.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Drives section in the left panel.
8. Click the Attach drive(s) button in the top panel.
9. In the prompt, select Create a new drive.
10. In the new prompt, enter the drive name, capacity, and format.
11. Add an optional owner, team, optional project, and realm.
12. Click Create.

Mount All Drives in a Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to mount all drives in.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Drives section in the left panel.
8. Click the Mount all Drives button in the top panel.

View Users of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its users.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Users section in the left panel.
8. View all VM users in the list by name, VM username, role, user profile and groups.

Add User(s) to a Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to add user(s).
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Users section in the left panel.
8. Click the Add users button in the top panel.
9. In the pop-up, enter the user name(s) to add, profile, or their role in the running VM.
10. For custom user(s), tick or untick permissions.
11. Click Add users.

Add Team(s) to a Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to add team(s).
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Users section in the left panel.
8. Click the Add users button in the top panel.
9. In the pop-up, enter the team name(s) to add, profile, or their role in the running VM.
10. For custom team(s), tick or untick permissions.
11. Click Add users.

Add Group(s) to a Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to add group(s).
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Users section in the left panel.
8. Click the Add users button in the top panel.
9. In the pop-up, enter the group name(s) to add, profile, or their role in the running VM.
10. For custom group(s), tick or untick permissions.
11. Click Add users.

Sync User Permissions of a Running VM Configuration from Management

bulk-action

Method 1:

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to sync user permissions.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Users section in the left panel.
8. Click the Sync user permissions button in the top panel.

Method 2:

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to sync user permissions.
5. Click the Open Full Menu button in the top right panel.
6. Select Sync user permissions.

Re-authorize Users in a Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to re-authorize users.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Users section in the left panel.
8. Select the user(s) to re-authorize.
9. Click the Open Full Menu three-dot button in the top right panel.
10. Select Re-aauthorize User(s).

Repair Users Homes in a Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to repair users homes.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Users section in the left panel.
8. Select the user(s) to repair their homes.
9. Click the Open Full Menu three-dot button in the top right panel.
10. Select Repair user home(s).

View Running VM Profiles from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to repair users homes.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Profiles section in the left panel.
8. View the running VM profiles in the list by name, role, count, and permisions.

Create a New VM Profile in a Running VM from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to create a new VM profile.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Profiles section in the left panel.
8. Click the Add new profile button in the top-right panel.
9. In the pop-up, enter the profile name, role and permissions in the running VM.
10. Click Create Profile

note

You cannot have two or more identical VM profiles in the same running VM.

Import a VM Profile into a Running VM from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to import VM profile.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Profiles section in the left panel.
8. Click the Add new profile button in the top panel.
9. In the pop-up, tick Import profile from the same or other VM.
10. Select the import profile and enter a new profile name.
11. Alter permissions for the imported profile.
12. Click Create Profile.

Edit Permissions in a Running VM Profile from Management

Method one:

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to edit its VM profile's permissions.
5. Click the VM Settings and Details option in the bottom center.
6. In the new window, select the Profiles section in the left panel.
7. Click the Edit permissions button in the top right panel.
8. Next, tick or untick permissions of the VM user profiles.
9. Click Save in the top right corner.

Method two:

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to edit its VM profile's permissions.
5. Click the VM Settings and Details option in the bottom center.
6. In the new window, select the Profiles section in the left panel.
7. Click the Edit button next to the VM profile you want to edit.
8. In the pop-up, udpate name or tick or untick permissions as needed.
9. Click Save.

Delete a VM Profile in a Running VM from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to delete its VM profile.
5. Click the VM Settings and Details option in the bottom center.
6. In the new window, select the Profiles section in the left panel.
7. Click the Remove button next to the VM profile you want to delete.
8. In the pop-up, click Remove to proceed.

View Groups in Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its groups.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Groups section in the left panel.
8. View the running VM groups in the list by name, creation and last updated dates, members and access directories.

Create a New Group in Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its groups.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Groups section in the left panel.
8. Click the Create group button in the top panel.
9. In the pop-up, enter the group name.
10. Click Create group.

Sync All Groups in Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its groups.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Groups section in the left panel.
8. Click the Sync all groups button in the top panel.

View Group Members in Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its groups.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Groups section in the left panel.
8. Select the group to view its members.
9. Click the View button in the top right panel.
10. In the new prompt, view the group members in the list by name, account name, profile, role, and actions.
11. Click the member's Name to view their information in the running VM.
12. In the new prompt, view the member's basic information and permissions.

Edit Group Members in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to edit its users.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Groups section in the left panel.
8. Select the group to view its members.
9. Click the View button in the top right panel.
10. In the new prompt, view the group members in the list by name, account name, profile, role, and actions.
11. Click the member's Name to view their information in the running VM.
12. In the new prompt, click the Edit button in the top right panel.
13. In the pop-up, update the user name, profile and permissions.
14. Click Save.

Remove Group Members from a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to remove its users.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Groups section in the left panel.
8. Select the group to view its members.
9. Click the View button in the top right panel.
10. In the new prompt, view the group members in the list by name, account name, profile, role, and actions.
11. Click the member's Name to view their information in the running VM.
12. In the new prompt, click the Delete button in the top right panel.
13. In the pop-up, click Remove.

View Access Directories in Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its access directories.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Access Directories section in the left panel.
8. View the existing access directories in the list by name, type, drive, path, owner, group & permissions, creation and last updated dates, and users & permissions.

Create a New Access Directory in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its access directories.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Access Directories section in the left panel.
8. Click the Create access directory button in the top panel.
9. In the pop-up, select a directory location, name, owner, users and groups.
10. Click Create.

Sync All Permisions of Access Directories in a Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to sync all permissions in its access directories.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Access Directories section in the left panel.
8. Click the Sync All Permissions button in the top panel.

View Details of an Access Directory in Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its access directory details.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Access Directories section in the left panel.
8. Select an access directory to view its details.
9. Click the View button in the top right panel.
10. In the new prompt, view basic and access information of the access directory by name, user home status, location, path from root, creation and last modified dates, owner, user, and group.

Edit an Access Directory in Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to edit its access directory.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Access Directories section in the left panel.
8. Select an access directory to edit.
9. Click the View button in the top right panel.
10. In the new prompt, click the Edit button in the top right panel.
11. In the pop-up, update the access directory name, owner, users and groups.
12. Click Update.

Delete an Access Directory in Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to delete its access directory.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Access Directories section in the left panel.
8. Select an access directory to delete.
9. Click the View button in the top right panel.
10. In the new prompt, click the Delete button in the top right panel.
11. In the pop-up, click Delete access directory.

View Logs of a Running VM Configuration from Management

Method one:

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its logs.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, select the Logs section in the left panel.
8. View the running VM logs in the list by number, timestamp, user and log entry.
9. Optionally, click Load Older to view older logs or Download to download all logs.
10. Once done, click Close.

Method two:

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to view its logs.
5. Click the Open Full Menu button in the top right panel.
6. Select View logs.
7. In the pop-up, view the logs.
8. Optionally, click Load Older to view older logs or Download to download all logs.
9. Once done, click Close.

Access Applications of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to access its applications.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. View the existing video annotation templates by name, type, drive, path, export path and buffer size.

Create a Video Annotation Template in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to create a video annotation template.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. Click Add template in the top right panel.
9. In the prompt, enter the template name.
10. Select the annotation type and directory.
11. Optionally, select the export directory and the custom video playback buffer size.
12. Click Create Templates.

View a Video Annotation Template in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view a video annotation template.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. Select the video annotation to view its details.
9. Click the View button in the top right panel.
10. In the new window, view the video annotation categories and tags.

Add a Category to Video Annotation Template in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to add a video annotation category.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. Select the video annotation to add category.
9. Click the View button in the top right panel.
10. In the new window, click the Edit button on the right.
11. Click Add category in the top-left panel.
12. In the prompt, enter the category name.
13. Click Create category.
14. Click the Save button on the top right.

Add a Category Tag in Video Annotation Template in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to add a video annotation category tag.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. Select the video annotation to add category tag.
9. Click the View button in the top right panel.
10. In the new window, click the Edit button on the right.
11. Click Add tag to category next to the category you want to add a tag to.
12. Enter the tag name below category name.
13. Tick the VM groups who will be tagged in the category.
14. Once done, click the Save button on the top right.

note

The default tag is set to Everybody, which includes all users from the running virtual machine.

Edit a Category Tag in Video Annotation Template in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to edit a video annotation category tag.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. Select the video annotation to edit category tag.
9. Click the View button in the top right panel.
10. In the new window, click the Edit button on the right.
11. Update the tag name below category name or the VM users the tag applies to.
12. Once done, click the Save button on the top right.

Edit a Video Annotation Template in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to edit its video annotation template.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. Select the video annotation template to edit.
9. Click the Open full menu button in the top right panel.
10. Select Edit.
11. In the prompt, update the annotation name, type, directory, export directory or video playback buffer size.
12. Once done, click Save Changes.

Delete a Category Tag from Video Annotation Template in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to delete its video annotation category tag.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. Select the video annotation template to delete tag from its category.
9. Click the View button in the top right panel.
10. In the new window, click the Edit button on the right.
11. Next, click the Delete button next to the tag you want to remove.
12. In the prompt, click Delete tag.

Delete a Category from Video Annotation Template in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to delete its video annotation category.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. Select the video annotation template to delete its category.
9. Click the View button in the top right panel.
10. In the new window, click the Edit button on the right.
11. Click the Remove category button next to the category you want to delete.
12. In the prompt, click Delete category.

Delete a Video Annotation Template in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to delete its video annotation.
5. Click the View button in the top right panel.
6. In the left panel, click the VM Settings and Details section.
7. In the new window, click the Video annotation types section in the left panel.
8. Select the video annotation template to delete.
9. Click the Open full menu button in the top right panel.
10. Select Delete.
11. In the prompt, click Delete.

Share Running VM Configuration from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to share.
5. Click the Open Full Menu button in the top right panel.
6. Select Share.
7. In the pop-up, enter the user name(s) to share and select the user access sync atempt.
8. Click Update.

caution

When you share a VM configuration, its associated drives are also shared. Users with access to the shared VM can restart and mount these drives. Proceed with caution.

Copy the VM ID of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to copy VM ID.
5. Scroll right to the VM ID column.
6. Click Copy.
7. Paste the VM ID where necessary.

note

VM IDs of running VMs are usually a string of numbers and characters. For example: 71b232c7-73a5-450c-93c6-48r12a3d4567.

Copy the Host Server of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to copy host server.
5. Scroll right to the Host Server column.
6. Click Copy.
7. Paste the host server where necessary.

Copy the IP Address of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to copy IP address.
5. Scroll right to the IP Address column.
6. Click Copy.
7. Paste the IP address where necessary.

note

IP addresses of running VMs are usually four sets of three numbers. For example: 192.168.123.456.

Make a JSON Export of Running VM(s) Configuration(s) from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM to export in JSON format.
5. Click the Open Full Menu button in the top right panel.
6. Select JSON Export.
7. In the pop-up, click Expand all fields button in the top left panel.
8. View the selected running VMs by users, groups, drives, accessDirectories and profiles categories.
9. Once done, click Copy to copy the JSON data or click Download to download the JSON data.
10. Click Close.

View the Libvirt XML Description of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to view its XML description.
5. Click the Open Full Menu button in the top right panel.
6. Select Libvirt XML description.
7. In the pop-up, view the backend Libvirt XML description.
8. Click Copy to copy the XML description or click Download to download the XML description.
9. Once done, click Close.

note

Viewing Libvirt XML descriptions is only available to users with Super-Admin role.

Open a VNC Terminal of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to open VNC terminal.
5. Click the Open Full Menu button in the top right panel.
6. Select Open VNC Terminal.
7. In the new window, access the VNC terminal.

note

Opening a VNC terminal allows you to connect to running virtual machines in Debug mode to resolve issues.

Restart Controller of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to restart controller.
5. Click the Open Full Menu button in the top right panel.
6. Select Restart controller.
7. In the pop-up, click Restart.

Forcefully Restart Controller of a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to force restart controller.
5. Click the Open Full Menu button in the top right panel.
6. Select Restart controller.
7. In the pop-up, tick I know the risks of force restarting the controller, and wish to force restart anyways.
8. Click Force Restart.

Enable Applications in a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM configuration to enable applications.
5. Click the Open Full Menu button in the top right panel.
6. Select Enable Applications.

Bulk Email Users in Running VM(s) Configuration(s) from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM(s) to bulk email its users.
5. Click the Open Full Menu button in the top right panel.
6. Select Bulk Email.
7. In the pop-up, click Copy to copy the emails or click Download to download the emails.
8. Once done, click Close.

Set Project in Running VM(s) Configuration(s) from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM(s) whose project you want to set.
5. Click the Open Full Menu three-dot button in the top right panel.
6. Select Set project.
7. In the pop-up, select the project to tag the running VM.
8. Click Classify.

Forcefully Set Project in Running VM(s) Configuration(s) from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM(s) whose project you want to forcefully set.
5. Click the Open Full Menu three-dot button in the top right panel.
6. Select Set project.
7. In the pop-up, select the project to tag the running VM(s).
8. Click Force change with admin privilege.

Remove Project from Running VM(s) Configuration(s) from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running VM(s) whose project you want to remove.
5. Click the Open Full Menu three-dot button in the top right panel.
6. Select Set project.
7. In the pop-up, select No project (unlocked).
8. Click Declassify.

note

• Declassification requires admin permissions and membership in the specified project.
• As a user with Super-admin role you may also forcefully declassify a project from a running VM.

Disconnect from a Running VM Configuration from Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running virtual machine to disconnect.
5. Click the Open Full Menu three-dot button in the top right panel.
6. Select Disconnect from VM.

Restart Running VM Configuration(s) from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running virtual machine(s) you want to restart.
5. Click the Open Full Menu button in the top right panel.
6. Select Power.
7. In the pop-up, click Restart.

info

You can restart only VMs that you own, no matter your user role.

Shut Down Running VM Configuration(s) from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running virtual machine(s) you want to shut down.
5. Click the Open Full Menu button in the top right panel.
6. Select Power.
7. In the pop-up, click Normal Shutdown.

Hard Shut Down Running VM Configuration(s) from Management

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Running VMs in the left panel.
4. Select the running virtual machine(s) you want to hard shut down.
5. Click the Open Full Menu button in the top right panel.
6. Select Power.
7. In the pop-up, read the risks.
8. Tick the box I accept the risk.
9. Click Hard shutdown.

danger

Use Hard VM shutdowns only as a last resort, as they can severely harm the VMs.