Type | Meaning |
---|---|
RW | This is a read/write variable. It may be read with
command GET VAR, see |
ENUM | An enumerated type, which supports specific predetermined values. |
STRING:n | This is a string of maximum length n. |
RANGE | |
NUMBER | This is a single numeric value, either integer or float. |
Command | Response | Note | Reference |
---|---|---|---|
ATTACH | OK | Was LOGIN | |
DETACH | OK Goodbye | Was LOGOUT | |
FSD | OK FSD-SET | ||
GET | Sub command specific | ||
HELP | List of commands | ||
INSTCMD | OK | ||
LIST | Sub command specific | ||
PASSWORD | OK | ||
PRIMARY | OK | ||
PROTVER | Protocol version | Was NETVER | |
SET | OK | ||
STARTTLS | OK STARTTLS | ||
USERNAME | OK | ||
VER | Program version |
The error name token
<error-name> |
Meaning |
---|---|
ACCESS-DENIED | The client's host and/or authentication details supplied by USERNAME and PASSWORD are not sufficient to execute the requested command. |
ALREADY-ATTACHED | |
ALREADY-SET-PASSWORD | The client has already supplied a PASSWORD and is attempting to repeat the command in the same Session. |
ALREADY-SET-USERNAME | The client has already supplied a USERNAME, and is attempting to repeat the command within the same Session. |
CMD-NOT-SUPPORTED | The specified UPS doesn't support the Instant Command. |
DATA-STALE | |
DRIVER-NOT-CONNECTED | The Attachment Daemon can't perform the requested command, since the Driver for that UPS is not connected. This usually means that the driver is not running, or if it is, is misconfigured. |
FEATURE-NOT-CONFIGURED | This instance of the Attachment Daemon hasn't been configured properly to allow the requested feature to operate. In current practice this error response is possible only for command STARTTLS. |
FEATURE-NOT-SUPPORTED | This instance of Attachment Daemon does not support the requested feature. In current practice this error response is possible only for command STARTTLS. |
INSTCMD-FAILED | The Attachment Daemon failed to deliver the Instant Command request to the Driver. No further information is available to the client. This typically indicates a dead or broken driver. |
INVALID-ARGUMENT | The client sent an argument to a command which is not recognized or is otherwise not valid in this context. This is typically caused by sending a valid command such as GET with a subcommand which is not valid. |
INVALID-PASSWORD | The client sent a non valid PASSWORD. |
INVALID-USERNAME | The client sent an non valid USERNAME. |
INVALID-VALUE | The value specified in the request
is not valid. This usually applies to a SET of
an ENUM type which is using a value not in the list of
allowed values. See |
PASSWORD-REQUIRED | The command requires a previous PASSWORD for authentication, but the client hasn't provided one. |
READONLY | The requested variable in a SET command is not writable. |
SET-FAILED | The Attachment Daemon failed to deliver the SET request to the Driver. This is similar to INSTCMD-FAILED. |
TLS-ALREADY-ENABLED | |
TLS-NOT-ENABLED | |
TOO-LONG | The requested value in a SET command is too long. |
UNKNOWN-COMMAND | The Attachment Daemon doesn't recognize the command. |
UNKNOWN-UPS | The UPS specified in the request is not known to the Attachment Daemon. This usually means that it didn't match anything in the Attachment Daemon configuration. |
USERNAME-REQUIRED | The command requires a USERNAME for authentication, but the client hasn't provided one. |
VAR-NOT-SUPPORTED | The specified UPS doesn't support the UPS variable in the command. |
Status Symbol | Meaning |
---|---|
ALARM | The UPS reports that it requires intervention. |
BOOST | The UPS has determined that the voltage level of the public power supply is too low, and is boosting it to the required level. The UPS continues to supply the protected system from the public power supply. |
BYPASS | The UPS is feeding current directly from the public power supply to the protected system. The backup facilities are disconnected. This state allows maintenance personnel to change the batteries without interrupting the protected system. |
CAL | The UPS is calibrating itself, for example to determine at what charge the LB status is raised or lowered. |
CHRG | |
COMM | The Attachment Daemon has effective contact with the UPS. |
DISCHRG | |
FSD | This "Forced Shutdown" status signals that the final shutdown sequence has begun. |
LB | Low Battery. The battery level of the UPS is below a chosen limit. The UPS may be in status OL or OB. |
NOCOMM | The Attachment Daemon has no effective contact with the UPS. |
OB | On Battery. The UPS is taking energy from it's battery. The battery is discharging. A UPS must have status OB or OL, otherwise it is deemed dead. |
OFF | The UPS is in state "Off". It does not react to failure in the public power supply. The exact meaning depends on the model. |
OL | Online. The UPS is online, receiving energy from the public power supply. The battery is charging. A UPS must have status OB or OL, otherwise it is deemed dead. |
OVER | Overloaded. The UPS reports that the load on it is beyond it's normal operating maximum. |
RB | Replace battery. The UPS reports that it's battery/batteries should be replaced. |
TEST | Under test. The UPS is currently undergoing a test, which may have been called for manually or internally. |
TICK | Heartbeat. A software UPS in the Attachment Daemon provides a regular signal monitored by the Management Daemon as a way of verifying effective end-to-end management. TICK and TOCK are companions, they are considered experimental. |
TOCK | Heartbeat. See TICK |
TRIM | The UPS has determined that the voltage level of the public power supply is too high, and is reducing it to the required level. The UPS continues to supply the protected system from the public power supply. |
Old status | New status | Event | Old status | New status | Event | |
---|---|---|---|---|---|---|
none | ALARM | Alarm on | ALARM | none | Alarm off | |
none | BOOST | Boosting voltage | BOOST | none | Not boosting | |
none | BYPASS | Bypass on | BYPASS | none | Bypass off | |
none | CAL | Calibrating | CAL | none | Not calibrating | |
none | CHRG | Charging | CHRG | none | Not charging | |
none | COMM | UPS communicating (Event COMMOK) |
COMM | none | See note |
|
none | DISCHRG | Discharging | DISCHRG | none | Not discharging | |
none | FSD | System shutdown (Events FSD, SHUTDOWN) |
FSD | none | Shutdown abandoned. See note |
|
none | LB | Low battery. See note |
LB | none | Battery not low | |
none | NOCOMM | UPS dead? See note (Events COMMBAD, NOCOMM) |
NOCOMM | none | See note |
|
none | OFF | UPS turned off | OFF | none | UPS not turned off | |
OB | OL | Receiving power (Event ONLINE) |
OL | OB | Power lost (Event ONBATT) |
|
none | OVER | UPS overloaded | OVER | none | Overload gone | |
none | RB | Replace battery (Event REPLBATT) |
RB | none | Replacement canceled | |
none | TEST | Test starts | TEST | none | Test finished | |
none | TICK | Heartbeat event. See note |
TICK | none | No heartbeat. See note |
|
none | TOCK | Heartbeat event. See note |
TOCK | none | No heartbeat. See note |
|
none | TRIM | Trimming voltage | TRIM | none | Not trimming |
With the computer systems for power operations presumably kept isolated from the Internet, many utility personnel do not see any reason for adding security measures to these systems. However, as clearly seen from these Subclauses, this may not be true anymore as networking becomes more prevalent and additional information access requirements grow.
Namespace | Recording document | Reference |
---|---|---|
Commands and Responses | This document | Commands, see |
(Idem, historical record) | Project Developer Guide Ch 9 | |
Statuses | This document | |
(Idem, historical record) | Source code clients/status.h | |
Variables | Source code file docs/nut-names.txt |
Variable | Typical value | Default description |
---|---|---|
battery.charge | 100 | "Battery charge (percent of full)" |
battery.charge.low | 20 | "Remaining battery level when UPS switches to LB (percent)" |
battery.runtime | 1481 | "Battery runtime (seconds)" |
battery.type | PbAc | "Battery chemistry" |
device.mfr | Example Mfg | "" |
device.model | Economy 1600 | "" |
device.serial | 1234567890 | "" |
device.type | ups | "" |
driver.name | usbhid-ups | "Driver name" |
driver.parameter.lowbatt | 37 | "Driver parameter: <name>" |
driver.parameter.offdelay | 30 | "Driver parameter: <name>" |
driver.parameter.ondelay | 40 | "Driver parameter: <name>" |
driver.parameter.pollfreq | 30 | "Driver parameter: <name>" |
driver.parameter.pollinterval | 2 | "Driver parameter: <name>" |
driver.parameter.port | auto | "Driver parameter: <name>" |
driver.parameter.synchronous | no | "Driver parameter: <name>" |
driver.parameter.vendorid | 0999 | "Driver parameter: <name>" |
driver.version | 2.8.0 | "Driver version - NUT release" |
driver.version.data | HID 1.39 | "" |
driver.version.internal | 0.41 | "Internal driver version" |
input.transfer.high | 264 | "High voltage transfer point (V)" |
input.transfer.low | 184 | "Low voltage transfer point (V)" |
outlet.1.desc | PowerShare Outlet 1 | "Outlet description" |
outlet.1.id | 2 | "Outlet system identifier" |
outlet.1.status | on | "Outlet switch status" |
outlet.1.switchable | no | "Outlet switch ability" |
outlet.2.desc | PowerShare Outlet 2 | "Outlet description" |
outlet.2.id | 3 | "Outlet system identifier" |
outlet.2.status | on | "Outlet switch status" |
outlet.2.switchable | no | "Outlet switch ability" |
outlet.desc | Main Outlet | "Outlet description" |
outlet.id | 1 | "Outlet system identifier" |
outlet.power | 25 | "" |
outlet.switchable | no | "Outlet switch ability" |
output.frequency.nominal | 50 | "Nominal output frequency (Hz)" |
output.voltage | 230.0 | "Output voltage (V)" |
output.voltage.nominal | 230 | "Nominal output voltage (V)" |
ups.beeper.status | enabled | "UPS beeper status" |
ups.delay.shutdown | 20 | "Interval to wait after shutdown with delay command (seconds)" |
ups.delay.start | 30 | "Interval to wait before (re)starting the load (seconds)" |
ups.firmware | 02 | "UPS firmware" |
ups.load | 20 | "Load on UPS (percent of full)" |
ups.mfr | Example Mfg | "UPS manufacturer" |
ups.model | Economy 1600 | "UPS model" |
ups.power.nominal | 1600 | "UPS power rating (VA)" |
ups.productid | ffff | "Product ID for USB devices" |
ups.serial | 000000000 | "UPS serial number" |
ups.status | OL | "UPS status" |
ups.temperature | 27 | "UPS temperature (C)" |
ups.timer.shutdown | 0 | "Time before the load will be shutdown (seconds)" |
ups.timer.start | 0 | "Time before the load will be started (seconds)" |
ups.vendorid | 0999 | "Vendor ID for USB devices" |
Variable | Typical value | Default description provided as response to the command GET DESC |
---|---|---|
battery.charge.low | 20 | "Remaining battery level when UPS switches to LB (percent)" |
input.transfer.high | 264 | "High voltage transfer point (V)" |
input.transfer.low | 184 | "Low voltage transfer point (V)" |
outlet.1.desc | PowerShare Outlet 1 | "Outlet description" |
outlet.2.desc | PowerShare Outlet 2 | "Outlet description" |
outlet.2.switchable | no | "Outlet switch ability" |
outlet.desc | Main Outlet | "Outlet description" |
outlet.power | 25 | "Description unavailable" |
output.voltage.nominal | 230 | "Nominal output voltage (V)" |
ups.delay.shutdown | 20 | "Interval to wait after shutdown with delay command (seconds)" |
ups.delay.start | 30 | "Interval to wait before (re)starting the load (seconds)" |
Command | Meaning |
---|---|
beeper.disable | Disable the UPS beeper |
beeper.enable | Enable the UPS beeper |
beeper.mute | Temporarily mute the UPS beeper |
load.off | Turn off the load immediately |
load.off.delay | Turn off the load with a delay (seconds) |
load.on | Turn on the load immediately |
load.on.delay | Turn on the load with a delay (seconds) |
shutdown.return | Turn off the load and return when power is back |
shutdown.stayoff | Turn off the load and remain off |
shutdown.stop | Stop a shutdown in progress |
Term in previous release NUT 2.7.4 |
Term in this document, release NUT 2.8.0 |
Reference |
---|---|---|
ALREADY-LOGGED-IN | ALREADY-ATTACHED | |
ALREADY-SSL-MODE | TLS-ALREADY-ENABLED | |
LOGIN | ATTACH | |
LOGOUT | DETACH | |
Master | Primary | |
NETVER | PROTVER | |
NUMLOGINS | NUMATTACH | |
Slave | Secondary |
Declaration | Meaning |
---|---|
actions |
|
instcmds | Let a user initiate specific instant commands. See
|
password | Set the password for this user. Your password should be more secure than the examples shown. |
upsmon | Add the necessary actions for a Management Daemon to process a system shutdown. In current practice the value is still master or slave. Note that there is no U+003D EQUALS SIGN =. |