VM Configurations

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.
6. In the left panel, view the VM configuration name, owners, projects, team, Libvirt hardware setup, cores, memory, description, MAC address, host, home drive and additional drives.

Share a VM Configuration from Management with Other Users

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 names to share and select the user access sync atempt.
8. Click Save.

note

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 VM configuration 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 connected 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.

Update the Drives 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 drives 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 Home drive and Extra drives, select a different drive.
8. Click the Create New Drive button to optionally create a drive from scratch.
9. Click Save.

info

The Home Drive must be in read-write format, while any extra drives may also be in read-only format.

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 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 Basic Information subsection, click the VM Host & MAC Address button.
8. Search for and select a preferred host to start VM on.
9. Click Save.

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 Basic Information 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.

View Quotas 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 quotas.
5. Click the View button in the top right panel.
6. In the left panel, scroll down to the VM manager.
7. View the Cores, Memory, Home drive usages, Network In and Network Out.

View Controller Logs 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 connected VM configuration to download controller logs.
5. Click the View button in the top right panel.
6. In the left panel, scroll down and click the Controller Logs card.
7. View the controller logs.

tip

Use the Filter Log to search logs by Errors, Warnings, Info, and Debug.

Download Controller Logs 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 connected VM configuration to download controller logs.
5. Click the View button in the top right panel.
6. In the left panel, scroll down to Controller Logs card.
7. Click the Download button on the right.

View Logs 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 connected VM configuration to view logs.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Full Menu button.
7. Select View logs.
8. In the pop-up, view the logs.
9. Once done, click Close.

tip

Click Load Older to refresh older logs.

Make a JSON Export 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 connected VM configuration to export in JSON format.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Full Menu button.
7. Select JSON Export.
8. In the pop-up, click Copy to copy the JSON data or click Download to download the JSON data.
9. Click Close.

View the Libvirt XML Description 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 connected VM configuration to view XML description.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Full Menu button.
7. Select Libvirt XML description.
8. In the pop-up, view the backend Libvirt XML description.
9. Click Copy to copy the XML description or click Download to download the XML description.
10. Once done, click Close.

Open a VNC Terminal 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 connected VM configuration to open VNC terminal.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Full Menu button.
7. Select Open VNC terminal.
8. In the pop-up, use the VNC terminal.
9. Once done, click Close.

Restart Controller 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 connected VM configuration to restart controller.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Full Menu button.
7. Select Restart controller.
8. In the pop-up, click Restart.

Forcefully Restart Controller 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 connected VM configuration to force restart controller.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Full Menu button.
7. Select Restart controller.
8. In the pop-up, tick I know the risks of force restarting the controller, and wish to force restart anyways.
9. Click Force Restart.

Sync User Permission 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 connected VM configuration to sync user permissions.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Full Menu button.
7. Select Sync user permissions.

Enable Applications in 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 connected VM configuration to enable applications.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Full Menu button.
7. Select Enable Applications.

Bulk Email All Users from 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 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.

Disconnect from 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 connected virtual machine to disconnect.
5. Click the View button in the top right panel.
6. In the left panel, click the Open Full Menu button.
7. Select Disconnect from VM.

Shut Down 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 connected virtual machine 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 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 connected virtual machine 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.

Delete 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 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.