Skip to main content

VM Configurations

Prerequisites
  • Access Level: Admin, Super-admin.
  • Permission Requirements:
  • . 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
    • View host machines and hardware information in any Libvirt realm
    • Modify any user's VM username
    • Arbitrarily view logs from any VM
  • . Miscellaneous
    • Transfer ownership of own files and drives

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.

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.
  • If VM is turned off: In the left panel, view the VM configuration name, project, team, owners, Libvirt hardware setup, cores, memory, description, MAC address, host, home drive and additional read-write or read-only drives.
  • If VM is turned on: In the left panel, view the Start Remote Desktop, File Transfer, Open Terminal, File Explorer, SFTP to VM and VM Settings and Details sections.
info

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

Share a VM Configuration from Management with Other User(s)​

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 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 the VM with.
  8. Click Update.
caution

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

tip

Only share a VM in read-write mode with a trusted VM owner. To add regular user to a VM, use 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 the VM configuration to change its team.
  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 the connected VM configuration 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 the connected VM configuration 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 from scratch.
  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 format, while any extra drives may also be in read-only format.

Create an Additional Read-Only 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 the connected VM configuration 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 New Drive button to create a new read-only drive from scratch.
  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 the connected VM configuration 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 the connected VM configuration to update drives.
  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

VMs automatically restart to apply the latest edits, so expect a restart after making changes.

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 the connected VM configuration to update drives.
  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 the connected VM configuration to update drives.
  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 VM on.
  9. Click Save.

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 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, rqDriveCount, 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 pop-up, click Copy to copy the emails or click Download to download the emails.
  8. Once done, click Close.
note

Tick the Prefer contact email? to use the email registered upon user account creation.

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 prompt, click Delete.
note

You cannot delete a VM configuration that is currently Running.