Skip to main content
tiCrypt 2.18.1

VM Configurations

Prerequisites

User Role:

Sub-admin, Admin, Super-admin (Super-admin to shut down a configuration you do not own)

Permission Requirements

  • VM Administration
    • View all VM configurations
    • Edit any VM configuration (to change the project of configurations)
    • Delete any VM configuration (to delete configurations you do not own)

Access a 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 VM Configurations in the left panel.

Rows of running configurations are green. A row is red when its hardware setup is unknown.

The following table describes the columns of the VM Configurations table.

ColumnContent
NameThe name of the configuration.
StateThe state of the configuration, such as Stopped or Running.
Owner(s)The owner and co-owners of the configuration.
VM SetupThe hardware setup the configuration uses.
ProjectThe project tag of the configuration.
TeamThe team of the configuration.
Virtual MachineThe running VM started from the configuration, when it is running.
Last PingWhen the running VM last contacted tiCrypt.
Last LaunchedWhen the configuration was last started.
RW DrivesThe number of read-write drives.
RO DrivesThe number of read-only drives.
Fixed MACThe MAC address set for the configuration, if any.
Which actions appear

Edit and Add co-owners appear only for configurations you own: an administrator role does not let you edit or share someone else's configuration. On any configuration, you can use Bulk email and, with the right permissions, Change Project and Delete. Power appears for a running configuration you own, or for any running configuration if you are a Super-admin.

View Basic Information, Projects, and Drives of a 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 VM Configurations in the left panel.
  4. Select the VM configuration to view.
  5. Click the View button in the top right panel.
  6. Review the VM configuration panel.

The following table describes the content of the VM configuration panel.

SectionContent
DescriptionThe configuration description, when it has one.
Basic infoHardware setup, Running VM (when the configuration is running, with a link to the VM's panel), Project, Team, MAC address, Host, Last launched, Last ping ("Never" when it has not happened), Slurm account and Slurm fairshare (when set) and the ID.
Owner or N OwnersThe owner and co-owners.
Home driveThe first drive of the configuration.
N Additional Read-Write DrivesThe other read-write drives.
N Additional Read-Only DrivesThe read-only drives.

If you can view all VMs, the Running VM link opens the VM's Management panel, not the panel a VM user works from.

info

To view more Running VM actions, navigate to the Running VMs management section.

Add Co-Owners to a VM Configuration from Management​

caution

You can add co-owners to configurations you own. Doing so shares the associated drives, and co-owner status carries access to those drive keys, so this grants data access rather than only administrative visibility. Your role does not let you grant that on a configuration belonging to someone else: access to another user's VM comes from its Owner adding them, not from the Management console. See VM Roles and Permissions.

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click the VM Configurations in the left panel.
  4. Select one VM configuration that you own. Add co-owners does not appear for configurations owned by someone else.
  5. Click the Open full menu button in the top right panel.
  6. Select Add co-owners.
  7. In the pop-up, enter the user names to add as co-owners to the virtual machine.
  8. Click Update <name>.
caution

VMs shared in Management are always in read-write mode, allowing co-owners to access the VM if the primary owner is unavailable.

tip

Grant full access to a VM only to a trusted co-owner.
To add a regular user to a VM, use the Add users to Virtual Machine option.

Change the Team Using the 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 VM Configurations in the left panel.
  4. Select a VM configuration that you own. Edit does not appear for configurations owned by someone else.
  5. Click the Open full menu button in the top right panel.
  6. Select Edit.
  7. In the pop-up, under Team, click Remove.
  8. Enter the new team name.
  9. Click Save.

Update the Project of an Existing 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 VM Configurations in the left panel.
  4. Select a VM configuration that you own whose project you want to update.
  5. Click the Open full menu button in the top right panel.
  6. Select Edit.
  7. In the pop-up, under Project, select the new project.
  8. Click Save.

Create an Additional Home Read-Write Drive for an Existing 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 VM Configurations in the left panel.
  4. Select a VM configuration that you own to create new drives in.
  5. Click the Open full menu button in the top right panel.
  6. Select Edit.
  7. In the pop-up, under Home drive, click the Create new drive button to create a new home read-write drive.
  8. In the new prompt, enter a drive name, format, team, and project.
  9. Add a drive owner, select the realm and drive capacity.
  10. Click Create.
  11. Click Save.
info

The Home drive must be in read-write mode, while any extra drives may be in read-write or read-only mode.

Create an Additional Extra Drive for an Existing 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 VM Configurations in the left panel.
  4. Select a VM configuration that you own to create new drives in.
  5. Click the Open full menu button in the top right panel.
  6. Select Edit.
  7. In the pop-up, under Extra drives, click the Create a new drive button. The new drive is added to the configuration as a read-write drive.
  8. In the new prompt, enter a drive name, format, team, and project.
  9. Add a drive owner, select the realm and drive capacity.
  10. Click Create.
  11. Click Save.

Add New Drive Slots to an Existing 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 VM Configurations in the left panel.
  4. Select a VM configuration that you own to add more drives to.
  5. Click the Open full menu button in the top right panel.
  6. Select Edit.
  7. In the pop-up, under Extra drives, click the Add a new drive button to open a new drive slot in the VM configuration.
  8. Enter the order, drive name and type.
  9. Click Save.

Edit the Hardware Setup of an Existing 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 VM Configurations in the left panel.
  4. Select a VM configuration that you own whose hardware setup you want to edit.
  5. Click the Open full menu button in the top right panel.
  6. Select Edit.
  7. In the pop-up, under Hardware Setup, click Remove.
  8. Search and select a new hardware setup.
  9. Click Save.
note

For a configuration that is starting or running, the pop-up shows: "This VM configuration is currently starting or running. Virtual machines are only configured when starting them, so any changes you make will not take effect until you restart the configuration."

Select a Specific MAC Address for the 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 VM Configurations in the left panel.
  4. Select a VM configuration that you own whose MAC address you want to set.
  5. Click the Open full menu button in the top right panel.
  6. Select Edit.
  7. In the pop-up, under the Description subsection, click the VM Host & MAC Address button.
  8. Enter a preferred MAC address.
  9. Click Save.
note

By default, a MAC address is assigned automatically.

Select a Preferred Host to Start the 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 VM Configurations in the left panel.
  4. Select a VM configuration that you own whose preferred host you want to set.
  5. Click the Open full menu button in the top right panel.
  6. Select Edit.
  7. In the pop-up, under the Description subsection, click the VM Host & MAC Address button.
  8. Search for and select a preferred host to start the VM on.
  9. Click Save.

Change the Project of VM Configuration(s) from Management​

bulk-action

Change Project sets the project tag of several configurations at once, including configurations you do not own. It also changes the project tag of every drive of those configurations, so the drives and the configuration stay in the same project.

Location: Management > Virtual Machines > VM Configurations

  1. Select the VM configuration(s). Every selected configuration must be Stopped; otherwise Change Project does not appear.
  2. Click the Open full menu button in the top right panel.
  3. Select Change Project.
  4. In the Change project tag for <name | N VM Configurations> pop-up, select the new project, or remove the project tag.
  5. Click Classify, Declassify or Force change with admin privilege. The label depends on the project you choose and on the options you tick in the pop-up.
Result:

A task sets the project of each configuration, then the project tag of each of their drives.

Shut Down a Running VM Configuration from Management​

Location: Management > Virtual Machines > VM Configurations

  1. Select one running VM configuration. Power appears for configurations you own, or for any configuration if you are a Super-admin.
  2. Click the Open full menu button in the top right panel.
  3. Select Power.
  4. In the Shut down <name>? pop-up, click Normal Shutdown, or tick I accept the risk. and click Hard shutdown.
Result:

The VM started from the configuration shuts down. This pop-up has no Restart option.

warning

A hard shutdown "Instantly forces the VM to shut down, but risks data corruption on your drives. Use with caution."

Make a CSV Export of a 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 VM Configurations in the left panel.
  4. Select the connected VM configuration(s) to export in CSV format.
  5. Click the Export CSV button in the top right corner.
  6. Select the Selected items option.
  7. In the new window, click Save to save the data locally.

Make a JSON Export of a 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 VM Configurations in the left panel.
  4. Select the connected VM configuration(s) to export in JSON format.
  5. Click the Export JSON button in the top right corner.
  6. Select the Export selected items option.
  7. In the new window, click Save to save the data locally.

View a JSON Export of a 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 VM Configurations in the left panel.
  4. Select the connected VM configuration(s) to export in JSON format.
  5. Click the Export JSON button in the top right corner.
  6. Select the View selected items option.
  7. In the pop-up, click the Expand all fields button in the top left panel.
  8. View the selected VM configuration(s) by id, name, state, ownerNames, teamID, teamName, brickID, brickName, rwDriveCount, roDriveCount, mac and vmName.
  9. Once done, click Copy to copy the JSON data or click Download to download the JSON data.
  10. In the local window, click Save.
  11. Once done, click Close.

Bulk Email All Users from 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 VM Configurations in the left panel.
  4. Select the VM configuration(s) to bulk email.
  5. Click the Open full menu button in the top right panel.
  6. Select Bulk email.
  7. In the Copy/download N user email(s) pop-up, which lists the owners and co-owners of the selected configurations, click Copy to copy the emails or click Download to download the emails.
  8. Once done, click Close.
note

The Prefer contact email? checkbox is ticked by default, and the list uses each user's contact email, or the login email for users without one. Untick it to use the login email of every user.

Delete 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 VM Configurations in the left panel.
  4. Select the VM configuration(s) you want to delete.
  5. Click the Open full menu button in the top right panel.
  6. Click Delete.
  7. In the Delete <name | N VM configurations>? prompt, click Delete <name | N VM configurations>.
Result:

The configurations are deleted. The prompt warns: "If this VM configuration is shared with other users, it will no longer be accessible. VM configurations can be re-created but will need to be shared again."

note

Every selected VM configuration must be Stopped. Otherwise nothing is deleted and a message names the problem, such as "<name> is not stopped". Deleting a configuration you do not own needs the Delete any VM configuration permission.