Skip to main content

UPSSettings

configuredbooleanrequired

Whether a UPS configuration row exists. False means the card shows the optional empty state; every other field is omitted.

connectionUPSConnection

Connection choice: a USB-attached UPS Hoserva drives locally, or a remote NUT server this host monitors.

Possible values: [usb, network]

driverstring

NUT driver name for a USB UPS (e.g. usbhid-ups).

portstring

Driver port for a USB UPS (commonly "auto").

monitorPasswordSetboolean

Whether a local monitor password is stored. The password itself is never returned.

networkHoststring

Remote NUT server hostname or address.

networkPortinteger<int32>

Remote NUT server port (default 3493 when omitted on write).

Possible values: >= 1 and <= 65535

networkUpsNamestring

UPS name on the remote NUT server.

networkUsernamestring

Monitoring username on the remote NUT server.

networkPasswordSetboolean

Whether a network monitoring password is stored. The password itself is never returned.

lowBatteryPercentinteger<int32>

USB-only. Charge percent that marks the battery low for a clean shutdown. Omitted or zero leaves NUT's driver default.

Possible values: >= 0 and <= 100

runtimeSecondsinteger<int32>

USB-only. Estimated runtime seconds remaining that mark the battery low. Omitted or zero leaves NUT's driver default.

Possible values: >= 0

UPSSettings
{
"configured": true,
"connection": "usb",
"driver": "string",
"port": "string",
"monitorPasswordSet": true,
"networkHost": "string",
"networkPort": 0,
"networkUpsName": "string",
"networkUsername": "string",
"networkPasswordSet": true,
"lowBatteryPercent": 0,
"runtimeSeconds": 0
}