Skip to main content
Out-of-band
NetworkingSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Run ipmitool on the Termix serverbooleantrueWhen off, IPMI BMCs must use a relay host. Redfish and AMT are not affected.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
out-of-band.viewadmin, userOpen the Out-of-band tab and see power, health, sensors and logs.
out-of-band.poweradminTurn machines on and off, power cycle them and choose the next boot device.
out-of-band.consoleadminOpen the serial over LAN console of a machine.
out-of-band.mediaadminMount and eject ISO images on a machine.
out-of-band.manageadminAdd, change and remove BMCs, and clear their event logs.

Actions​

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

ActionRuns onRiskInputs
out-of-band.list-devices
List BMCs
The serverRead only
out-of-band.poll
Read a BMC now
The serverRead onlydevice
out-of-band.power-state
Get power state
The serverRead onlydevice
out-of-band.power-on
Power on
The serverChangesdevice
out-of-band.graceful-shutdown
Shut down
The serverChangesdevice
out-of-band.power-off
Power off
The serverDestructivedevice
out-of-band.power-cycle
Power cycle
The serverDestructivedevice
out-of-band.reset
Reset
The serverDestructivedevice
out-of-band.set-boot-once
Boot once from a device
The serverChangesdevice, boot, uefi
out-of-band.clear-log
Clear event log
The serverDestructivedevice

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
process:spawnHighRun programs on this machine. Programs run on the Termix server itself, not on your hosts.
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.
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
out-of-band.power1.0.0out-of-band.power

API​

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

Platforms​

Linux, Windows, macOS