Efficiency of the UPS (ratio
of the output current on the
input current) (percent)

95

ups.power

Current value of apparent
power (Volt-Amps)

500

ups.power.nominal

Nominal value of apparent
power (Volt-Amps)

500

ups.realpower

Current value of real
power (Watts)

300

ups.realpower.nominal

Nominal value of real
power (Watts)

300

ups.beeper.status

UPS beeper status
(enabled, disabled or muted)

enabled

ups.type

UPS type (* opaque)

offline

ups.watchdog.status

UPS watchdog status
(enabled or disabled)

disabled

ups.start.auto

UPS starts when mains is
(re)applied

yes

ups.start.battery

Allow to start UPS from
battery

yes

ups.start.reboot

UPS coldstarts from battery
(enabled or disabled)

yes

ups.shutdown

Enable or disable UPS
shutdown ability (poweroff)

enabled

Note

When present, the value of ups.start.auto has an impact on shutdown.*
commands. For the sake of coherence, shutdown commands will set ups.start.auto
to the right value before issuing the command. That is, shutdown.stayoff will first
set ups.start.auto to no, while shutdown.return will set it to yes.

input: Incoming line/power information

Name

Description

Example value

input.voltage

Input voltage (V)

121.5

input.voltage.maximum

Maximum incoming voltage seen (V)

130

input.voltage.minimum

Minimum incoming voltage seen (V)

100

input.voltage.status

Status relative to the
thresholds

critical-low

input.voltage.low.warning

Low warning threshold (V)

205

input.voltage.low.critical

Low critical threshold (V)

200

input.voltage.high.warning

High warning threshold (V)

230

input.voltage.high.critical

High critical threshold (V)

240

input.voltage.nominal

Nominal input voltage (V)

120

input.voltage.extended

Extended input voltage range

no

input.transfer.delay

Delay before transfer to mains
(seconds)

60

input.transfer.reason

Reason for last transfer
to battery (* opaque)

T

input.transfer.low

Low voltage transfer point (V)

91

input.transfer.high

High voltage transfer point (V)

132

input.transfer.low.min

smallest settable low
voltage transfer point (V)

85

input.transfer.low.max

greatest settable low
voltage transfer point (V)

95

input.transfer.high.min

smallest settable high
voltage transfer point (V)

131

input.transfer.high.max

greatest settable high
voltage transfer point (V)

136

input.sensitivity

Input power sensitivity

H (high)

input.quality

Input power quality (*
opaque)

FF

input.current

Input current (A)

4.25

input.current.nominal

Nominal input current (A)

5.0

input.current.status

Status relative to the
thresholds

critical-high

input.current.low.warning

Low warning threshold (A)

4

input.current.low.critical

Low critical threshold (A)

2

input.current.high.warning

High warning threshold (A)

10

input.current.high.critical

High critical threshold (A)

12

input.frequency

Input line frequency (Hz)

60.00

input.frequency.nominal

Nominal input line
frequency (Hz)

60

input.frequency.status

Frequency status

out-of-range

input.frequency.low

Input line frequency low (Hz)

47

input.frequency.high

Input line frequency high (Hz)

63

input.frequency.extended

Extended input frequency range

no

input.transfer.boost.low

Low voltage boosting
transfer point (V)

190

input.transfer.boost.high

High voltage boosting
transfer point (V)

210

input.transfer.trim.low

Low voltage trimming
transfer point (V)

230

input.transfer.trim.high

High voltage trimming
transfer point (V)

240

input.load

Load on (ePDU) input (percent
of full)

25

input.realpower

Current sum value of all (ePDU)
phases real power (W)

300

input.power

Current sum value of all (ePDU)
phases apparent power (VA)

500

input.source

The current input power source

1

input.source.preferred

The preferred power source

1

output: Outgoing power/inverter information

Name

Description

Example value

output.voltage

Output voltage (V)

120.9

output.voltage.nominal

Nominal output voltage (V)

120

output.frequency

Output frequency (Hz)

59.9

output.frequency.nominal

Nominal output frequency (Hz)

60

output.current

Output current (A)

4.25

output.current.nominal

Nominal output current (A)

5.0

Three-phase additions

The additions for three-phase measurements would produce a very long table
due to all the combinations that are possible, so these additions are
broken down to their base components.

Phase Count Determination

input.phases (3 for three-phase, absent or 1 for 1phase)
output.phases (as for input.phases)

DOMAINs

Any input or output is considered a valid DOMAIN.

input (should really be called input.mains, but keep this for compat)
input.bypass
input.servicebypass

output (should really be called output.load, but keep this for compat)
output.bypass
output.inverter
output.servicebypass

Specification (SPEC)

Voltage, current, frequency, etc are considered to be a specification of
the measurement.

With this notation, the old 1phase naming scheme becomes DOMAIN.SPEC
Example: input.current

CONTEXT

When in three-phase mode, we need some way to specify the target for most
measurements in more detail. We call this the CONTEXT.

With this notation, the naming scheme becomes DOMAIN.CONTEXT.SPEC when
in three-phase mode.
Example: input.L1.current

Valid CONTEXTs

L1-L2 \
L2-L3 \
L3-L1 for voltage measurements
L1-N /
L2-N /
L3-N /

L1 \
L2 for current and power measurements
L3 /
N - for current measurement

NOTE:
battery.charger.status replaces the historic flags CHRG and DISCHRG that were
exposed through ups.status. battery.charger.status can have one of the
following value:

charging: battery is charging,

discharging: battery is discharging,

floating: battery has completed its charge cycle, and waiting to go to resting
mode,

resting: the battery is fully charged, and not charging nor discharging.

ambient: Conditions from external probe equipment

Note

multiple sensors can be exposed using the indexed notation.
ambient.*, without index or using 0, relates to the embedded sensor.
For example: ambient.temperature represent the embedded sensor temperature.
Other sensors (external, communication card, …) can use indexes
from 1 to n. For example: ambient.1.temperature for the first external
sensor temperature.

Name

Description

Example value

ambient.n.present

Ambient sensor presence

yes

ambient.n.temperature

Ambient temperature
(degrees C)

25.40

ambient.n.temperature.alarm

Temperature alarm
(enabled/disabled)

enabled

ambient.n.temperature.status

Ambient temperature status
relative to the thresholds

warning-low

ambient.n.temperature.high

Temperature threshold high
(degrees C)

60

ambient.n.temperature.high.warning

Temperature threshold high
warning (degrees C)

40

ambient.n.temperature.high.critical

Temperature threshold high
critical (degrees C)

60

ambient.n.temperature.low

Temperature threshold low
(degrees C)

5

ambient.n.temperature.low.warning

Temperature threshold low
warning (degrees C)

10

ambient.n.temperature.low.critical

Temperature threshold low
critical (degrees C)

5

ambient.n.temperature.maximum

Maximum temperature seen
(degrees C)

37.6

ambient.n.temperature.minimum

Minimum temperature seen
(degrees C)

18.1

ambient.n.humidity

Ambient relative humidity
(percent)

038.8

ambient.n.humidity.alarm

Relative humidity alarm
(enabled/disabled)

enabled

ambient.n.humidity.status

Ambient humidity status
relative to the thresholds

warning-low

ambient.n.humidity.high

Relative humidity
threshold high (percent)

80

ambient.n.humidity.high.warning

Relative humidity threshold
high warning (percent)

70

ambient.n.humidity.high.critical

Relative humidity threshold
high critical (percent)

80

ambient.n.humidity.low

Relative humidity
threshold low (percent)

10

ambient.n.humidity.low.warning

Relative humidity threshold
low warning (percent)

20

ambient.n.humidity.low.critical

Relative humidity threshold
low critical (percent)

10

ambient.n.humidity.maximum

Maximum relative humidity
seen (percent)

60

ambient.n.humidity.minimum

Minimum relative humidity
seen (percent)

13

ambient.n.contacts.x.status

State of the dry contact
sensor x

open

outlet: Smart outlet management

Note

n stands for the outlet index. For more information, refer to the
NUT outlets management and PDU notes chapter of the user manual.
A special case is "outlet.0" which is equivalent to "outlet" (without
index), and represent the whole set of outlets of the device. The most
important data is "outlet.count", used to iterate over the whole set of
outlets.

Name

Description

Example value

outlet.count

Total number of outlets

12

outlet.n.id

Outlet system identifier
(opaque string)

1

outlet.n.desc

Outlet name / description
(opaque string)

Main outlet

outlet.n.groupid

Identifier of the group to
which the outlet belongs to

1

outlet.n.switch

Outlet switch control
(on/off)

on

outlet.n.status

Outlet switch status
(on/off)

on

outlet.n.alarm

Alarms for outlets and PDU,
published in ups.alarm

outlet 1 low
voltage warning

outlet.n.switchable

Outlet switch ability
(yes/no)

yes

outlet.n.autoswitch.charge.low

Remaining battery level to
power off this outlet
(percent)

80

outlet.n.battery.charge.low

Remaining battery level to
power off this outlet
(percent)

80

outlet.n.delay.shutdown

Interval to wait before
shutting down this outlet
(seconds)

180

outlet.n.delay.start

Interval to wait before
restarting this outlet
(seconds)

120

outlet.n.timer.shutdown

Time before the outlet load
will be shutdown (seconds)

20

outlet.n.timer.start

Time before the outlet load
will be started (seconds)

30

outlet.n.current

Current (A)

0.19

outlet.n.current.maximum

Maximum seen current (A)

0.56

outlet.n.current.status

Current status relative to
the thresholds

good

outlet.n.current.low.warning

Low warning threshold (A)

0.10

outlet.n.current.low.critical

Low critical threshold (A)

0.05

outlet.n.current.high.warning

High warning threshold (A)

0.30

outlet.n.current.high.critical

High critical threshold (A)

0.40

outlet.n.realpower

Current value of real
power (W)

28

outlet.n.voltage

Voltage (V)

247.0

outlet.n.voltage.status

Voltage status relative to
the thresholds

good

outlet.n.voltage.low.warning

Low warning threshold (V)

205

outlet.n.voltage.low.critical

Low critical threshold (V)

200

outlet.n.voltage.high.warning

High warning threshold (V)

230

outlet.n.voltage.high.critical

High critical threshold (V)

240

outlet.n.powerfactor

Power Factor (dimensionless,
value between 0 and 1)

0.85

outlet.n.crestfactor

Crest Factor (dimensionless,
equal to or greater than 1)

1.41

outlet.n.power

Apparent power (VA)

46

outlet.group: groups of smart outlets

This is a refinement of the outlet collection, providing grouped
management for a set of outlets. The same principles and data than the
outlet collection apply to outlet.group, especially for the indexing n
and "outlet.group.count".

Most of the data published for outlets also apply to outlet.group,
including: id, name (similar as outlet "desc"), status, current and
voltage (including status, alarm and thresholds).