Skip to main content
tiCrypt 2.18.1

Realms

info

For backend configuration of realms, see Backend: Libvirt Configuration.

Prerequisites

User Role:

Sub-admin, Admin, Super-admin

Access Realms​

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

The Realms table shows each realm's Name and Driver. Realms come only from the backend configuration, so the table has no create button and needs no permission beyond access to the Management console. If the backend defines no realm, the table shows "No VM realms have been configured in the backend; this is probably a mistake."

View a Realm’s Libvirt Configuration​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click Realms in the left panel.
  4. Select the realm to view its configuration.
  5. Click the View config button in the top right panel.
  6. In the pop-up, view the realm configuration from the backend.
  7. Click Close.

View Basic Information of a Realm​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click Realms in the left panel.
  4. Select the realm to view its basic information.
  5. Click the View button in the top right panel.
  6. Review the Realm panel. Its header shows the driver.

The following table describes the content of the Realm panel.

SectionContent
Basic infoName, Driver, Default realm (Yes or No) and the ID.
N extra VM controllersShown only when the realm defines extra VM controllers. Lists each controller's name and description.
N Libvirt hostsShown for a Libvirt realm with the View VM host machines and their hardware in any realm permission. Lists each host, whether it is connected, and its state, with links to the host panels.
N storage poolsShown for a Libvirt realm with the View the storage pools of any realm permission. Lists the realm's storage pools, with links to their panels.
N hardware profilesShown when the realm has hardware profiles, with the View VM host machines and their hardware in any realm permission. Lists the realm's hardware profiles and their cores, with links to their panels.

Refresh Realm's Metadata​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click Realms in the left panel.
  4. Click the Refresh button in the top right panel.

Refresh All Pools Associated with Realm(s)​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click Realms in the left panel.
  4. Select the realm(s) to refresh all pools.
  5. Click the Open full menu button in the top right panel.
  6. Select Refresh all pools.

Fix VMs and Refresh tiCrypt’s View of Realm(s)​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click Realms in the left panel.
  4. Select the realm(s) whose VMs you want to fix.
  5. Click the Open full menu button in the top right panel.
  6. Select Fix VMs.
  7. In the Fix VMs within <realm | N Libvirt realms>? prompt, click Fix VMs.
Result:

tiCrypt asks each realm for the VMs that are actually running and updates its records. The prompt explains the effect: "Performing this action will refresh tiCrypt's and Libvirt's view of the running VMs. Stopped VMs will be marked as such in tiCrypt. Running VMs that are unknown to the system will be stopped to reclaim resources."

warning

Fix VMs does not stop the VMs tiCrypt knows about. It stops only running VMs that are unknown to tiCrypt. Fix VMs and Fix drives work only on Libvirt realms; with any other realm selected, the message "This action is only supported for Libvirt realms" appears.

Fix Drives and Refresh tiCrypt’s View of the Drive States of Realm(s)​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click Realms in the left panel.
  4. Select the realm(s) whose drives you want to fix.
  5. Click the Open full menu button in the top right panel.
  6. Select Fix drives.
  7. In the Fix drives within <realm | N Libvirt realms>? prompt, click Fix drives.
Result:

tiCrypt corrects the attached or unattached state of each drive in the realm. The prompt explains the effect: "Performing this action will refresh tiCrypt's and Libvirt's view of the drive states (attached or unattached). The result will fix any incorrect states according to the state of known running VMs."

Export Realm Metadata in CSV Format​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click Realms in the left panel.
  4. Click the Export CSV button in the top right panel.
  5. Select the All items option.
  6. In the local window, click Save.

Export Realm Metadata in JSON Format​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Virtual Machines section.
  3. Click Realms in the left panel.
  4. Click the Export JSON button in the top right panel.
  5. Select the Export all items option.
  6. In the local window, click Save.