Skip to main content
IP-KVM
NetworkingSourceAPIChangelog

Reference

Settings​

Admin​

Set by an admin in Settings, under the plugin's name. It applies to everyone.

SettingTypeDefaultWhat it does
Longest screen session (minutes)number240A screen session ends after this long. Use 0 for no limit.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
ip-kvm.viewadmin, userOpen the KVM tab and see which KVMs are online and what power state they report.
ip-kvm.poweradminTurn machines on and off and reset them through their KVM, or wake them with Wake-on-LAN.
ip-kvm.consoleadminSee the screen of a machine and use its keyboard and mouse.
ip-kvm.mediaadminMount and eject ISO images on a machine.
ip-kvm.manageadminAdd, change and remove KVMs.

Actions​

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

ActionRuns onRiskInputs
ip-kvm.list-devices
List KVMs
The serverRead only
ip-kvm.poll
Read a KVM now
The serverRead onlydevice
ip-kvm.power-state
Get power state
The serverRead onlydevice
ip-kvm.power-on
Power on
The serverChangesdevice
ip-kvm.graceful-shutdown
Shut down
The serverDestructivedevice
ip-kvm.power-off
Power off
The serverDestructivedevice
ip-kvm.reset
Reset
The serverDestructivedevice
ip-kvm.wake
Wake on LAN
The serverChangesdevice
ip-kvm.eject-media
Eject image
The serverChangesdevice

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
network:socketsHighOpen its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection.
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.
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
network:outboundMediumReach the internet. It can send requests to outside services.
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.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Services​

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

ProvidesVersionPermission
ip-kvm.power1.0.0ip-kvm.power

API​

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

Platforms​

Linux, Windows, macOS