Reference
Settings
User
Each person sets these for themselves in Settings.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Open the VM panel by itself | boolean | false | Open the panel when a terminal opens. |
| VM panel side | select | "right" | Where the panel sits beside a terminal. |
| VM panel size | number | 360 | Width or height in pixels. |
| Show the edge button | boolean | true | A 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.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Enable Virtual Machines | boolean | false | Manage KVM virtual machines on this host with libvirt. |
| Use sudo | boolean | true | Run libvirt commands with sudo. Turn off for a root login. |
| Read only | boolean | false | Show VMs but block every change from Termix. |
| Libvirt connection | string | "qemu:///system" | The libvirt URI to use. Most hosts want qemu:///system. |
| Show the VM panel beside terminals | boolean | true | Adds a VM list to this host's terminal tabs. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
virtual-machines.use | admin, user | See VMs on hosts you can connect to, and change them on hosts you can edit. |
virtual-machines.console | admin | Open 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.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
virtual-machines.list-vmsList VMs | A host | Read only | |
virtual-machines.vm-stateVM state | One item on a host | Read only | |
virtual-machines.running-countVMs running | A host | Read only | |
virtual-machines.crashed-countCrashed VMs | A host | Read only | |
virtual-machines.pool-usageStorage pool use | A host | Read only | |
virtual-machines.list-snapshotsVM snapshots | A host | Read only | |
virtual-machines.list-poolsList storage pools | A host | Read only | |
virtual-machines.list-networksList virtual networks | A host | Read only | |
virtual-machines.startStart VM | One item on a host | Changes | |
virtual-machines.rebootReboot VM | One item on a host | Changes | |
virtual-machines.suspendPause VM | One item on a host | Changes | |
virtual-machines.resumeResume VM | One item on a host | Changes | |
virtual-machines.set-autostartSet VM autostart | One item on a host | Changes | enabled |
virtual-machines.snapshotTake VM snapshot | One item on a host | Changes | name, description |
virtual-machines.cloneClone VM | One item on a host | Changes | name |
virtual-machines.shutdownShut down VM | One item on a host | Destructive | |
virtual-machines.force-stopForce stop VM | One item on a host | Destructive | |
virtual-machines.delete-vmDelete VM | One item on a host | Destructive | deleteDisks |
virtual-machines.revert-snapshotRevert to snapshot | One item on a host | Destructive | |
virtual-machines.delete-snapshotDelete snapshot | One item on a host | Destructive |
Events
Automations can start when one of these happens.
| Event | What it means |
|---|---|
virtual-machines.vm-started | VM started |
virtual-machines.vm-stopped | VM stopped |
virtual-machines.vm-crashed | VM crashed |
virtual-machines.job-finished | VM 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.
| Capability | Risk | What it means |
|---|---|---|
credentials:read | Critical | See your passwords and keys. It can read the stored secret for any host you can reach. |
ssh:connect | High | Run commands on your servers. Any command, on hosts you connect it to, with your access. |
users:impersonate | High | Act as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log. |
credentials:use | Medium | Connect to your servers. It cannot see your passwords or keys. |
network:serve | Medium | Accept connections. It opens a port on the Termix server. |
notify:send | Medium | Send alerts. To you or other users, and through the channels they set up. |
operations:provide | Medium | Offer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them. |
hosts:read | Low | See your host list. Names and addresses for hosts you can already see. |
db:own | Low | Store its own data. Kept in its own tables, separate from other plugins. |
ui:surface | Low | Add 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.
| Uses | Version | Optional |
|---|---|---|
remote-desktop.console | ^1.0.0 | yes |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS