Service VMs

Prerequisites

• Access Level: Admin, Super-admin.
• Permission Requirements:
• . Basic VM Interaction
  • 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 own VMs and VMs shared with them
  • Spawn VMs(without a config)
  • Connect to own VMs and VMs shared with them
  • Shutdown own VMs
• . VM Administration
  • View raw Libvirt volumes (images)
  • Upload raw Libvirt volumes (images)
  • View all VM images
  • Edit any VM image
  • Delete any VM image
  • View all hardware/image setups in the system
  • Create hardware/image setups
  • Edit hardware/image setups
  • Arbitrarily delete any hardware/image setup
  • 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
  • Register physical VM host machines in Libvirt realms
  • Edit VM host machine info in any Libvirt realm
  • Delete VM host machine info in any Libvirt realm
  • Arbitrarily view logs from any VM

Access Service VMs in Management

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.

Create a New Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Click the Create new service VM button in the top right panel.
5. In the pop-up, enter the image, hardware cores and maximum memory, allocated devices, service VM name and description.
6. Click Accept.

Open VNC Terminal of a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM to open the VNC terminal.
5. Click the Open VNC terminal button in the top right panel.
6. In the new window, use the VNC terminal.

Power Up a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM to power up.
5. Click the Power up button in the top right panel.

Edit the Image of a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM to edit image.
5. Click the Open Full Menu button in the top right panel.
6. Select Edit.
7. In the pop-up, under the Image & Hardware subsection, click the Close button to remove the existing image.
8. Enter the new image name.
9. Click Accept.

note

Removing an existing image will not delete the image from the system.

Edit the Cores and Memory of a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM to edit cores and memory.
5. Click the Open Full Menu button in the top right panel.
6. Select Edit.
7. In the pop-up, under Hardware settings subsection, enter the new cores and maximum memory.
8. Click Accept.

Edit the Devices of a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM whose devices 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 the Devices subsection, click the Plus button next to the appropriate device.
8. Click Accept.

note

To remove an incorrect device, click the Minus button under the same settings.

Edit the Metadata of a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM whose metadata you want to edit.
5. Click the Open Full Menu button in the top right panel.
6. Select Edit.
7. In the pop-up, scroll down to the Metadata subsection.
8. Enter a new name and description for the service VM.
9. Click Accept.

View the Libvirt XML Description of a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM whose Libvirt XML description you want to view.
5. Click the Open Full Menu button in the top right panel.
6. Select Libvirt XML description.
7. In the pop-up, view the XML description.
8. Once done, click Close.

Copy or Download the Libvirt XML Description of a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM whose Libvirt XML description you want to copy or download.
5. Click the Open Full Menu button in the top right panel.
6. Select Libvirt XML description.
7. In the pop-up, click Copy to copy the Libvirt XML description or click Download to download it.
8. Once done, click Close.

Bulk Email All Users of a Service VM

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM whose users you want to email in bulk.
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.

Restart Controller of a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM whose controller you want to restart.
5. Click the Open Full Menu button in the top right panel.
6. Select Restart Controller.

info

Restarting the VM controller of a service VM serves as an update mechanism. Whenever the VM controller's options are changed in the backend, a restart may be required for the changes to take effect.

Shut Down a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the running service VM to shut down.
5. Click the Shut Down button in the top right panel.

Delete a Service VM

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Service VMs in the left panel.
4. Select the service VM to delete.
5. Click the Open Full Menu button in the top center panel.
6. Click Delete.
7. In the prompt, click Delete.

info

Deleting a service VM removes it from the pre-setup VMs, but its images remain intact in the system.