Skip to main content
Proxmox
InfrastructureSourceAPIChangelog

Reference

Settings​

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
Alert on guest and node changesbooleanfalseSend an alert when a guest that was running stops, or a node goes offline.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
proxmox.guestsadmin, userStart, stop and reboot VMs and containers on Proxmox nodes you can edit.

Actions​

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

ActionRuns onRiskInputs
proxmox.list-guests
List Proxmox guests
A hostRead only
proxmox.start-guest
Start guest
One item on a hostChanges
proxmox.shutdown-guest
Shut down guest
One item on a hostDestructive
proxmox.reboot-guest
Reboot guest
One item on a hostDestructive
proxmox.stop-guest
Force stop guest
One item on a hostDestructive
proxmox.list-snapshots
List guest snapshots
A hostRead onlyvmid
proxmox.create-snapshot
Take snapshot
One item on a hostChangesname, description, vmstate
proxmox.rollback-snapshot
Roll back to snapshot
One item on a hostDestructive
proxmox.delete-snapshot
Delete snapshot
One item on a hostDestructive
proxmox.create-vm
Create VM
A hostChangesname, node, vmid, cores, memoryMiB, diskGiB, storage, bridge, start, iso
proxmox.create-ct
Create container
A hostChangeshostname, template, node, vmid, cores, memoryMiB, diskGiB, storage, bridge, start, unprivileged, sshKey
proxmox.clone-guest
Clone guest
One item on a hostChangesname, newid, full, target, storage

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.
hosts:writeMediumCreate and change hosts. It can add hosts and edit the ones you already have.
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.
kv:ownLowRemember small settings. Kept separate from other plugins.

API​

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

Platforms​

Linux, Windows, macOS