Reference
Settings
Admin
Set by an admin in Settings, under the plugin's name. It applies to everyone.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Longest screen session (minutes) | number | 240 | A screen session ends after this long. Use 0 for no limit. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
ip-kvm.view | admin, user | Open the KVM tab and see which KVMs are online and what power state they report. |
ip-kvm.power | admin | Turn machines on and off and reset them through their KVM, or wake them with Wake-on-LAN. |
ip-kvm.console | admin | See the screen of a machine and use its keyboard and mouse. |
ip-kvm.media | admin | Mount and eject ISO images on a machine. |
ip-kvm.manage | admin | Add, change and remove KVMs. |
Actions
Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
ip-kvm.list-devicesList KVMs | The server | Read only | |
ip-kvm.pollRead a KVM now | The server | Read only | device |
ip-kvm.power-stateGet power state | The server | Read only | device |
ip-kvm.power-onPower on | The server | Changes | device |
ip-kvm.graceful-shutdownShut down | The server | Destructive | device |
ip-kvm.power-offPower off | The server | Destructive | device |
ip-kvm.resetReset | The server | Destructive | device |
ip-kvm.wakeWake on LAN | The server | Changes | device |
ip-kvm.eject-mediaEject image | The server | Changes | device |
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 |
|---|---|---|
network:sockets | High | Open its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection. |
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. |
events:core | Medium | Watch everything happening. Including activity from other users, not just yours. |
network:outbound | Medium | Reach the internet. It can send requests to outside services. |
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. |
db:own | Low | Store its own data. Kept in its own tables, separate from other plugins. |
hosts:read | Low | See your host list. Names and addresses for hosts you can already see. |
secrets:own | Low | Store its own secrets. Encrypted by Termix. The plugin never holds the key. |
ui:surface | Low | Add its own screens. Tabs, panels and settings you can hide later. |
Services
Services are how plugins call each other. Plugin authors can use these.
| Provides | Version | Permission |
|---|---|---|
ip-kvm.power | 1.0.0 | ip-kvm.power |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS