Skip to main content
UPS Manager
MonitoringSourceAPIChangelog

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
UPS ManagerbooleanfalseRead UPS devices from this host and show a UPS tab.
UPS read onlybooleanfalseBlock changes and commands on this host's UPS devices.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
ups-manager.useadmin, userSee UPS status and, with edit access to a host, change devices and send commands.

Actions​

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

ActionRuns onRiskInputs
ups-manager.list
List UPS devices
A hostRead only
ups-manager.status
Power status
A hostRead only
ups-manager.charge
Battery charge
A hostRead only
ups-manager.runtime
Runtime left
A hostRead only
ups-manager.self-test
Start battery self test
A hostChangeskind, source
ups-manager.beeper
Set the UPS beeper
A hostChangesmode, source
ups-manager.calibrate
Calibrate runtime
A hostDestructivesource

Events​

Automations can start when one of these happens.

EventWhat it means
ups-manager.on-batteryUPS on battery
ups-manager.power-restoredUPS power restored

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
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.
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.
kv:ownLowRemember small settings. Kept separate from other plugins.
files:ownLowStore its own files. In its own folder on disk, separate from other plugins.
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
ups-manager.access1.0.0ups-manager.use

API​

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

Platforms​

Linux, Windows, macOS