Prev |  | Next

### A.5. Instant commands

Name | Description
--- | ---
load.off | Turn off the load immediately
load.on | Turn on the load immediately
load.off.delay | Turn off the load possibly after a delay
load.on.delay | Turn on the load possibly after a delay
shutdown.default | Run default driver-defined (device-specific) routine, primarily intended for emergency poweroff performed as part of FSD handling; often an alias to other `shutdown.*` and/or `load.off` operations or a chain to try several of those. See also `sdcommands` in common driver options.
shutdown.return | Turn off the load possibly after a delay and return when power is back
shutdown.stayoff | Turn off the load possibly after a delay and remain off even if power returns
shutdown.stop | Stop a shutdown in progress
shutdown.reboot | Shut down the load briefly while rebooting the UPS
shutdown.reboot.graceful | After a delay, shut down the load briefly while rebooting the UPS
test.panel.start | Start testing the UPS panel
test.panel.stop | Stop a UPS panel test
test.failure.start | Start a simulated power failure
test.failure.stop | Stop simulating a power failure
test.battery.start | Start a battery test
test.battery.start.quick | Start a "quick" battery test
test.battery.start.deep | Start a "deep" battery test
test.battery.stop | Stop the battery test
test.system.start | Start a system test
calibrate.start | Start runtime calibration
calibrate.stop | Stop runtime calibration
bypass.start | Put the UPS in Bypass mode
bypass.stop | Take the UPS out of Bypass mode
reset.input.minmax | Reset minimum and maximum input voltage status
reset.watchdog | Reset watchdog timer (forced reboot of load)
beeper.enable | Enable UPS beeper/buzzer
beeper.disable | Disable UPS beeper/buzzer
beeper.mute | Temporarily mute UPS beeper/buzzer
beeper.toggle | Toggle UPS beeper/buzzer
outlet.n.shutdown.return | Turn off the outlet possibly after a delay and return when power is back
outlet.n.load.off | Turn off the outlet immediately
outlet.n.load.on | Turn on the outlet immediately
outlet.n.load.cycle | Power cycle the outlet immediately
outlet.n.shutdown.return | Turn off the outlet and return when power is back

#### Experimental instant commands

The following commands were added to test feature support, but are not expected to last as part of NUT standard protocol in the long run.

Table A.1. Vendor-dependent "ECO" modes

Name | Driver/Devices | Description
--- | --- | ---
experimental.ecomode.start | usbhid-ups ⇒ mge-hid (Eaton/MGE) | Put UPS in High Efficiency (aka ECO) mode
experimental.ecomode.stop | usbhid-ups ⇒ mge-hid (Eaton/MGE) | Take the UPS out of High Efficiency (aka ECO) mode
experimental.bypass.ecomode.start | usbhid-ups ⇒ mge-hid (Eaton/MGE) | Put UPS in Bypass mode then High Efficiency (aka ECO) mode
experimental.bypass.ecomode.stop | usbhid-ups ⇒ mge-hid (Eaton/MGE) | Take the UPS out of High Efficiency (aka ECO) mode after exiting Bypass mode
experimental.essmode.start | usbhid-ups ⇒ mge-hid (Eaton/MGE) | Put UPS in Energy Saver System (aka ESS) mode
experimental.essmode.stop | usbhid-ups ⇒ mge-hid (Eaton/MGE) | Take the UPS out of Energy Saver System (aka ESS) mode

Table A.2. Vendor-dependent instant commands

Name | Driver/Devices | Description
--- | --- | ---
experimental.test.beeper.start | nutdrv_hashx ⇒ Atlantis Land | Start testing the UPS beeper
experimental.test.beeper.stop | nutdrv_hashx ⇒ Atlantis Land | Stop a UPS beeper test

Currently the commands above are present in one subdriver and are specific to the vendor’s proposed power state machine. The plan is to generalize the concept with vendor specifics, similarly to `experimental.ups.mode.buzzwords`.

Prev | Up | Next
| Home |