Skip to main content
Virtual Machines
InfrastructureSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the VM panel by itselfbooleanfalseOpen the panel when a terminal opens.
VM panel sideselect"right"Where the panel sits beside a terminal.
VM panel sizenumber360Width or height in pixels.
Show the edge buttonbooleantrueA small button on the terminal's edge opens the panel.

Host​

Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.

SettingTypeDefaultWhat it does
Enable Virtual MachinesbooleanfalseManage KVM virtual machines on this host with libvirt.
Use sudobooleantrueRun libvirt commands with sudo. Turn off for a root login.
Read onlybooleanfalseShow VMs but block every change from Termix.
Libvirt connectionstring"qemu:///system"The libvirt URI to use. Most hosts want qemu:///system.
Show the VM panel beside terminalsbooleantrueAdds a VM list to this host's terminal tabs.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
virtual-machines.useadmin, userSee VMs on hosts you can connect to, and change them on hosts you can edit.
virtual-machines.consoleadminOpen the graphical and serial console of a VM on hosts you can edit.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
virtual-machines.list-vms
List VMs
A hostRead only
virtual-machines.vm-state
VM state
One item on a hostRead only
virtual-machines.running-count
VMs running
A hostRead only
virtual-machines.crashed-count
Crashed VMs
A hostRead only
virtual-machines.pool-usage
Storage pool use
A hostRead only
virtual-machines.list-snapshots
VM snapshots
A hostRead only
virtual-machines.list-pools
List storage pools
A hostRead only
virtual-machines.list-networks
List virtual networks
A hostRead only
virtual-machines.start
Start VM
One item on a hostChanges
virtual-machines.reboot
Reboot VM
One item on a hostChanges
virtual-machines.suspend
Pause VM
One item on a hostChanges
virtual-machines.resume
Resume VM
One item on a hostChanges
virtual-machines.set-autostart
Set VM autostart
One item on a hostChangesenabled
virtual-machines.snapshot
Take VM snapshot
One item on a hostChangesname, description
virtual-machines.clone
Clone VM
One item on a hostChangesname
virtual-machines.shutdown
Shut down VM
One item on a hostDestructive
virtual-machines.force-stop
Force stop VM
One item on a hostDestructive
virtual-machines.delete-vm
Delete VM
One item on a hostDestructivedeleteDisks
virtual-machines.revert-snapshot
Revert to snapshot
One item on a hostDestructive
virtual-machines.delete-snapshot
Delete snapshot
One item on a hostDestructive

Events​

Automations can start when one of these happens.

EventWhat it means
virtual-machines.vm-startedVM started
virtual-machines.vm-stoppedVM stopped
virtual-machines.vm-crashedVM crashed
virtual-machines.job-finishedVM job finished

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
credentials:readCriticalSee your passwords and keys. It can read the stored secret for any host you can reach.
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Works with other plugins​

Works better with: remote-desktop ^1.4.0.

Services​

Services are how plugins call each other. Plugin authors can use these.

UsesVersionOptional
remote-desktop.console^1.0.0yes

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS