Reading this variable returns bit mask indicating which
UPSs in a parallel system are alive. Management
software should poll only these UPSs on their snmp
branches 11-18 as follows:
1 FirstUPS alive
2 SecondUPS alive
4 ThirdUPS alive
8 FourthUPS alive
16 FifthUPS alive
32 SixthUPS alive
64 SeventhUPS alive
128 EigthUPS alive
Since the management software should always monitor
the GenericUPS branch (10), this value has no meaning
for single upses (which provide values on that snmp
branch), and should be set to zero in that case.
Put the string, formatted as a IMV/CP4 packet, directly to internally RS485 bus.
This OID could be used for accede directly to the internally RS485 bus from a remote place.
Contain the reply of the IMV/CP4 request packet sent using the OID geRequestPacket.
Every time that a write command has be made at the OID ge RequestPacket, the value of this OID is erased.
The indication of the capacity remaining in the UPS
system's batteries. A value of batteryNormal
indicates that the remaining run-time is greater than
upsConfigLowBattTime. A value of batteryLow indicates
that the remaining battery run-time is less than or
equal to upsConfigLowBattTime. A value of
batteryDepleted indicates that the UPS will be unable
to sustain the present load when and if the utility
power is lost (including the possibility that the
utility power is currently absent and the UPS is
unable to sustain the output).(*)
If the unit is on battery power, the elapsed time
since the UPS last switched to battery power, or the
time since the network management subsystem was last
restarted, whichever is less. Zero shall be returned
if the unit is not on battery power.(*)
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.(*)
A count of the number of times the input entered an
out-of-tolerance condition as defined by the
manufacturer. This count is incremented by one each
time the input transitions from zero out-of-tolerance
lines to one or more input lines out-of-tolerance.(*)
The present source of output power. The enumeration
none(2) indicates that there is no source of output
power (and therefore no output power), for example,
the system has opened the output breaker.(*)
The percentage of the UPS power capacity presently
being used on this output line, i.e., the greater of
the percent load of true power capacity and the
percent load of VA.(*)
The present output power factor.
The returned value correspond to the cosf of the load.
A positive value indicate an inductive load;
a negative value indicate a capacitive load;
value 1 indicate a resistive load.
If the measure is not available due to a small load for
a consistent calculation, the NA value is then returned.(*)
In a parallel system ideally all the UPS are requested to
contribute to the load with the same amount of current,
i.e. with no current share. The current share occurs when an
UPS exchanges some current with another UPS, so that this
current component doesn't feed the load.
The share part of the UPS current represents an undesired UPS
loading, and therefore it should be minimized. If the share
current is too high, the UPS results overloaded and in some
conditions (i.e. very high load) the system could turn on
bypass reducing dramatically the global system reliability.
PMAD detects the amount of share currents in a parallel system,
generating an alarm if this value is above a parameter-based threshold.
Single UPS systems don't have this feature, NA will be provided.(*)
A list of alarm table entries. The table contains
zero, one, or many rows at any moment, depending upon
the number of alarm conditions in effect. The table
is initially empty at agent startup. The agent
creates a row in the table each time a condition is
detected and deletes that row when that condition no
longer pertains. The agent creates the first row with
upsAlarmId equal to 1, and increments the value of
upsAlarmId each time a new row is created, wrapping to
the first free value greater than or equal to 1 when
the maximum value of upsAlarmId would otherwise be
exceeded. Consequently, after multiple operations,
the table may become sparse, e.g., containing entries
for rows 95, 100, 101, and 203 and the entries should
not be assumed to be in chronological order because
upsAlarmId might have wrapped.
Alarms are named by an AutonomousType (OBJECT
IDENTIFIER), upsAlarmDescr, to allow a single table to
reflect well known alarms plus alarms defined by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device. No
two rows will have the same value of upsAlarmDescr,
since alarms define conditions. In order to meet this
requirement, care should be taken in the definition of
alarm conditions to insure that a system cannot enter
the same condition multiple times simultaneously.
The number of rows in the table at any given time is
reflected by the value of upsAlarmsPresent.(*)
A reference to an alarm description object. The
object referenced should not be accessible, but rather
be used to provide a unique description of the alarm
condition.(*)
The value of sysUpTime when the alarm condition was
detected. If the alarm condition was detected at the
time of agent startup and presumably existed before
agent startup, the value of upsAlarmTime shall equal
0.(*)
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.(*)
Specifies which alarm can be handled by the UPS.
The 'Mask' parameter is a Long Integer32. The meaning
of every bit is the same as for the 'upsAlarmGroupA'
command. A bit having value=1 indicates that the
corresponding alarm is handled by the UPS.
The test is named by an OBJECT IDENTIFIER which
allows a standard mechanism for the initiation of
tests, including the well known tests identified in
this document as well as those introduced by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device.
Setting this variable initiates the named test. Sets
to this variable require the presence of
upsTestSpinLock in the same SNMP message.
The set request will be rejected with an appropriate
error message if the requested test cannot be
performed, including attempts to start a test when
another test is already in progress. The status of
the current or last test is maintained in
upsTestResultsSummary. Tests in progress may be
aborted by setting the upsTestId variable to
upsTestAbortTestInProgress.
Read operations return the value of the name of the
test in progress if a test is in progress or the name
of the last test performed if no test is in progress,
unless no test has been run, in which case the well
known value upsTestNoTestsInitiated is returned.(*)
A spin lock on the test subsystem. The spinlock is
used as follows.
Before starting a test, a manager-station should make
sure that a test is not in progress as follows:
tryagain:
get (upsTestSpinLock)
while (upsTestResultsSummary == inProgress) {
/* loop while a test is running for another
manager */
short delay
get (upsTestSpinLock)
}
lockvalue = upsTestSpinLock
/* no test in progress, start the test */
set (upsTestSpinLock = lockvalue, upsTestId =
requestedtest)
if (errorindex == 1) { /* (upsTestSpinLock
failed) */
/* if problem is not access control, then
some other manager slipped in ahead of us
*/
goto tryagain
}
if (errorindex == 2) { /* (upsTestId) */
/* cannot perform the test */
give up
}
/* test started ok */
/* wait for test completion by polling
upsTestResultsSummary */
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
while (upsTestResultsSummary == inProgress) {
short delay
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
}
/* when test completes, retrieve any additional
test results */
/* if upsTestSpinLock == lockvalue + 1, then
these are our test */
/* results (as opposed to another manager's */
The initial value of upsTestSpinLock at agent
initialization shall
be 1.(*)
The results of the current or last UPS diagnostics
test performed. The values for donePass(1),
doneWarning(2), and doneError(3) indicate that the
test completed either successfully, with a warning, or
with an error, respectively. The value aborted(4) is
returned for tests which are aborted by setting the
value of upsTestId to upsTestAbortTestInProgress.
Tests which have not yet concluded are indicated by
inProgress(5). The value noTestsInitiated(6)
indicates that no previous test results are available,
such as is the case when no tests have been run since
the last reinitialization of the network management
subsystem and the system has no provision for non-
volatile storage of test results.(*)
The value of sysUpTime at the time the test in
progress was initiated, or, if no test is in progress,
the time the previous test was initiated. If the
value of upsTestResultsSummary is noTestsInitiated(6),
upsTestStartTime has the value 0.(*)
The amount of time, in TimeTicks, since the test in
progress was initiated, or, if no test is in progress,
the previous test took to complete. If the value of
upsTestResultsSummary is noTestsInitiated(6),
upsTestElapsedTime has the value 0.(*)
The system is placed on battery to a discharge level,
set by the manufacturer, sufficient to determine
battery replacement and battery run-time with a high
degree of confidence. WARNING: this test will leave
the battery in a low charge state and will require
time for recharging to a level sufficient to provide
normal battery duration for the protected load.(*)
This object determines the nature of the action to be
taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration
objects reaches zero.
Setting this object to output(1) indicates that
shutdown requests should cause only the output of the
UPS to turn off. Setting this object to system(2)
indicates that shutdown requests will cause the entire
UPS system to turn off.(*)
Setting this object will shutdown (i.e., turn off)
either the UPS output or the UPS system (as determined
by the value of upsShutdownType at the time of
shutdown) after the indicated number of seconds, or
less if the UPS batteries become depleted. Setting
this object to 0 will cause the shutdown to occur
immediately. Setting this object to -1 will abort the
countdown. If the system is already in the desired
state at the time the countdown reaches 0, then
nothing will happen. That is, there is no additional
action at that time if upsShutdownType = system and
the system is already off. Similarly, there is no
additional action at that time if upsShutdownType =
output and the output is already off. When read,
upsShutdownAfterDelay will return the number of
seconds remaining until shutdown, or -1 if no shutdown
countdown is in effect. On some systems, if the agent
is restarted while a shutdown countdown is in effect,
the countdown may be aborted. Sets to this object
override any upsShutdownAfterDelay already in effect.(*)
Setting this object will start the output after the
indicated number of seconds, including starting the
UPS, if necessary. Setting this object to 0 will
cause the startup to occur immediately. Setting this
object to -1 will abort the countdown. If the output
is already on at the time the countdown reaches 0,
then nothing will happen. Sets to this object
override the effect of any upsStartupAfterDelay
countdown or upsRebootWithDuration countdown in
progress. When read, upsStartupAfterDelay will return
the number of seconds until startup, or -1 if no
startup countdown is in effect. If the countdown
expires during a utility failure, the startup shall
not occur until the utility power is restored. On
some systems, if the agent is restarted while a
startup countdown is in effect, the countdown is
aborted.(*)
Setting this object will immediately shutdown (i.e.,
turn off) either the UPS output or the UPS system (as
determined by the value of upsShutdownType at the time
of shutdown) for a period equal to the indicated
number of seconds, after which time the output will be
started, including starting the UPS, if necessary. If
the number of seconds required to perform the request
is greater than the requested duration, then the
requested shutdown and startup cycle shall be
performed in the minimum time possible, but in no case
shall this require more than the requested duration
plus 60 seconds. When read, upsRebootWithDuration
shall return the number of seconds remaining in the
countdown, or -1 if no countdown is in progress. If
the startup should occur during a utility failure, the
startup shall not occur until the utility power is
restored.(*)
Setting this object to 'on' will cause the UPS system
to restart after a shutdown if the shutdown occurred
during a power loss as a result of either a
upsShutdownAfterDelay or an internal battery depleted
condition. Setting this object to 'off' will prevent
the UPS system from restarting after a shutdown until
an operator manually or remotely explicitly restarts
it. If the UPS is in a startup or reboot countdown,
then the UPS will not restart until that delay has
been satisfied.(*)
The present state of the receptacle. Setting this
object to 'on' will cause the receptacle to be turned
on. Setting this object to 'off' will turn the
receptacle off. If the receptacle is already in the
desired state nothing will happen. After an
autorestart (see upsAutoRestart) the receptacle will
be on.
The operation mode off the UPS. Off-line indicates a
mode in which the input power is transferred to the
output directly or via a step-up or step-down
transformer. On-line mode indicates a mode in which
the output power is regenerated through some convertor.
the operating mode of the UPS may be fixed, or may be
selectable (e.g. an on-line UPS with ecomode)
The present state of the rectifier. Setting this
object to 'on' will cause the rectifier to be turned
on. Setting this object to 'off' will turn the
rectifier off. If the rectifier is already in the
desired state nothing will happen.
The present state of the charge method. Setting this
object to 'Normal charge' will cause the battery to be
charged using the normal method. Setting this object to
'Boost charge' will charge the battery in boost mode.
If the charge method is already in the desired state
nothing will happen.
The present state of the inverter. Setting this
object to 'on' will cause the inverter to be turned
on. Setting this object to 'off' will turn the
inverter off. If the inverter is already in the
desired state nothing will happen.
The present state of the bypass. Setting this
object to 'on' will cause the bypass to be activated.
Setting this object to 'off' will deactivate the
bypass. If the UPS is already in the
desired state nothing will happen.
The present source of the load. Setting this
object to 'On bypass' will cause the load to be
supplied by the bypass.
Setting this object to 'On inverter' will cause the
load to be supplied by the inverter.
If the load is already supplied by the desired
source nothing will happen.
The magnitude of the nominal input voltage. On those
systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal input frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The magnitude of the nominal output voltage. On
those systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal output frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The value of upsEstimatedMinutesRemaining at which a
lowBattery condition is declared. For agents which
support only discrete (discontinuous) values, then the
agent shall round up to the next supported value. If
the requested value is larger than the largest
supported value, then the largest supported value
shall be selected.(*)
The requested state of the audible alarm. When in
the disabled state, the audible alarm should never
sound. The enabled state is self-describing. Setting
this object to muted(3) when the audible alarm is
sounding shall temporarily silence the alarm. It will
remain muted until it would normally stop sounding and
the value returned for read operations during this
period shall equal muted(3). At the end of this
period, the value shall revert to enabled(2). Writes
of the value muted(3) when the audible alarm is not
sounding shall be accepted but otherwise shall have no
effect.(*)
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventSetStartingTimeStamp
will be used as the start value of the table with the lowest index number.
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventLastTime will
be used as the last value of the table with the highest index number.
Returns SNMPNOSUCHNAME for UPSs that don't support this command.
A list of event table entries. The number of entries is always
10, and the value of upsEventTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..10)):
PDU-SET upsSetStartingTimeStamp
The status of the UPS at the moment that the event was generated.
The format is specified at the 'upsStatus' command.
If the UPS is not able to deliver status information, then
SNMPNOSUCHNAME is returned.
The number of parameters to retreive from the UPS.
When this object is set the ParameterTable will be filled with the
requested number of entries. The value upsParametersStartAddress
will be used as the start value of the table with the lowest index
number.
The number of parameters to write to the UPS.
When this object is set the ParameterTable will be send to the ups.
The value upsParametersStartAddress will be used for the first value
of the table with the lowest index number.
A list of parameter entries. The number of entries is always
16, and the value of upsParameterTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..16)):
Read sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParametersRead
PDU-GET upsParameterTableSize
PDU-GET upsParameterValue 1
PDU-GET upsParameterValue 2
..
PDU-GET upsParameterValue
The table is read up to requested number of events and the
management software afterwards decides which entries are
valid, as indicated by the upsParameterTableSize.
Write sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParameterValue 1
PDU-SET upsParameterValue 2
..
PDU-SET upsParameterValue
PDU-SET upsParametersWrite
The current timestamp (or real-time) of the UPS. For the format,
see 'Timestamp' specifications. The write-command has to comply with the
correct timestamp format expected by the UPS (counter value or real-time-clock
value). Missing to doing so will result in a SNMPgenERROR,
meaning 'command not supported'. It is possible to know which is the timestamp
format supported by the UPS, by issuing a read-command or by reading events,
which includes timestamps.
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The indication of the capacity remaining in the UPS
system's batteries. A value of batteryNormal
indicates that the remaining run-time is greater than
upsConfigLowBattTime. A value of batteryLow indicates
that the remaining battery run-time is less than or
equal to upsConfigLowBattTime. A value of
batteryDepleted indicates that the UPS will be unable
to sustain the present load when and if the utility
power is lost (including the possibility that the
utility power is currently absent and the UPS is
unable to sustain the output).(*)
If the unit is on battery power, the elapsed time
since the UPS last switched to battery power, or the
time since the network management subsystem was last
restarted, whichever is less. Zero shall be returned
if the unit is not on battery power.(*)
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.(*)
A count of the number of times the input entered an
out-of-tolerance condition as defined by the
manufacturer. This count is incremented by one each
time the input transitions from zero out-of-tolerance
lines to one or more input lines out-of-tolerance.(*)
The present source of output power. The enumeration
none(2) indicates that there is no source of output
power (and therefore no output power), for example,
the system has opened the output breaker.(*)
The percentage of the UPS power capacity presently
being used on this output line, i.e., the greater of
the percent load of true power capacity and the
percent load of VA.(*)
The present output power factor.
The returned value correspond to the cosf of the load.
A positive value indicate an inductive load;
a negative value indicate a capacitive load;
value 1 indicate a resistive load.
If the measure is not available due to a small load for
a consistent calculation, the NA value is then returned.(*)
In a parallel system ideally all the UPS are requested to
contribute to the load with the same amount of current,
i.e. with no current share. The current share occurs when an
UPS exchanges some current with another UPS, so that this
current component doesn't feed the load.
The share part of the UPS current represents an undesired UPS
loading, and therefore it should be minimized. If the share
current is too high, the UPS results overloaded and in some
conditions (i.e. very high load) the system could turn on
bypass reducing dramatically the global system reliability.
PMAD detects the amount of share currents in a parallel system,
generating an alarm if this value is above a parameter-based threshold.
Single UPS systems don't have this feature, NA will be provided.(*)
A list of alarm table entries. The table contains
zero, one, or many rows at any moment, depending upon
the number of alarm conditions in effect. The table
is initially empty at agent startup. The agent
creates a row in the table each time a condition is
detected and deletes that row when that condition no
longer pertains. The agent creates the first row with
upsAlarmId equal to 1, and increments the value of
upsAlarmId each time a new row is created, wrapping to
the first free value greater than or equal to 1 when
the maximum value of upsAlarmId would otherwise be
exceeded. Consequently, after multiple operations,
the table may become sparse, e.g., containing entries
for rows 95, 100, 101, and 203 and the entries should
not be assumed to be in chronological order because
upsAlarmId might have wrapped.
Alarms are named by an AutonomousType (OBJECT
IDENTIFIER), upsAlarmDescr, to allow a single table to
reflect well known alarms plus alarms defined by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device. No
two rows will have the same value of upsAlarmDescr,
since alarms define conditions. In order to meet this
requirement, care should be taken in the definition of
alarm conditions to insure that a system cannot enter
the same condition multiple times simultaneously.
The number of rows in the table at any given time is
reflected by the value of upsAlarmsPresent.(*)
A reference to an alarm description object. The
object referenced should not be accessible, but rather
be used to provide a unique description of the alarm
condition.(*)
The value of sysUpTime when the alarm condition was
detected. If the alarm condition was detected at the
time of agent startup and presumably existed before
agent startup, the value of upsAlarmTime shall equal
0.(*)
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.(*)
Specifies which alarm can be handled by the UPS.
The 'Mask' parameter is a Long Integer32. The meaning
of every bit is the same as for the 'upsAlarmGroupA'
command. A bit having value=1 indicates that the
corresponding alarm is handled by the UPS.
The test is named by an OBJECT IDENTIFIER which
allows a standard mechanism for the initiation of
tests, including the well known tests identified in
this document as well as those introduced by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device.
Setting this variable initiates the named test. Sets
to this variable require the presence of
upsTestSpinLock in the same SNMP message.
The set request will be rejected with an appropriate
error message if the requested test cannot be
performed, including attempts to start a test when
another test is already in progress. The status of
the current or last test is maintained in
upsTestResultsSummary. Tests in progress may be
aborted by setting the upsTestId variable to
upsTestAbortTestInProgress.
Read operations return the value of the name of the
test in progress if a test is in progress or the name
of the last test performed if no test is in progress,
unless no test has been run, in which case the well
known value upsTestNoTestsInitiated is returned.(*)
A spin lock on the test subsystem. The spinlock is
used as follows.
Before starting a test, a manager-station should make
sure that a test is not in progress as follows:
tryagain:
get (upsTestSpinLock)
while (upsTestResultsSummary == inProgress) {
/* loop while a test is running for another
manager */
short delay
get (upsTestSpinLock)
}
lockvalue = upsTestSpinLock
/* no test in progress, start the test */
set (upsTestSpinLock = lockvalue, upsTestId =
requestedtest)
if (errorindex == 1) { /* (upsTestSpinLock
failed) */
/* if problem is not access control, then
some other manager slipped in ahead of us
*/
goto tryagain
}
if (errorindex == 2) { /* (upsTestId) */
/* cannot perform the test */
give up
}
/* test started ok */
/* wait for test completion by polling
upsTestResultsSummary */
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
while (upsTestResultsSummary == inProgress) {
short delay
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
}
/* when test completes, retrieve any additional
test results */
/* if upsTestSpinLock == lockvalue + 1, then
these are our test */
/* results (as opposed to another manager's */
The initial value of upsTestSpinLock at agent
initialization shall
be 1.(*)
The results of the current or last UPS diagnostics
test performed. The values for donePass(1),
doneWarning(2), and doneError(3) indicate that the
test completed either successfully, with a warning, or
with an error, respectively. The value aborted(4) is
returned for tests which are aborted by setting the
value of upsTestId to upsTestAbortTestInProgress.
Tests which have not yet concluded are indicated by
inProgress(5). The value noTestsInitiated(6)
indicates that no previous test results are available,
such as is the case when no tests have been run since
the last reinitialization of the network management
subsystem and the system has no provision for non-
volatile storage of test results.(*)
The value of sysUpTime at the time the test in
progress was initiated, or, if no test is in progress,
the time the previous test was initiated. If the
value of upsTestResultsSummary is noTestsInitiated(6),
upsTestStartTime has the value 0.(*)
The amount of time, in TimeTicks, since the test in
progress was initiated, or, if no test is in progress,
the previous test took to complete. If the value of
upsTestResultsSummary is noTestsInitiated(6),
upsTestElapsedTime has the value 0.(*)
The system is placed on battery to a discharge level,
set by the manufacturer, sufficient to determine
battery replacement and battery run-time with a high
degree of confidence. WARNING: this test will leave
the battery in a low charge state and will require
time for recharging to a level sufficient to provide
normal battery duration for the protected load.(*)
This object determines the nature of the action to be
taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration
objects reaches zero.
Setting this object to output(1) indicates that
shutdown requests should cause only the output of the
UPS to turn off. Setting this object to system(2)
indicates that shutdown requests will cause the entire
UPS system to turn off.(*)
Setting this object will shutdown (i.e., turn off)
either the UPS output or the UPS system (as determined
by the value of upsShutdownType at the time of
shutdown) after the indicated number of seconds, or
less if the UPS batteries become depleted. Setting
this object to 0 will cause the shutdown to occur
immediately. Setting this object to -1 will abort the
countdown. If the system is already in the desired
state at the time the countdown reaches 0, then
nothing will happen. That is, there is no additional
action at that time if upsShutdownType = system and
the system is already off. Similarly, there is no
additional action at that time if upsShutdownType =
output and the output is already off. When read,
upsShutdownAfterDelay will return the number of
seconds remaining until shutdown, or -1 if no shutdown
countdown is in effect. On some systems, if the agent
is restarted while a shutdown countdown is in effect,
the countdown may be aborted. Sets to this object
override any upsShutdownAfterDelay already in effect.(*)
Setting this object will start the output after the
indicated number of seconds, including starting the
UPS, if necessary. Setting this object to 0 will
cause the startup to occur immediately. Setting this
object to -1 will abort the countdown. If the output
is already on at the time the countdown reaches 0,
then nothing will happen. Sets to this object
override the effect of any upsStartupAfterDelay
countdown or upsRebootWithDuration countdown in
progress. When read, upsStartupAfterDelay will return
the number of seconds until startup, or -1 if no
startup countdown is in effect. If the countdown
expires during a utility failure, the startup shall
not occur until the utility power is restored. On
some systems, if the agent is restarted while a
startup countdown is in effect, the countdown is
aborted.(*)
Setting this object will immediately shutdown (i.e.,
turn off) either the UPS output or the UPS system (as
determined by the value of upsShutdownType at the time
of shutdown) for a period equal to the indicated
number of seconds, after which time the output will be
started, including starting the UPS, if necessary. If
the number of seconds required to perform the request
is greater than the requested duration, then the
requested shutdown and startup cycle shall be
performed in the minimum time possible, but in no case
shall this require more than the requested duration
plus 60 seconds. When read, upsRebootWithDuration
shall return the number of seconds remaining in the
countdown, or -1 if no countdown is in progress. If
the startup should occur during a utility failure, the
startup shall not occur until the utility power is
restored.(*)
Setting this object to 'on' will cause the UPS system
to restart after a shutdown if the shutdown occurred
during a power loss as a result of either a
upsShutdownAfterDelay or an internal battery depleted
condition. Setting this object to 'off' will prevent
the UPS system from restarting after a shutdown until
an operator manually or remotely explicitly restarts
it. If the UPS is in a startup or reboot countdown,
then the UPS will not restart until that delay has
been satisfied.(*)
The present state of the receptacle. Setting this
object to 'on' will cause the receptacle to be turned
on. Setting this object to 'off' will turn the
receptacle off. If the receptacle is already in the
desired state nothing will happen. After an
autorestart (see upsAutoRestart) the receptacle will
be on.
The operation mode off the UPS. Off-line indicates a
mode in which the input power is transferred to the
output directly or via a step-up or step-down
transformer. On-line mode indicates a mode in which
the output power is regenerated through some convertor.
the operating mode of the UPS may be fixed, or may be
selectable (e.g. an on-line UPS with ecomode)
The present state of the rectifier. Setting this
object to 'on' will cause the rectifier to be turned
on. Setting this object to 'off' will turn the
rectifier off. If the rectifier is already in the
desired state nothing will happen.
The present state of the charge method. Setting this
object to 'Normal charge' will cause the battery to be
charged using the normal method. Setting this object to
'Boost charge' will charge the battery in boost mode.
If the charge method is already in the desired state
nothing will happen.
The present state of the inverter. Setting this
object to 'on' will cause the inverter to be turned
on. Setting this object to 'off' will turn the
inverter off. If the inverter is already in the
desired state nothing will happen.
The present state of the bypass. Setting this
object to 'on' will cause the bypass to be activated.
Setting this object to 'off' will deactivate the
bypass. If the UPS is already in the
desired state nothing will happen.
The present source of the load. Setting this
object to 'On bypass' will cause the load to be
supplied by the bypass.
Setting this object to 'On inverter' will cause the
load to be supplied by the inverter.
If the load is already supplied by the desired
source nothing will happen.
The magnitude of the nominal input voltage. On those
systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal input frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The magnitude of the nominal output voltage. On
those systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal output frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The value of upsEstimatedMinutesRemaining at which a
lowBattery condition is declared. For agents which
support only discrete (discontinuous) values, then the
agent shall round up to the next supported value. If
the requested value is larger than the largest
supported value, then the largest supported value
shall be selected.(*)
The requested state of the audible alarm. When in
the disabled state, the audible alarm should never
sound. The enabled state is self-describing. Setting
this object to muted(3) when the audible alarm is
sounding shall temporarily silence the alarm. It will
remain muted until it would normally stop sounding and
the value returned for read operations during this
period shall equal muted(3). At the end of this
period, the value shall revert to enabled(2). Writes
of the value muted(3) when the audible alarm is not
sounding shall be accepted but otherwise shall have no
effect.(*)
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventSetStartingTimeStamp
will be used as the start value of the table with the lowest index number.
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventLastTime will
be used as the last value of the table with the highest index number.
Returns SNMPNOSUCHNAME for UPSs that don't support this command.
A list of event table entries. The number of entries is always
10, and the value of upsEventTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..10)):
PDU-SET upsSetStartingTimeStamp
The status of the UPS at the moment that the event was generated.
The format is specified at the 'upsStatus' command.
If the UPS is not able to deliver status information, then
SNMPNOSUCHNAME is returned.
The number of parameters to retreive from the UPS.
When this object is set the ParameterTable will be filled with the
requested number of entries. The value upsParametersStartAddress
will be used as the start value of the table with the lowest index
number.
The number of parameters to write to the UPS.
When this object is set the ParameterTable will be send to the ups.
The value upsParametersStartAddress will be used for the first value
of the table with the lowest index number.
A list of parameter entries. The number of entries is always
16, and the value of upsParameterTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..16)):
Read sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParametersRead
PDU-GET upsParameterTableSize
PDU-GET upsParameterValue 1
PDU-GET upsParameterValue 2
..
PDU-GET upsParameterValue
The table is read up to requested number of events and the
management software afterwards decides which entries are
valid, as indicated by the upsParameterTableSize.
Write sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParameterValue 1
PDU-SET upsParameterValue 2
..
PDU-SET upsParameterValue
PDU-SET upsParametersWrite
The current timestamp (or real-time) of the UPS. For the format,
see 'Timestamp' specifications. The write-command has to comply with the
correct timestamp format expected by the UPS (counter value or real-time-clock
value). Missing to doing so will result in a SNMPfirstERROR,
meaning 'command not supported'. It is possible to know which is the timestamp
format supported by the UPS, by issuing a read-command or by reading events,
which includes timestamps.
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The indication of the capacity remaining in the UPS
system's batteries. A value of batteryNormal
indicates that the remaining run-time is greater than
upsConfigLowBattTime. A value of batteryLow indicates
that the remaining battery run-time is less than or
equal to upsConfigLowBattTime. A value of
batteryDepleted indicates that the UPS will be unable
to sustain the present load when and if the utility
power is lost (including the possibility that the
utility power is currently absent and the UPS is
unable to sustain the output).(*)
If the unit is on battery power, the elapsed time
since the UPS last switched to battery power, or the
time since the network management subsystem was last
restarted, whichever is less. Zero shall be returned
if the unit is not on battery power.(*)
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.(*)
A count of the number of times the input entered an
out-of-tolerance condition as defined by the
manufacturer. This count is incremented by one each
time the input transitions from zero out-of-tolerance
lines to one or more input lines out-of-tolerance.(*)
The present source of output power. The enumeration
none(2) indicates that there is no source of output
power (and therefore no output power), for example,
the system has opened the output breaker.(*)
The percentage of the UPS power capacity presently
being used on this output line, i.e., the greater of
the percent load of true power capacity and the
percent load of VA.(*)
The present output power factor.
The returned value correspond to the cosf of the load.
A positive value indicate an inductive load;
a negative value indicate a capacitive load;
value 1 indicate a resistive load.
If the measure is not available due to a small load for
a consistent calculation, the NA value is then returned.(*)
In a parallel system ideally all the UPS are requested to
contribute to the load with the same amount of current,
i.e. with no current share. The current share occurs when an
UPS exchanges some current with another UPS, so that this
current component doesn't feed the load.
The share part of the UPS current represents an undesired UPS
loading, and therefore it should be minimized. If the share
current is too high, the UPS results overloaded and in some
conditions (i.e. very high load) the system could turn on
bypass reducing dramatically the global system reliability.
PMAD detects the amount of share currents in a parallel system,
generating an alarm if this value is above a parameter-based threshold.
Single UPS systems don't have this feature, NA will be provided.(*)
A list of alarm table entries. The table contains
zero, one, or many rows at any moment, depending upon
the number of alarm conditions in effect. The table
is initially empty at agent startup. The agent
creates a row in the table each time a condition is
detected and deletes that row when that condition no
longer pertains. The agent creates the first row with
upsAlarmId equal to 1, and increments the value of
upsAlarmId each time a new row is created, wrapping to
the first free value greater than or equal to 1 when
the maximum value of upsAlarmId would otherwise be
exceeded. Consequently, after multiple operations,
the table may become sparse, e.g., containing entries
for rows 95, 100, 101, and 203 and the entries should
not be assumed to be in chronological order because
upsAlarmId might have wrapped.
Alarms are named by an AutonomousType (OBJECT
IDENTIFIER), upsAlarmDescr, to allow a single table to
reflect well known alarms plus alarms defined by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device. No
two rows will have the same value of upsAlarmDescr,
since alarms define conditions. In order to meet this
requirement, care should be taken in the definition of
alarm conditions to insure that a system cannot enter
the same condition multiple times simultaneously.
The number of rows in the table at any given time is
reflected by the value of upsAlarmsPresent.(*)
A reference to an alarm description object. The
object referenced should not be accessible, but rather
be used to provide a unique description of the alarm
condition.(*)
The value of sysUpTime when the alarm condition was
detected. If the alarm condition was detected at the
time of agent startup and presumably existed before
agent startup, the value of upsAlarmTime shall equal
0.(*)
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.(*)
Specifies which alarm can be handled by the UPS.
The 'Mask' parameter is a Long Integer32. The meaning
of every bit is the same as for the 'upsAlarmGroupA'
command. A bit having value=1 indicates that the
corresponding alarm is handled by the UPS.
The test is named by an OBJECT IDENTIFIER which
allows a standard mechanism for the initiation of
tests, including the well known tests identified in
this document as well as those introduced by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device.
Setting this variable initiates the named test. Sets
to this variable require the presence of
upsTestSpinLock in the same SNMP message.
The set request will be rejected with an appropriate
error message if the requested test cannot be
performed, including attempts to start a test when
another test is already in progress. The status of
the current or last test is maintained in
upsTestResultsSummary. Tests in progress may be
aborted by setting the upsTestId variable to
upsTestAbortTestInProgress.
Read operations return the value of the name of the
test in progress if a test is in progress or the name
of the last test performed if no test is in progress,
unless no test has been run, in which case the well
known value upsTestNoTestsInitiated is returned.(*)
A spin lock on the test subsystem. The spinlock is
used as follows.
Before starting a test, a manager-station should make
sure that a test is not in progress as follows:
tryagain:
get (upsTestSpinLock)
while (upsTestResultsSummary == inProgress) {
/* loop while a test is running for another
manager */
short delay
get (upsTestSpinLock)
}
lockvalue = upsTestSpinLock
/* no test in progress, start the test */
set (upsTestSpinLock = lockvalue, upsTestId =
requestedtest)
if (errorindex == 1) { /* (upsTestSpinLock
failed) */
/* if problem is not access control, then
some other manager slipped in ahead of us
*/
goto tryagain
}
if (errorindex == 2) { /* (upsTestId) */
/* cannot perform the test */
give up
}
/* test started ok */
/* wait for test completion by polling
upsTestResultsSummary */
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
while (upsTestResultsSummary == inProgress) {
short delay
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
}
/* when test completes, retrieve any additional
test results */
/* if upsTestSpinLock == lockvalue + 1, then
these are our test */
/* results (as opposed to another manager's */
The initial value of upsTestSpinLock at agent
initialization shall
be 1.(*)
The results of the current or last UPS diagnostics
test performed. The values for donePass(1),
doneWarning(2), and doneError(3) indicate that the
test completed either successfully, with a warning, or
with an error, respectively. The value aborted(4) is
returned for tests which are aborted by setting the
value of upsTestId to upsTestAbortTestInProgress.
Tests which have not yet concluded are indicated by
inProgress(5). The value noTestsInitiated(6)
indicates that no previous test results are available,
such as is the case when no tests have been run since
the last reinitialization of the network management
subsystem and the system has no provision for non-
volatile storage of test results.(*)
The value of sysUpTime at the time the test in
progress was initiated, or, if no test is in progress,
the time the previous test was initiated. If the
value of upsTestResultsSummary is noTestsInitiated(6),
upsTestStartTime has the value 0.(*)
The amount of time, in TimeTicks, since the test in
progress was initiated, or, if no test is in progress,
the previous test took to complete. If the value of
upsTestResultsSummary is noTestsInitiated(6),
upsTestElapsedTime has the value 0.(*)
The system is placed on battery to a discharge level,
set by the manufacturer, sufficient to determine
battery replacement and battery run-time with a high
degree of confidence. WARNING: this test will leave
the battery in a low charge state and will require
time for recharging to a level sufficient to provide
normal battery duration for the protected load.(*)
This object determines the nature of the action to be
taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration
objects reaches zero.
Setting this object to output(1) indicates that
shutdown requests should cause only the output of the
UPS to turn off. Setting this object to system(2)
indicates that shutdown requests will cause the entire
UPS system to turn off.(*)
Setting this object will shutdown (i.e., turn off)
either the UPS output or the UPS system (as determined
by the value of upsShutdownType at the time of
shutdown) after the indicated number of seconds, or
less if the UPS batteries become depleted. Setting
this object to 0 will cause the shutdown to occur
immediately. Setting this object to -1 will abort the
countdown. If the system is already in the desired
state at the time the countdown reaches 0, then
nothing will happen. That is, there is no additional
action at that time if upsShutdownType = system and
the system is already off. Similarly, there is no
additional action at that time if upsShutdownType =
output and the output is already off. When read,
upsShutdownAfterDelay will return the number of
seconds remaining until shutdown, or -1 if no shutdown
countdown is in effect. On some systems, if the agent
is restarted while a shutdown countdown is in effect,
the countdown may be aborted. Sets to this object
override any upsShutdownAfterDelay already in effect.(*)
Setting this object will start the output after the
indicated number of seconds, including starting the
UPS, if necessary. Setting this object to 0 will
cause the startup to occur immediately. Setting this
object to -1 will abort the countdown. If the output
is already on at the time the countdown reaches 0,
then nothing will happen. Sets to this object
override the effect of any upsStartupAfterDelay
countdown or upsRebootWithDuration countdown in
progress. When read, upsStartupAfterDelay will return
the number of seconds until startup, or -1 if no
startup countdown is in effect. If the countdown
expires during a utility failure, the startup shall
not occur until the utility power is restored. On
some systems, if the agent is restarted while a
startup countdown is in effect, the countdown is
aborted.(*)
Setting this object will immediately shutdown (i.e.,
turn off) either the UPS output or the UPS system (as
determined by the value of upsShutdownType at the time
of shutdown) for a period equal to the indicated
number of seconds, after which time the output will be
started, including starting the UPS, if necessary. If
the number of seconds required to perform the request
is greater than the requested duration, then the
requested shutdown and startup cycle shall be
performed in the minimum time possible, but in no case
shall this require more than the requested duration
plus 60 seconds. When read, upsRebootWithDuration
shall return the number of seconds remaining in the
countdown, or -1 if no countdown is in progress. If
the startup should occur during a utility failure, the
startup shall not occur until the utility power is
restored.(*)
Setting this object to 'on' will cause the UPS system
to restart after a shutdown if the shutdown occurred
during a power loss as a result of either a
upsShutdownAfterDelay or an internal battery depleted
condition. Setting this object to 'off' will prevent
the UPS system from restarting after a shutdown until
an operator manually or remotely explicitly restarts
it. If the UPS is in a startup or reboot countdown,
then the UPS will not restart until that delay has
been satisfied.(*)
The present state of the receptacle. Setting this
object to 'on' will cause the receptacle to be turned
on. Setting this object to 'off' will turn the
receptacle off. If the receptacle is already in the
desired state nothing will happen. After an
autorestart (see upsAutoRestart) the receptacle will
be on.
The operation mode off the UPS. Off-line indicates a
mode in which the input power is transferred to the
output directly or via a step-up or step-down
transformer. On-line mode indicates a mode in which
the output power is regenerated through some convertor.
the operating mode of the UPS may be fixed, or may be
selectable (e.g. an on-line UPS with ecomode)
The present state of the rectifier. Setting this
object to 'on' will cause the rectifier to be turned
on. Setting this object to 'off' will turn the
rectifier off. If the rectifier is already in the
desired state nothing will happen.
The present state of the charge method. Setting this
object to 'Normal charge' will cause the battery to be
charged using the normal method. Setting this object to
'Boost charge' will charge the battery in boost mode.
If the charge method is already in the desired state
nothing will happen.
The present state of the inverter. Setting this
object to 'on' will cause the inverter to be turned
on. Setting this object to 'off' will turn the
inverter off. If the inverter is already in the
desired state nothing will happen.
The present state of the bypass. Setting this
object to 'on' will cause the bypass to be activated.
Setting this object to 'off' will deactivate the
bypass. If the UPS is already in the
desired state nothing will happen.
The present source of the load. Setting this
object to 'On bypass' will cause the load to be
supplied by the bypass.
Setting this object to 'On inverter' will cause the
load to be supplied by the inverter.
If the load is already supplied by the desired
source nothing will happen.
The magnitude of the nominal input voltage. On those
systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal input frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The magnitude of the nominal output voltage. On
those systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal output frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The value of upsEstimatedMinutesRemaining at which a
lowBattery condition is declared. For agents which
support only discrete (discontinuous) values, then the
agent shall round up to the next supported value. If
the requested value is larger than the largest
supported value, then the largest supported value
shall be selected.(*)
The requested state of the audible alarm. When in
the disabled state, the audible alarm should never
sound. The enabled state is self-describing. Setting
this object to muted(3) when the audible alarm is
sounding shall temporarily silence the alarm. It will
remain muted until it would normally stop sounding and
the value returned for read operations during this
period shall equal muted(3). At the end of this
period, the value shall revert to enabled(2). Writes
of the value muted(3) when the audible alarm is not
sounding shall be accepted but otherwise shall have no
effect.(*)
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventSetStartingTimeStamp
will be used as the start value of the table with the lowest index number.
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventLastTime will
be used as the last value of the table with the highest index number.
Returns SNMPNOSUCHNAME for UPSs that don't support this command.
A list of event table entries. The number of entries is always
10, and the value of upsEventTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..10)):
PDU-SET upsSetStartingTimeStamp
The status of the UPS at the moment that the event was generated.
The format is specified at the 'upsStatus' command.
If the UPS is not able to deliver status information, then
SNMPNOSUCHNAME is returned.
The number of parameters to retreive from the UPS.
When this object is set the ParameterTable will be filled with the
requested number of entries. The value upsParametersStartAddress
will be used as the start value of the table with the lowest index
number.
The number of parameters to write to the UPS.
When this object is set the ParameterTable will be send to the ups.
The value upsParametersStartAddress will be used for the second value
of the table with the lowest index number.
A list of parameter entries. The number of entries is always
16, and the value of upsParameterTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..16)):
Read sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParametersRead
PDU-GET upsParameterTableSize
PDU-GET upsParameterValue 1
PDU-GET upsParameterValue 2
..
PDU-GET upsParameterValue
The table is read up to requested number of events and the
management software afterwards decides which entries are
valid, as indicated by the upsParameterTableSize.
Write sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParameterValue 1
PDU-SET upsParameterValue 2
..
PDU-SET upsParameterValue
PDU-SET upsParametersWrite
The current timestamp (or real-time) of the UPS. For the format,
see 'Timestamp' specifications. The write-command has to comply with the
correct timestamp format expected by the UPS (counter value or real-time-clock
value). Missing to doing so will result in a SNMPsecondERROR,
meaning 'command not supported'. It is possible to know which is the timestamp
format supported by the UPS, by issuing a read-command or by reading events,
which includes timestamps.
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The indication of the capacity remaining in the UPS
system's batteries. A value of batteryNormal
indicates that the remaining run-time is greater than
upsConfigLowBattTime. A value of batteryLow indicates
that the remaining battery run-time is less than or
equal to upsConfigLowBattTime. A value of
batteryDepleted indicates that the UPS will be unable
to sustain the present load when and if the utility
power is lost (including the possibility that the
utility power is currently absent and the UPS is
unable to sustain the output).(*)
If the unit is on battery power, the elapsed time
since the UPS last switched to battery power, or the
time since the network management subsystem was last
restarted, whichever is less. Zero shall be returned
if the unit is not on battery power.(*)
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.(*)
A count of the number of times the input entered an
out-of-tolerance condition as defined by the
manufacturer. This count is incremented by one each
time the input transitions from zero out-of-tolerance
lines to one or more input lines out-of-tolerance.(*)
The present source of output power. The enumeration
none(2) indicates that there is no source of output
power (and therefore no output power), for example,
the system has opened the output breaker.(*)
The percentage of the UPS power capacity presently
being used on this output line, i.e., the greater of
the percent load of true power capacity and the
percent load of VA.(*)
The present output power factor.
The returned value correspond to the cosf of the load.
A positive value indicate an inductive load;
a negative value indicate a capacitive load;
value 1 indicate a resistive load.
If the measure is not available due to a small load for
a consistent calculation, the NA value is then returned.(*)
In a parallel system ideally all the UPS are requested to
contribute to the load with the same amount of current,
i.e. with no current share. The current share occurs when an
UPS exchanges some current with another UPS, so that this
current component doesn't feed the load.
The share part of the UPS current represents an undesired UPS
loading, and therefore it should be minimized. If the share
current is too high, the UPS results overloaded and in some
conditions (i.e. very high load) the system could turn on
bypass reducing dramatically the global system reliability.
PMAD detects the amount of share currents in a parallel system,
generating an alarm if this value is above a parameter-based threshold.
Single UPS systems don't have this feature, NA will be provided.(*)
A list of alarm table entries. The table contains
zero, one, or many rows at any moment, depending upon
the number of alarm conditions in effect. The table
is initially empty at agent startup. The agent
creates a row in the table each time a condition is
detected and deletes that row when that condition no
longer pertains. The agent creates the first row with
upsAlarmId equal to 1, and increments the value of
upsAlarmId each time a new row is created, wrapping to
the first free value greater than or equal to 1 when
the maximum value of upsAlarmId would otherwise be
exceeded. Consequently, after multiple operations,
the table may become sparse, e.g., containing entries
for rows 95, 100, 101, and 203 and the entries should
not be assumed to be in chronological order because
upsAlarmId might have wrapped.
Alarms are named by an AutonomousType (OBJECT
IDENTIFIER), upsAlarmDescr, to allow a single table to
reflect well known alarms plus alarms defined by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device. No
two rows will have the same value of upsAlarmDescr,
since alarms define conditions. In order to meet this
requirement, care should be taken in the definition of
alarm conditions to insure that a system cannot enter
the same condition multiple times simultaneously.
The number of rows in the table at any given time is
reflected by the value of upsAlarmsPresent.(*)
A reference to an alarm description object. The
object referenced should not be accessible, but rather
be used to provide a unique description of the alarm
condition.(*)
The value of sysUpTime when the alarm condition was
detected. If the alarm condition was detected at the
time of agent startup and presumably existed before
agent startup, the value of upsAlarmTime shall equal
0.(*)
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.(*)
Specifies which alarm can be handled by the UPS.
The 'Mask' parameter is a Long Integer32. The meaning
of every bit is the same as for the 'upsAlarmGroupA'
command. A bit having value=1 indicates that the
corresponding alarm is handled by the UPS.
The test is named by an OBJECT IDENTIFIER which
allows a standard mechanism for the initiation of
tests, including the well known tests identified in
this document as well as those introduced by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device.
Setting this variable initiates the named test. Sets
to this variable require the presence of
upsTestSpinLock in the same SNMP message.
The set request will be rejected with an appropriate
error message if the requested test cannot be
performed, including attempts to start a test when
another test is already in progress. The status of
the current or last test is maintained in
upsTestResultsSummary. Tests in progress may be
aborted by setting the upsTestId variable to
upsTestAbortTestInProgress.
Read operations return the value of the name of the
test in progress if a test is in progress or the name
of the last test performed if no test is in progress,
unless no test has been run, in which case the well
known value upsTestNoTestsInitiated is returned.(*)
A spin lock on the test subsystem. The spinlock is
used as follows.
Before starting a test, a manager-station should make
sure that a test is not in progress as follows:
tryagain:
get (upsTestSpinLock)
while (upsTestResultsSummary == inProgress) {
/* loop while a test is running for another
manager */
short delay
get (upsTestSpinLock)
}
lockvalue = upsTestSpinLock
/* no test in progress, start the test */
set (upsTestSpinLock = lockvalue, upsTestId =
requestedtest)
if (errorindex == 1) { /* (upsTestSpinLock
failed) */
/* if problem is not access control, then
some other manager slipped in ahead of us
*/
goto tryagain
}
if (errorindex == 2) { /* (upsTestId) */
/* cannot perform the test */
give up
}
/* test started ok */
/* wait for test completion by polling
upsTestResultsSummary */
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
while (upsTestResultsSummary == inProgress) {
short delay
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
}
/* when test completes, retrieve any additional
test results */
/* if upsTestSpinLock == lockvalue + 1, then
these are our test */
/* results (as opposed to another manager's */
The initial value of upsTestSpinLock at agent
initialization shall
be 1.(*)
The results of the current or last UPS diagnostics
test performed. The values for donePass(1),
doneWarning(2), and doneError(3) indicate that the
test completed either successfully, with a warning, or
with an error, respectively. The value aborted(4) is
returned for tests which are aborted by setting the
value of upsTestId to upsTestAbortTestInProgress.
Tests which have not yet concluded are indicated by
inProgress(5). The value noTestsInitiated(6)
indicates that no previous test results are available,
such as is the case when no tests have been run since
the last reinitialization of the network management
subsystem and the system has no provision for non-
volatile storage of test results.(*)
The value of sysUpTime at the time the test in
progress was initiated, or, if no test is in progress,
the time the previous test was initiated. If the
value of upsTestResultsSummary is noTestsInitiated(6),
upsTestStartTime has the value 0.(*)
The amount of time, in TimeTicks, since the test in
progress was initiated, or, if no test is in progress,
the previous test took to complete. If the value of
upsTestResultsSummary is noTestsInitiated(6),
upsTestElapsedTime has the value 0.(*)
The system is placed on battery to a discharge level,
set by the manufacturer, sufficient to determine
battery replacement and battery run-time with a high
degree of confidence. WARNING: this test will leave
the battery in a low charge state and will require
time for recharging to a level sufficient to provide
normal battery duration for the protected load.(*)
This object determines the nature of the action to be
taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration
objects reaches zero.
Setting this object to output(1) indicates that
shutdown requests should cause only the output of the
UPS to turn off. Setting this object to system(2)
indicates that shutdown requests will cause the entire
UPS system to turn off.(*)
Setting this object will shutdown (i.e., turn off)
either the UPS output or the UPS system (as determined
by the value of upsShutdownType at the time of
shutdown) after the indicated number of Seconds, or
less if the UPS batteries become depleted. Setting
this object to 0 will cause the shutdown to occur
immediately. Setting this object to -1 will abort the
countdown. If the system is already in the desired
state at the time the countdown reaches 0, then
nothing will happen. That is, there is no additional
action at that time if upsShutdownType = system and
the system is already off. Similarly, there is no
additional action at that time if upsShutdownType =
output and the output is already off. When read,
upsShutdownAfterDelay will return the number of
seconds remaining until shutdown, or -1 if no shutdown
countdown is in effect. On some systems, if the agent
is restarted while a shutdown countdown is in effect,
the countdown may be aborted. Sets to this object
override any upsShutdownAfterDelay already in effect.(*)
Setting this object will start the output after the
indicated number of seconds, including starting the
UPS, if necessary. Setting this object to 0 will
cause the startup to occur immediately. Setting this
object to -1 will abort the countdown. If the output
is already on at the time the countdown reaches 0,
then nothing will happen. Sets to this object
override the effect of any upsStartupAfterDelay
countdown or upsRebootWithDuration countdown in
progress. When read, upsStartupAfterDelay will return
the number of seconds until startup, or -1 if no
startup countdown is in effect. If the countdown
expires during a utility failure, the startup shall
not occur until the utility power is restored. On
some systems, if the agent is restarted while a
startup countdown is in effect, the countdown is
aborted.(*)
Setting this object will immediately shutdown (i.e.,
turn off) either the UPS output or the UPS system (as
determined by the value of upsShutdownType at the time
of shutdown) for a period equal to the indicated
number of seconds, after which time the output will be
started, including starting the UPS, if necessary. If
the number of seconds required to perform the request
is greater than the requested duration, then the
requested shutdown and startup cycle shall be
performed in the minimum time possible, but in no case
shall this require more than the requested duration
plus 60 seconds. When read, upsRebootWithDuration
shall return the number of seconds remaining in the
countdown, or -1 if no countdown is in progress. If
the startup should occur during a utility failure, the
startup shall not occur until the utility power is
restored.(*)
Setting this object to 'on' will cause the UPS system
to restart after a shutdown if the shutdown occurred
during a power loss as a result of either a
upsShutdownAfterDelay or an internal battery depleted
condition. Setting this object to 'off' will prevent
the UPS system from restarting after a shutdown until
an operator manually or remotely explicitly restarts
it. If the UPS is in a startup or reboot countdown,
then the UPS will not restart until that delay has
been satisfied.(*)
The present state of the receptacle. Setting this
object to 'on' will cause the receptacle to be turned
on. Setting this object to 'off' will turn the
receptacle off. If the receptacle is already in the
desired state nothing will happen. After an
autorestart (see upsAutoRestart) the receptacle will
be on.
The operation mode off the UPS. Off-line indicates a
mode in which the input power is transferred to the
output directly or via a step-up or step-down
transformer. On-line mode indicates a mode in which
the output power is regenerated through some convertor.
the operating mode of the UPS may be fixed, or may be
selectable (e.g. an on-line UPS with ecomode)
The present state of the rectifier. Setting this
object to 'on' will cause the rectifier to be turned
on. Setting this object to 'off' will turn the
rectifier off. If the rectifier is already in the
desired state nothing will happen.
The present state of the charge method. Setting this
object to 'Normal charge' will cause the battery to be
charged using the normal method. Setting this object to
'Boost charge' will charge the battery in boost mode.
If the charge method is already in the desired state
nothing will happen.
The present state of the inverter. Setting this
object to 'on' will cause the inverter to be turned
on. Setting this object to 'off' will turn the
inverter off. If the inverter is already in the
desired state nothing will happen.
The present state of the bypass. Setting this
object to 'on' will cause the bypass to be activated.
Setting this object to 'off' will deactivate the
bypass. If the UPS is already in the
desired state nothing will happen.
The present source of the load. Setting this
object to 'On bypass' will cause the load to be
supplied by the bypass.
Setting this object to 'On inverter' will cause the
load to be supplied by the inverter.
If the load is already supplied by the desired
source nothing will happen.
The magnitude of the nominal input voltage. On those
systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal input frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The magnitude of the nominal output voltage. On
those systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal output frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The value of upsEstimatedMinutesRemaining at which a
lowBattery condition is declared. For agents which
support only discrete (discontinuous) values, then the
agent shall round up to the next supported value. If
the requested value is larger than the largest
supported value, then the largest supported value
shall be selected.(*)
The requested state of the audible alarm. When in
the disabled state, the audible alarm should never
sound. The enabled state is self-describing. Setting
this object to muted(3) when the audible alarm is
sounding shall temporarily silence the alarm. It will
remain muted until it would normally stop sounding and
the value returned for read operations during this
period shall equal muted(3). At the end of this
period, the value shall revert to enabled(2). Writes
of the value muted(3) when the audible alarm is not
sounding shall be accepted but otherwise shall have no
effect.(*)
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventSetStartingTimeStamp
will be used as the start value of the table with the lowest index number.
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventLastTime will
be used as the last value of the table with the highest index number.
Returns SNMPNOSUCHNAME for UPSs that don't support this command.
A list of event table entries. The number of entries is always
10, and the value of upsEventTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..10)):
PDU-SET upsSetStartingTimeStamp
The status of the UPS at the moment that the event was generated.
The format is specified at the 'upsStatus' command.
If the UPS is not able to deliver status information, then
SNMPNOSUCHNAME is returned.
The number of parameters to retreive from the UPS.
When this object is set the ParameterTable will be filled with the
requested number of entries. The value upsParametersStartAddress
will be used as the start value of the table with the lowest index
number.
The number of parameters to write to the UPS.
When this object is set the ParameterTable will be send to the ups.
The value upsParametersStartAddress will be used for the third value
of the table with the lowest index number.
A list of parameter entries. The number of entries is always
16, and the value of upsParameterTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..16)):
Read sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParametersRead
PDU-GET upsParameterTableSize
PDU-GET upsParameterValue 1
PDU-GET upsParameterValue 2
..
PDU-GET upsParameterValue
The table is read up to requested number of events and the
management software afterwards decides which entries are
valid, as indicated by the upsParameterTableSize.
Write sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParameterValue 1
PDU-SET upsParameterValue 2
..
PDU-SET upsParameterValue
PDU-SET upsParametersWrite
The current timestamp (or real-time) of the UPS. For the format,
see 'Timestamp' specifications. The write-command has to comply with the
correct timestamp format expected by the UPS (counter value or real-time-clock
value). Missing to doing so will result in a SNMP second ERROR,
meaning 'command not supported'. It is possible to know which is the timestamp
format supported by the UPS, by issuing a read-command or by reading events,
which includes timestamps.
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The indication of the capacity remaining in the UPS
system's batteries. A value of batteryNormal
indicates that the remaining run-time is greater than
upsConfigLowBattTime. A value of batteryLow indicates
that the remaining battery run-time is less than or
equal to upsConfigLowBattTime. A value of
batteryDepleted indicates that the UPS will be unable
to sustain the present load when and if the utility
power is lost (including the possibility that the
utility power is currently absent and the UPS is
unable to sustain the output).(*)
If the unit is on battery power, the elapsed time
since the UPS last switched to battery power, or the
time since the network management subsystem was last
restarted, whichever is less. Zero shall be returned
if the unit is not on battery power.(*)
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.(*)
A count of the number of times the input entered an
out-of-tolerance condition as defined by the
manufacturer. This count is incremented by one each
time the input transitions from zero out-of-tolerance
lines to one or more input lines out-of-tolerance.(*)
The present source of output power. The enumeration
none(2) indicates that there is no source of output
power (and therefore no output power), for example,
the system has opened the output breaker.(*)
The percentage of the UPS power capacity presently
being used on this output line, i.e., the greater of
the percent load of true power capacity and the
percent load of VA.(*)
The present output power factor.
The returned value correspond to the cosf of the load.
A positive value indicate an inductive load;
a negative value indicate a capacitive load;
value 1 indicate a resistive load.
If the measure is not available due to a small load for
a consistent calculation, the NA value is then returned.(*)
In a parallel system ideally all the UPS are requested to
contribute to the load with the same amount of current,
i.e. with no current share. The current share occurs when an
UPS exchanges some current with another UPS, so that this
current component doesn't feed the load.
The share part of the UPS current represents an undesired UPS
loading, and therefore it should be minimized. If the share
current is too high, the UPS results overloaded and in some
conditions (i.e. very high load) the system could turn on
bypass reducing dramatically the global system reliability.
PMAD detects the amount of share currents in a parallel system,
generating an alarm if this value is above a parameter-based threshold.
Single UPS systems don't have this feature, NA will be provided.(*)
A list of alarm table entries. The table contains
zero, one, or many rows at any moment, depending upon
the number of alarm conditions in effect. The table
is initially empty at agent startup. The agent
creates a row in the table each time a condition is
detected and deletes that row when that condition no
longer pertains. The agent creates the first row with
upsAlarmId equal to 1, and increments the value of
upsAlarmId each time a new row is created, wrapping to
the first free value greater than or equal to 1 when
the maximum value of upsAlarmId would otherwise be
exceeded. Consequently, after multiple operations,
the table may become sparse, e.g., containing entries
for rows 95, 100, 101, and 203 and the entries should
not be assumed to be in chronological order because
upsAlarmId might have wrapped.
Alarms are named by an AutonomousType (OBJECT
IDENTIFIER), upsAlarmDescr, to allow a single table to
reflect well known alarms plus alarms defined by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device. No
two rows will have the same value of upsAlarmDescr,
since alarms define conditions. In order to meet this
requirement, care should be taken in the definition of
alarm conditions to insure that a system cannot enter
the same condition multiple times simultaneously.
The number of rows in the table at any given time is
reflected by the value of upsAlarmsPresent.(*)
A reference to an alarm description object. The
object referenced should not be accessible, but rather
be used to provide a unique description of the alarm
condition.(*)
The value of sysUpTime when the alarm condition was
detected. If the alarm condition was detected at the
time of agent startup and presumably existed before
agent startup, the value of upsAlarmTime shall equal
0.(*)
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.(*)
Specifies which alarm can be handled by the UPS.
The 'Mask' parameter is a Long Integer32. The meaning
of every bit is the same as for the 'upsAlarmGroupA'
command. A bit having value=1 indicates that the
corresponding alarm is handled by the UPS.
The test is named by an OBJECT IDENTIFIER which
allows a standard mechanism for the initiation of
tests, including the well known tests identified in
this document as well as those introduced by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device.
Setting this variable initiates the named test. Sets
to this variable require the presence of
upsTestSpinLock in the same SNMP message.
The set request will be rejected with an appropriate
error message if the requested test cannot be
performed, including attempts to start a test when
another test is already in progress. The status of
the current or last test is maintained in
upsTestResultsSummary. Tests in progress may be
aborted by setting the upsTestId variable to
upsTestAbortTestInProgress.
Read operations return the value of the name of the
test in progress if a test is in progress or the name
of the last test performed if no test is in progress,
unless no test has been run, in which case the well
known value upsTestNoTestsInitiated is returned.(*)
A spin lock on the test subsystem. The spinlock is
used as follows.
Before starting a test, a manager-station should make
sure that a test is not in progress as follows:
tryagain:
get (upsTestSpinLock)
while (upsTestResultsSummary == inProgress) {
/* loop while a test is running for another
manager */
short delay
get (upsTestSpinLock)
}
lockvalue = upsTestSpinLock
/* no test in progress, start the test */
set (upsTestSpinLock = lockvalue, upsTestId =
requestedtest)
if (errorindex == 1) { /* (upsTestSpinLock
failed) */
/* if problem is not access control, then
some other manager slipped in ahead of us
*/
goto tryagain
}
if (errorindex == 2) { /* (upsTestId) */
/* cannot perform the test */
give up
}
/* test started ok */
/* wait for test completion by polling
upsTestResultsSummary */
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
while (upsTestResultsSummary == inProgress) {
short delay
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
}
/* when test completes, retrieve any additional
test results */
/* if upsTestSpinLock == lockvalue + 1, then
these are our test */
/* results (as opposed to another manager's */
The initial value of upsTestSpinLock at agent
initialization shall
be 1.(*)
The results of the current or last UPS diagnostics
test performed. The values for donePass(1),
doneWarning(2), and doneError(3) indicate that the
test completed either successfully, with a warning, or
with an error, respectively. The value aborted(4) is
returned for tests which are aborted by setting the
value of upsTestId to upsTestAbortTestInProgress.
Tests which have not yet concluded are indicated by
inProgress(5). The value noTestsInitiated(6)
indicates that no previous test results are available,
such as is the case when no tests have been run since
the last reinitialization of the network management
subsystem and the system has no provision for non-
volatile storage of test results.(*)
The value of sysUpTime at the time the test in
progress was initiated, or, if no test is in progress,
the time the previous test was initiated. If the
value of upsTestResultsSummary is noTestsInitiated(6),
upsTestStartTime has the value 0.(*)
The amount of time, in TimeTicks, since the test in
progress was initiated, or, if no test is in progress,
the previous test took to complete. If the value of
upsTestResultsSummary is noTestsInitiated(6),
upsTestElapsedTime has the value 0.(*)
The system is placed on battery to a discharge level,
set by the manufacturer, sufficient to determine
battery replacement and battery run-time with a high
degree of confidence. WARNING: this test will leave
the battery in a low charge state and will require
time for recharging to a level sufficient to provide
normal battery duration for the protected load.(*)
This object determines the nature of the action to be
taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration
objects reaches zero.
Setting this object to output(1) indicates that
shutdown requests should cause only the output of the
UPS to turn off. Setting this object to system(2)
indicates that shutdown requests will cause the entire
UPS system to turn off.(*)
Setting this object will shutdown (i.e., turn off)
either the UPS output or the UPS system (as determined
by the value of upsShutdownType at the time of
shutdown) after the indicated number of fourths, or
less if the UPS batteries become depleted. Setting
this object to 0 will cause the shutdown to occur
immediately. Setting this object to -1 will abort the
countdown. If the system is already in the desired
state at the time the countdown reaches 0, then
nothing will happen. That is, there is no additional
action at that time if upsShutdownType = system and
the system is already off. Similarly, there is no
additional action at that time if upsShutdownType =
output and the output is already off. When read,
upsShutdownAfterDelay will return the number of
fourths remaining until shutdown, or -1 if no shutdown
countdown is in effect. On some systems, if the agent
is restarted while a shutdown countdown is in effect,
the countdown may be aborted. Sets to this object
override any upsShutdownAfterDelay already in effect.(*)
Setting this object will start the output after the
indicated number of fourths, including starting the
UPS, if necessary. Setting this object to 0 will
cause the startup to occur immediately. Setting this
object to -1 will abort the countdown. If the output
is already on at the time the countdown reaches 0,
then nothing will happen. Sets to this object
override the effect of any upsStartupAfterDelay
countdown or upsRebootWithDuration countdown in
progress. When read, upsStartupAfterDelay will return
the number of fourths until startup, or -1 if no
startup countdown is in effect. If the countdown
expires during a utility failure, the startup shall
not occur until the utility power is restored. On
some systems, if the agent is restarted while a
startup countdown is in effect, the countdown is
aborted.(*)
Setting this object will immediately shutdown (i.e.,
turn off) either the UPS output or the UPS system (as
determined by the value of upsShutdownType at the time
of shutdown) for a period equal to the indicated
number of fourths, after which time the output will be
started, including starting the UPS, if necessary. If
the number of fourths required to perform the request
is greater than the requested duration, then the
requested shutdown and startup cycle shall be
performed in the minimum time possible, but in no case
shall this require more than the requested duration
plus 60 fourths. When read, upsRebootWithDuration
shall return the number of fourths remaining in the
countdown, or -1 if no countdown is in progress. If
the startup should occur during a utility failure, the
startup shall not occur until the utility power is
restored.(*)
Setting this object to 'on' will cause the UPS system
to restart after a shutdown if the shutdown occurred
during a power loss as a result of either a
upsShutdownAfterDelay or an internal battery depleted
condition. Setting this object to 'off' will prevent
the UPS system from restarting after a shutdown until
an operator manually or remotely explicitly restarts
it. If the UPS is in a startup or reboot countdown,
then the UPS will not restart until that delay has
been satisfied.(*)
The present state of the receptacle. Setting this
object to 'on' will cause the receptacle to be turned
on. Setting this object to 'off' will turn the
receptacle off. If the receptacle is already in the
desired state nothing will happen. After an
autorestart (see upsAutoRestart) the receptacle will
be on.
The operation mode off the UPS. Off-line indicates a
mode in which the input power is transferred to the
output directly or via a step-up or step-down
transformer. On-line mode indicates a mode in which
the output power is regenerated through some convertor.
the operating mode of the UPS may be fixed, or may be
selectable (e.g. an on-line UPS with ecomode)
The present state of the rectifier. Setting this
object to 'on' will cause the rectifier to be turned
on. Setting this object to 'off' will turn the
rectifier off. If the rectifier is already in the
desired state nothing will happen.
The present state of the charge method. Setting this
object to 'Normal charge' will cause the battery to be
charged using the normal method. Setting this object to
'Boost charge' will charge the battery in boost mode.
If the charge method is already in the desired state
nothing will happen.
The present state of the inverter. Setting this
object to 'on' will cause the inverter to be turned
on. Setting this object to 'off' will turn the
inverter off. If the inverter is already in the
desired state nothing will happen.
The present state of the bypass. Setting this
object to 'on' will cause the bypass to be activated.
Setting this object to 'off' will deactivate the
bypass. If the UPS is already in the
desired state nothing will happen.
The present source of the load. Setting this
object to 'On bypass' will cause the load to be
supplied by the bypass.
Setting this object to 'On inverter' will cause the
load to be supplied by the inverter.
If the load is already supplied by the desired
source nothing will happen.
The magnitude of the nominal input voltage. On those
systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal input frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The magnitude of the nominal output voltage. On
those systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal output frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The value of upsEstimatedMinutesRemaining at which a
lowBattery condition is declared. For agents which
support only discrete (discontinuous) values, then the
agent shall round up to the next supported value. If
the requested value is larger than the largest
supported value, then the largest supported value
shall be selected.(*)
The requested state of the audible alarm. When in
the disabled state, the audible alarm should never
sound. The enabled state is self-describing. Setting
this object to muted(3) when the audible alarm is
sounding shall temporarily silence the alarm. It will
remain muted until it would normally stop sounding and
the value returned for read operations during this
period shall equal muted(3). At the end of this
period, the value shall revert to enabled(2). Writes
of the value muted(3) when the audible alarm is not
sounding shall be accepted but otherwise shall have no
effect.(*)
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventSetStartingTimeStamp
will be used as the start value of the table with the lowest index number.
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventLastTime will
be used as the last value of the table with the highest index number.
Returns SNMPNOSUCHNAME for UPSs that don't support this command.
A list of event table entries. The number of entries is always
10, and the value of upsEventTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..10)):
PDU-SET upsSetStartingTimeStamp
The status of the UPS at the moment that the event was generated.
The format is specified at the 'upsStatus' command.
If the UPS is not able to deliver status information, then
SNMPNOSUCHNAME is returned.
The number of parameters to retreive from the UPS.
When this object is set the ParameterTable will be filled with the
requested number of entries. The value upsParametersStartAddress
will be used as the start value of the table with the lowest index
number.
The number of parameters to write to the UPS.
When this object is set the ParameterTable will be send to the ups.
The value upsParametersStartAddress will be used for the fourth value
of the table with the lowest index number.
A list of parameter entries. The number of entries is always
16, and the value of upsParameterTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..16)):
Read sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParametersRead
PDU-GET upsParameterTableSize
PDU-GET upsParameterValue 1
PDU-GET upsParameterValue 2
..
PDU-GET upsParameterValue
The table is read up to requested number of events and the
management software afterwards decides which entries are
valid, as indicated by the upsParameterTableSize.
Write sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParameterValue 1
PDU-SET upsParameterValue 2
..
PDU-SET upsParameterValue
PDU-SET upsParametersWrite
The current timestamp (or real-time) of the UPS. For the format,
see 'Timestamp' specifications. The write-command has to comply with the
correct timestamp format expected by the UPS (counter value or real-time-clock
value). Missing to doing so will result in a SNMPfourthERROR,
meaning 'command not supported'. It is possible to know which is the timestamp
format supported by the UPS, by issuing a read-command or by reading events,
which includes timestamps.
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The indication of the capacity remaining in the UPS
system's batteries. A value of batteryNormal
indicates that the remaining run-time is greater than
upsConfigLowBattTime. A value of batteryLow indicates
that the remaining battery run-time is less than or
equal to upsConfigLowBattTime. A value of
batteryDepleted indicates that the UPS will be unable
to sustain the present load when and if the utility
power is lost (including the possibility that the
utility power is currently absent and the UPS is
unable to sustain the output).(*)
If the unit is on battery power, the elapsed time
since the UPS last switched to battery power, or the
time since the network management subsystem was last
restarted, whichever is less. Zero shall be returned
if the unit is not on battery power.(*)
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.(*)
A count of the number of times the input entered an
out-of-tolerance condition as defined by the
manufacturer. This count is incremented by one each
time the input transitions from zero out-of-tolerance
lines to one or more input lines out-of-tolerance.(*)
The present source of output power. The enumeration
none(2) indicates that there is no source of output
power (and therefore no output power), for example,
the system has opened the output breaker.(*)
The percentage of the UPS power capacity presently
being used on this output line, i.e., the greater of
the percent load of true power capacity and the
percent load of VA.(*)
The present output power factor.
The returned value correspond to the cosf of the load.
A positive value indicate an inductive load;
a negative value indicate a capacitive load;
value 1 indicate a resistive load.
If the measure is not available due to a small load for
a consistent calculation, the NA value is then returned.(*)
In a parallel system ideally all the UPS are requested to
contribute to the load with the same amount of current,
i.e. with no current share. The current share occurs when an
UPS exchanges some current with another UPS, so that this
current component doesn't feed the load.
The share part of the UPS current represents an undesired UPS
loading, and therefore it should be minimized. If the share
current is too high, the UPS results overloaded and in some
conditions (i.e. very high load) the system could turn on
bypass reducing dramatically the global system reliability.
PMAD detects the amount of share currents in a parallel system,
generating an alarm if this value is above a parameter-based threshold.
Single UPS systems don't have this feature, NA will be provided.(*)
A list of alarm table entries. The table contains
zero, one, or many rows at any moment, depending upon
the number of alarm conditions in effect. The table
is initially empty at agent startup. The agent
creates a row in the table each time a condition is
detected and deletes that row when that condition no
longer pertains. The agent creates the first row with
upsAlarmId equal to 1, and increments the value of
upsAlarmId each time a new row is created, wrapping to
the first free value greater than or equal to 1 when
the maximum value of upsAlarmId would otherwise be
exceeded. Consequently, after multiple operations,
the table may become sparse, e.g., containing entries
for rows 95, 100, 101, and 203 and the entries should
not be assumed to be in chronological order because
upsAlarmId might have wrapped.
Alarms are named by an AutonomousType (OBJECT
IDENTIFIER), upsAlarmDescr, to allow a single table to
reflect well known alarms plus alarms defined by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device. No
two rows will have the same value of upsAlarmDescr,
since alarms define conditions. In order to meet this
requirement, care should be taken in the definition of
alarm conditions to insure that a system cannot enter
the same condition multiple times simultaneously.
The number of rows in the table at any given time is
reflected by the value of upsAlarmsPresent.(*)
A reference to an alarm description object. The
object referenced should not be accessible, but rather
be used to provide a unique description of the alarm
condition.(*)
The value of sysUpTime when the alarm condition was
detected. If the alarm condition was detected at the
time of agent startup and presumably existed before
agent startup, the value of upsAlarmTime shall equal
0.(*)
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.(*)
Specifies which alarm can be handled by the UPS.
The 'Mask' parameter is a Long Integer32. The meaning
of every bit is the same as for the 'upsAlarmGroupA'
command. A bit having value=1 indicates that the
corresponding alarm is handled by the UPS.
The test is named by an OBJECT IDENTIFIER which
allows a standard mechanism for the initiation of
tests, including the well known tests identified in
this document as well as those introduced by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device.
Setting this variable initiates the named test. Sets
to this variable require the presence of
upsTestSpinLock in the same SNMP message.
The set request will be rejected with an appropriate
error message if the requested test cannot be
performed, including attempts to start a test when
another test is already in progress. The status of
the current or last test is maintained in
upsTestResultsSummary. Tests in progress may be
aborted by setting the upsTestId variable to
upsTestAbortTestInProgress.
Read operations return the value of the name of the
test in progress if a test is in progress or the name
of the last test performed if no test is in progress,
unless no test has been run, in which case the well
known value upsTestNoTestsInitiated is returned.(*)
A spin lock on the test subsystem. The spinlock is
used as follows.
Before starting a test, a manager-station should make
sure that a test is not in progress as follows:
tryagain:
get (upsTestSpinLock)
while (upsTestResultsSummary == inProgress) {
/* loop while a test is running for another
manager */
short delay
get (upsTestSpinLock)
}
lockvalue = upsTestSpinLock
/* no test in progress, start the test */
set (upsTestSpinLock = lockvalue, upsTestId =
requestedtest)
if (errorindex == 1) { /* (upsTestSpinLock
failed) */
/* if problem is not access control, then
some other manager slipped in ahead of us
*/
goto tryagain
}
if (errorindex == 2) { /* (upsTestId) */
/* cannot perform the test */
give up
}
/* test started ok */
/* wait for test completion by polling
upsTestResultsSummary */
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
while (upsTestResultsSummary == inProgress) {
short delay
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
}
/* when test completes, retrieve any additional
test results */
/* if upsTestSpinLock == lockvalue + 1, then
these are our test */
/* results (as opposed to another manager's */
The initial value of upsTestSpinLock at agent
initialization shall
be 1.(*)
The results of the current or last UPS diagnostics
test performed. The values for donePass(1),
doneWarning(2), and doneError(3) indicate that the
test completed either successfully, with a warning, or
with an error, respectively. The value aborted(4) is
returned for tests which are aborted by setting the
value of upsTestId to upsTestAbortTestInProgress.
Tests which have not yet concluded are indicated by
inProgress(5). The value noTestsInitiated(6)
indicates that no previous test results are available,
such as is the case when no tests have been run since
the last reinitialization of the network management
subsystem and the system has no provision for non-
volatile storage of test results.(*)
The value of sysUpTime at the time the test in
progress was initiated, or, if no test is in progress,
the time the previous test was initiated. If the
value of upsTestResultsSummary is noTestsInitiated(6),
upsTestStartTime has the value 0.(*)
The amount of time, in TimeTicks, since the test in
progress was initiated, or, if no test is in progress,
the previous test took to complete. If the value of
upsTestResultsSummary is noTestsInitiated(6),
upsTestElapsedTime has the value 0.(*)
The system is placed on battery to a discharge level,
set by the manufacturer, sufficient to determine
battery replacement and battery run-time with a high
degree of confidence. WARNING: this test will leave
the battery in a low charge state and will require
time for recharging to a level sufficient to provide
normal battery duration for the protected load.(*)
This object determines the nature of the action to be
taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration
objects reaches zero.
Setting this object to output(1) indicates that
shutdown requests should cause only the output of the
UPS to turn off. Setting this object to system(2)
indicates that shutdown requests will cause the entire
UPS system to turn off.(*)
Setting this object will shutdown (i.e., turn off)
either the UPS output or the UPS system (as determined
by the value of upsShutdownType at the time of
shutdown) after the indicated number of fifths, or
less if the UPS batteries become depleted. Setting
this object to 0 will cause the shutdown to occur
immediately. Setting this object to -1 will abort the
countdown. If the system is already in the desired
state at the time the countdown reaches 0, then
nothing will happen. That is, there is no additional
action at that time if upsShutdownType = system and
the system is already off. Similarly, there is no
additional action at that time if upsShutdownType =
output and the output is already off. When read,
upsShutdownAfterDelay will return the number of
fifths remaining until shutdown, or -1 if no shutdown
countdown is in effect. On some systems, if the agent
is restarted while a shutdown countdown is in effect,
the countdown may be aborted. Sets to this object
override any upsShutdownAfterDelay already in effect.(*)
Setting this object will start the output after the
indicated number of fifths, including starting the
UPS, if necessary. Setting this object to 0 will
cause the startup to occur immediately. Setting this
object to -1 will abort the countdown. If the output
is already on at the time the countdown reaches 0,
then nothing will happen. Sets to this object
override the effect of any upsStartupAfterDelay
countdown or upsRebootWithDuration countdown in
progress. When read, upsStartupAfterDelay will return
the number of fifths until startup, or -1 if no
startup countdown is in effect. If the countdown
expires during a utility failure, the startup shall
not occur until the utility power is restored. On
some systems, if the agent is restarted while a
startup countdown is in effect, the countdown is
aborted.(*)
Setting this object will immediately shutdown (i.e.,
turn off) either the UPS output or the UPS system (as
determined by the value of upsShutdownType at the time
of shutdown) for a period equal to the indicated
number of fifths, after which time the output will be
started, including starting the UPS, if necessary. If
the number of fifths required to perform the request
is greater than the requested duration, then the
requested shutdown and startup cycle shall be
performed in the minimum time possible, but in no case
shall this require more than the requested duration
plus 60 fifths. When read, upsRebootWithDuration
shall return the number of fifths remaining in the
countdown, or -1 if no countdown is in progress. If
the startup should occur during a utility failure, the
startup shall not occur until the utility power is
restored.(*)
Setting this object to 'on' will cause the UPS system
to restart after a shutdown if the shutdown occurred
during a power loss as a result of either a
upsShutdownAfterDelay or an internal battery depleted
condition. Setting this object to 'off' will prevent
the UPS system from restarting after a shutdown until
an operator manually or remotely explicitly restarts
it. If the UPS is in a startup or reboot countdown,
then the UPS will not restart until that delay has
been satisfied.(*)
The present state of the receptacle. Setting this
object to 'on' will cause the receptacle to be turned
on. Setting this object to 'off' will turn the
receptacle off. If the receptacle is already in the
desired state nothing will happen. After an
autorestart (see upsAutoRestart) the receptacle will
be on.
The operation mode off the UPS. Off-line indicates a
mode in which the input power is transferred to the
output directly or via a step-up or step-down
transformer. On-line mode indicates a mode in which
the output power is regenerated through some convertor.
the operating mode of the UPS may be fixed, or may be
selectable (e.g. an on-line UPS with ecomode)
The present state of the rectifier. Setting this
object to 'on' will cause the rectifier to be turned
on. Setting this object to 'off' will turn the
rectifier off. If the rectifier is already in the
desired state nothing will happen.
The present state of the charge method. Setting this
object to 'Normal charge' will cause the battery to be
charged using the normal method. Setting this object to
'Boost charge' will charge the battery in boost mode.
If the charge method is already in the desired state
nothing will happen.
The present state of the inverter. Setting this
object to 'on' will cause the inverter to be turned
on. Setting this object to 'off' will turn the
inverter off. If the inverter is already in the
desired state nothing will happen.
The present state of the bypass. Setting this
object to 'on' will cause the bypass to be activated.
Setting this object to 'off' will deactivate the
bypass. If the UPS is already in the
desired state nothing will happen.
The present source of the load. Setting this
object to 'On bypass' will cause the load to be
supplied by the bypass.
Setting this object to 'On inverter' will cause the
load to be supplied by the inverter.
If the load is already supplied by the desired
source nothing will happen.
The magnitude of the nominal input voltage. On those
systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal input frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The magnitude of the nominal output voltage. On
those systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal output frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The value of upsEstimatedMinutesRemaining at which a
lowBattery condition is declared. For agents which
support only discrete (discontinuous) values, then the
agent shall round up to the next supported value. If
the requested value is larger than the largest
supported value, then the largest supported value
shall be selected.(*)
The requested state of the audible alarm. When in
the disabled state, the audible alarm should never
sound. The enabled state is self-describing. Setting
this object to muted(3) when the audible alarm is
sounding shall temporarily silence the alarm. It will
remain muted until it would normally stop sounding and
the value returned for read operations during this
period shall equal muted(3). At the end of this
period, the value shall revert to enabled(2). Writes
of the value muted(3) when the audible alarm is not
sounding shall be accepted but otherwise shall have no
effect.(*)
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventSetStartingTimeStamp
will be used as the start value of the table with the lowest index number.
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventLastTime will
be used as the last value of the table with the highest index number.
Returns SNMPNOSUCHNAME for UPSs that don't support this command.
A list of event table entries. The number of entries is always
10, and the value of upsEventTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..10)):
PDU-SET upsSetStartingTimeStamp
The status of the UPS at the moment that the event was generated.
The format is specified at the 'upsStatus' command.
If the UPS is not able to deliver status information, then
SNMPNOSUCHNAME is returned.
The number of parameters to retreive from the UPS.
When this object is set the ParameterTable will be filled with the
requested number of entries. The value upsParametersStartAddress
will be used as the start value of the table with the lowest index
number.
The number of parameters to write to the UPS.
When this object is set the ParameterTable will be send to the ups.
The value upsParametersStartAddress will be used for the fifth value
of the table with the lowest index number.
A list of parameter entries. The number of entries is always
16, and the value of upsParameterTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..16)):
Read sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParametersRead
PDU-GET upsParameterTableSize
PDU-GET upsParameterValue 1
PDU-GET upsParameterValue 2
..
PDU-GET upsParameterValue
The table is read up to requested number of events and the
management software afterwards decides which entries are
valid, as indicated by the upsParameterTableSize.
Write sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParameterValue 1
PDU-SET upsParameterValue 2
..
PDU-SET upsParameterValue
PDU-SET upsParametersWrite
The current timestamp (or real-time) of the UPS. For the format,
see 'Timestamp' specifications. The write-command has to comply with the
correct timestamp format expected by the UPS (counter value or real-time-clock
value). Missing to doing so will result in a SNMPfifthERROR,
meaning 'command not supported'. It is possible to know which is the timestamp
format supported by the UPS, by issuing a read-command or by reading events,
which includes timestamps.
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The indication of the capacity remaining in the UPS
system's batteries. A value of batteryNormal
indicates that the remaining run-time is greater than
upsConfigLowBattTime. A value of batteryLow indicates
that the remaining battery run-time is less than or
equal to upsConfigLowBattTime. A value of
batteryDepleted indicates that the UPS will be unable
to sustain the present load when and if the utility
power is lost (including the possibility that the
utility power is currently absent and the UPS is
unable to sustain the output).(*)
If the unit is on battery power, the elapsed time
since the UPS last switched to battery power, or the
time since the network management subsystem was last
restarted, whichever is less. Zero shall be returned
if the unit is not on battery power.(*)
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.(*)
A count of the number of times the input entered an
out-of-tolerance condition as defined by the
manufacturer. This count is incremented by one each
time the input transitions from zero out-of-tolerance
lines to one or more input lines out-of-tolerance.(*)
The present source of output power. The enumeration
none(2) indicates that there is no source of output
power (and therefore no output power), for example,
the system has opened the output breaker.(*)
The percentage of the UPS power capacity presently
being used on this output line, i.e., the greater of
the percent load of true power capacity and the
percent load of VA.(*)
The present output power factor.
The returned value correspond to the cosf of the load.
A positive value indicate an inductive load;
a negative value indicate a capacitive load;
value 1 indicate a resistive load.
If the measure is not available due to a small load for
a consistent calculation, the NA value is then returned.(*)
In a parallel system ideally all the UPS are requested to
contribute to the load with the same amount of current,
i.e. with no current share. The current share occurs when an
UPS exchanges some current with another UPS, so that this
current component doesn't feed the load.
The share part of the UPS current represents an undesired UPS
loading, and therefore it should be minimized. If the share
current is too high, the UPS results overloaded and in some
conditions (i.e. very high load) the system could turn on
bypass reducing dramatically the global system reliability.
PMAD detects the amount of share currents in a parallel system,
generating an alarm if this value is above a parameter-based threshold.
Single UPS systems don't have this feature, NA will be provided.(*)
A list of alarm table entries. The table contains
zero, one, or many rows at any moment, depending upon
the number of alarm conditions in effect. The table
is initially empty at agent startup. The agent
creates a row in the table each time a condition is
detected and deletes that row when that condition no
longer pertains. The agent creates the first row with
upsAlarmId equal to 1, and increments the value of
upsAlarmId each time a new row is created, wrapping to
the first free value greater than or equal to 1 when
the maximum value of upsAlarmId would otherwise be
exceeded. Consequently, after multiple operations,
the table may become sparse, e.g., containing entries
for rows 95, 100, 101, and 203 and the entries should
not be assumed to be in chronological order because
upsAlarmId might have wrapped.
Alarms are named by an AutonomousType (OBJECT
IDENTIFIER), upsAlarmDescr, to allow a single table to
reflect well known alarms plus alarms defined by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device. No
two rows will have the same value of upsAlarmDescr,
since alarms define conditions. In order to meet this
requirement, care should be taken in the definition of
alarm conditions to insure that a system cannot enter
the same condition multiple times simultaneously.
The number of rows in the table at any given time is
reflected by the value of upsAlarmsPresent.(*)
A reference to an alarm description object. The
object referenced should not be accessible, but rather
be used to provide a unique description of the alarm
condition.(*)
The value of sysUpTime when the alarm condition was
detected. If the alarm condition was detected at the
time of agent startup and presumably existed before
agent startup, the value of upsAlarmTime shall equal
0.(*)
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.(*)
Specifies which alarm can be handled by the UPS.
The 'Mask' parameter is a Long Integer32. The meaning
of every bit is the same as for the 'upsAlarmGroupA'
command. A bit having value=1 indicates that the
corresponding alarm is handled by the UPS.
The test is named by an OBJECT IDENTIFIER which
allows a standard mechanism for the initiation of
tests, including the well known tests identified in
this document as well as those introduced by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device.
Setting this variable initiates the named test. Sets
to this variable require the presence of
upsTestSpinLock in the same SNMP message.
The set request will be rejected with an appropriate
error message if the requested test cannot be
performed, including attempts to start a test when
another test is already in progress. The status of
the current or last test is maintained in
upsTestResultsSummary. Tests in progress may be
aborted by setting the upsTestId variable to
upsTestAbortTestInProgress.
Read operations return the value of the name of the
test in progress if a test is in progress or the name
of the last test performed if no test is in progress,
unless no test has been run, in which case the well
known value upsTestNoTestsInitiated is returned.(*)
A spin lock on the test subsystem. The spinlock is
used as follows.
Before starting a test, a manager-station should make
sure that a test is not in progress as follows:
tryagain:
get (upsTestSpinLock)
while (upsTestResultsSummary == inProgress) {
/* loop while a test is running for another
manager */
short delay
get (upsTestSpinLock)
}
lockvalue = upsTestSpinLock
/* no test in progress, start the test */
set (upsTestSpinLock = lockvalue, upsTestId =
requestedtest)
if (errorindex == 1) { /* (upsTestSpinLock
failed) */
/* if problem is not access control, then
some other manager slipped in ahead of us
*/
goto tryagain
}
if (errorindex == 2) { /* (upsTestId) */
/* cannot perform the test */
give up
}
/* test started ok */
/* wait for test completion by polling
upsTestResultsSummary */
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
while (upsTestResultsSummary == inProgress) {
short delay
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
}
/* when test completes, retrieve any additional
test results */
/* if upsTestSpinLock == lockvalue + 1, then
these are our test */
/* results (as opposed to another manager's */
The initial value of upsTestSpinLock at agent
initialization shall
be 1.(*)
The results of the current or last UPS diagnostics
test performed. The values for donePass(1),
doneWarning(2), and doneError(3) indicate that the
test completed either successfully, with a warning, or
with an error, respectively. The value aborted(4) is
returned for tests which are aborted by setting the
value of upsTestId to upsTestAbortTestInProgress.
Tests which have not yet concluded are indicated by
inProgress(5). The value noTestsInitiated(6)
indicates that no previous test results are available,
such as is the case when no tests have been run since
the last reinitialization of the network management
subsystem and the system has no provision for non-
volatile storage of test results.(*)
The value of sysUpTime at the time the test in
progress was initiated, or, if no test is in progress,
the time the previous test was initiated. If the
value of upsTestResultsSummary is noTestsInitiated(6),
upsTestStartTime has the value 0.(*)
The amount of time, in TimeTicks, since the test in
progress was initiated, or, if no test is in progress,
the previous test took to complete. If the value of
upsTestResultsSummary is noTestsInitiated(6),
upsTestElapsedTime has the value 0.(*)
The system is placed on battery to a discharge level,
set by the manufacturer, sufficient to determine
battery replacement and battery run-time with a high
degree of confidence. WARNING: this test will leave
the battery in a low charge state and will require
time for recharging to a level sufficient to provide
normal battery duration for the protected load.(*)
This object determines the nature of the action to be
taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration
objects reaches zero.
Setting this object to output(1) indicates that
shutdown requests should cause only the output of the
UPS to turn off. Setting this object to system(2)
indicates that shutdown requests will cause the entire
UPS system to turn off.(*)
Setting this object will shutdown (i.e., turn off)
either the UPS output or the UPS system (as determined
by the value of upsShutdownType at the time of
shutdown) after the indicated number of sixths, or
less if the UPS batteries become depleted. Setting
this object to 0 will cause the shutdown to occur
immediately. Setting this object to -1 will abort the
countdown. If the system is already in the desired
state at the time the countdown reaches 0, then
nothing will happen. That is, there is no additional
action at that time if upsShutdownType = system and
the system is already off. Similarly, there is no
additional action at that time if upsShutdownType =
output and the output is already off. When read,
upsShutdownAfterDelay will return the number of
sixths remaining until shutdown, or -1 if no shutdown
countdown is in effect. On some systems, if the agent
is restarted while a shutdown countdown is in effect,
the countdown may be aborted. Sets to this object
override any upsShutdownAfterDelay already in effect.(*)
Setting this object will start the output after the
indicated number of sixths, including starting the
UPS, if necessary. Setting this object to 0 will
cause the startup to occur immediately. Setting this
object to -1 will abort the countdown. If the output
is already on at the time the countdown reaches 0,
then nothing will happen. Sets to this object
override the effect of any upsStartupAfterDelay
countdown or upsRebootWithDuration countdown in
progress. When read, upsStartupAfterDelay will return
the number of sixths until startup, or -1 if no
startup countdown is in effect. If the countdown
expires during a utility failure, the startup shall
not occur until the utility power is restored. On
some systems, if the agent is restarted while a
startup countdown is in effect, the countdown is
aborted.(*)
Setting this object will immediately shutdown (i.e.,
turn off) either the UPS output or the UPS system (as
determined by the value of upsShutdownType at the time
of shutdown) for a period equal to the indicated
number of sixths, after which time the output will be
started, including starting the UPS, if necessary. If
the number of sixths required to perform the request
is greater than the requested duration, then the
requested shutdown and startup cycle shall be
performed in the minimum time possible, but in no case
shall this require more than the requested duration
plus 60 sixths. When read, upsRebootWithDuration
shall return the number of sixths remaining in the
countdown, or -1 if no countdown is in progress. If
the startup should occur during a utility failure, the
startup shall not occur until the utility power is
restored.(*)
Setting this object to 'on' will cause the UPS system
to restart after a shutdown if the shutdown occurred
during a power loss as a result of either a
upsShutdownAfterDelay or an internal battery depleted
condition. Setting this object to 'off' will prevent
the UPS system from restarting after a shutdown until
an operator manually or remotely explicitly restarts
it. If the UPS is in a startup or reboot countdown,
then the UPS will not restart until that delay has
been satisfied.(*)
The present state of the receptacle. Setting this
object to 'on' will cause the receptacle to be turned
on. Setting this object to 'off' will turn the
receptacle off. If the receptacle is already in the
desired state nothing will happen. After an
autorestart (see upsAutoRestart) the receptacle will
be on.
The operation mode off the UPS. Off-line indicates a
mode in which the input power is transferred to the
output directly or via a step-up or step-down
transformer. On-line mode indicates a mode in which
the output power is regenerated through some convertor.
the operating mode of the UPS may be fixed, or may be
selectable (e.g. an on-line UPS with ecomode)
The present state of the rectifier. Setting this
object to 'on' will cause the rectifier to be turned
on. Setting this object to 'off' will turn the
rectifier off. If the rectifier is already in the
desired state nothing will happen.
The present state of the charge method. Setting this
object to 'Normal charge' will cause the battery to be
charged using the normal method. Setting this object to
'Boost charge' will charge the battery in boost mode.
If the charge method is already in the desired state
nothing will happen.
The present state of the inverter. Setting this
object to 'on' will cause the inverter to be turned
on. Setting this object to 'off' will turn the
inverter off. If the inverter is already in the
desired state nothing will happen.
The present state of the bypass. Setting this
object to 'on' will cause the bypass to be activated.
Setting this object to 'off' will deactivate the
bypass. If the UPS is already in the
desired state nothing will happen.
The present source of the load. Setting this
object to 'On bypass' will cause the load to be
supplied by the bypass.
Setting this object to 'On inverter' will cause the
load to be supplied by the inverter.
If the load is already supplied by the desired
source nothing will happen.
The magnitude of the nominal input voltage. On those
systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal input frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The magnitude of the nominal output voltage. On
those systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal output frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The value of upsEstimatedMinutesRemaining at which a
lowBattery condition is declared. For agents which
support only discrete (discontinuous) values, then the
agent shall round up to the next supported value. If
the requested value is larger than the largest
supported value, then the largest supported value
shall be selected.(*)
The requested state of the audible alarm. When in
the disabled state, the audible alarm should never
sound. The enabled state is self-describing. Setting
this object to muted(3) when the audible alarm is
sounding shall temporarily silence the alarm. It will
remain muted until it would normally stop sounding and
the value returned for read operations during this
period shall equal muted(3). At the end of this
period, the value shall revert to enabled(2). Writes
of the value muted(3) when the audible alarm is not
sounding shall be accepted but otherwise shall have no
effect.(*)
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventSetStartingTimeStamp
will be used as the start value of the table with the lowest index number.
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventLastTime will
be used as the last value of the table with the highest index number.
Returns SNMPNOSUCHNAME for UPSs that don't support this command.
A list of event table entries. The number of entries is always
10, and the value of upsEventTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..10)):
PDU-SET upsSetStartingTimeStamp
The status of the UPS at the moment that the event was generated.
The format is specified at the 'upsStatus' command.
If the UPS is not able to deliver status information, then
SNMPNOSUCHNAME is returned.
The number of parameters to retreive from the UPS.
When this object is set the ParameterTable will be filled with the
requested number of entries. The value upsParametersStartAddress
will be used as the start value of the table with the lowest index
number.
The number of parameters to write to the UPS.
When this object is set the ParameterTable will be send to the ups.
The value upsParametersStartAddress will be used for the sixth value
of the table with the lowest index number.
A list of parameter entries. The number of entries is always
16, and the value of upsParameterTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..16)):
Read sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParametersRead
PDU-GET upsParameterTableSize
PDU-GET upsParameterValue 1
PDU-GET upsParameterValue 2
..
PDU-GET upsParameterValue
The table is read up to requested number of events and the
management software afterwards decides which entries are
valid, as indicated by the upsParameterTableSize.
Write sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParameterValue 1
PDU-SET upsParameterValue 2
..
PDU-SET upsParameterValue
PDU-SET upsParametersWrite
The current timestamp (or real-time) of the UPS. For the format,
see 'Timestamp' specifications. The write-command has to comply with the
correct timestamp format expected by the UPS (counter value or real-time-clock
value). Missing to doing so will result in a SNMPsixthERROR,
meaning 'command not supported'. It is possible to know which is the timestamp
format supported by the UPS, by issuing a read-command or by reading events,
which includes timestamps.
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The indication of the capacity remaining in the UPS
system's batteries. A value of batteryNormal
indicates that the remaining run-time is greater than
upsConfigLowBattTime. A value of batteryLow indicates
that the remaining battery run-time is less than or
equal to upsConfigLowBattTime. A value of
batteryDepleted indicates that the UPS will be unable
to sustain the present load when and if the utility
power is lost (including the possibility that the
utility power is currently absent and the UPS is
unable to sustain the output).(*)
If the unit is on battery power, the elapsed time
since the UPS last switched to battery power, or the
time since the network management subsystem was last
restarted, whichever is less. Zero shall be returned
if the unit is not on battery power.(*)
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.(*)
A count of the number of times the input entered an
out-of-tolerance condition as defined by the
manufacturer. This count is incremented by one each
time the input transitions from zero out-of-tolerance
lines to one or more input lines out-of-tolerance.(*)
The present source of output power. The enumeration
none(2) indicates that there is no source of output
power (and therefore no output power), for example,
the system has opened the output breaker.(*)
The percentage of the UPS power capacity presently
being used on this output line, i.e., the greater of
the percent load of true power capacity and the
percent load of VA.(*)
The present output power factor.
The returned value correspond to the cosf of the load.
A positive value indicate an inductive load;
a negative value indicate a capacitive load;
value 1 indicate a resistive load.
If the measure is not available due to a small load for
a consistent calculation, the NA value is then returned.(*)
In a parallel system ideally all the UPS are requested to
contribute to the load with the same amount of current,
i.e. with no current share. The current share occurs when an
UPS exchanges some current with another UPS, so that this
current component doesn't feed the load.
The share part of the UPS current represents an undesired UPS
loading, and therefore it should be minimized. If the share
current is too high, the UPS results overloaded and in some
conditions (i.e. very high load) the system could turn on
bypass reducing dramatically the global system reliability.
PMAD detects the amount of share currents in a parallel system,
generating an alarm if this value is above a parameter-based threshold.
Single UPS systems don't have this feature, NA will be provided.(*)
A list of alarm table entries. The table contains
zero, one, or many rows at any moment, depending upon
the number of alarm conditions in effect. The table
is initially empty at agent startup. The agent
creates a row in the table each time a condition is
detected and deletes that row when that condition no
longer pertains. The agent creates the first row with
upsAlarmId equal to 1, and increments the value of
upsAlarmId each time a new row is created, wrapping to
the first free value greater than or equal to 1 when
the maximum value of upsAlarmId would otherwise be
exceeded. Consequently, after multiple operations,
the table may become sparse, e.g., containing entries
for rows 95, 100, 101, and 203 and the entries should
not be assumed to be in chronological order because
upsAlarmId might have wrapped.
Alarms are named by an AutonomousType (OBJECT
IDENTIFIER), upsAlarmDescr, to allow a single table to
reflect well known alarms plus alarms defined by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device. No
two rows will have the same value of upsAlarmDescr,
since alarms define conditions. In order to meet this
requirement, care should be taken in the definition of
alarm conditions to insure that a system cannot enter
the same condition multiple times simultaneously.
The number of rows in the table at any given time is
reflected by the value of upsAlarmsPresent.(*)
A reference to an alarm description object. The
object referenced should not be accessible, but rather
be used to provide a unique description of the alarm
condition.(*)
The value of sysUpTime when the alarm condition was
detected. If the alarm condition was detected at the
time of agent startup and presumably existed before
agent startup, the value of upsAlarmTime shall equal
0.(*)
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.(*)
Specifies which alarm can be handled by the UPS.
The 'Mask' parameter is a Long Integer32. The meaning
of every bit is the same as for the 'upsAlarmGroupA'
command. A bit having value=1 indicates that the
corresponding alarm is handled by the UPS.
The test is named by an OBJECT IDENTIFIER which
allows a standard mechanism for the initiation of
tests, including the well known tests identified in
this document as well as those introduced by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device.
Setting this variable initiates the named test. Sets
to this variable require the presence of
upsTestSpinLock in the same SNMP message.
The set request will be rejected with an appropriate
error message if the requested test cannot be
performed, including attempts to start a test when
another test is already in progress. The status of
the current or last test is maintained in
upsTestResultsSummary. Tests in progress may be
aborted by setting the upsTestId variable to
upsTestAbortTestInProgress.
Read operations return the value of the name of the
test in progress if a test is in progress or the name
of the last test performed if no test is in progress,
unless no test has been run, in which case the well
known value upsTestNoTestsInitiated is returned.(*)
A spin lock on the test subsystem. The spinlock is
used as follows.
Before starting a test, a manager-station should make
sure that a test is not in progress as follows:
tryagain:
get (upsTestSpinLock)
while (upsTestResultsSummary == inProgress) {
/* loop while a test is running for another
manager */
short delay
get (upsTestSpinLock)
}
lockvalue = upsTestSpinLock
/* no test in progress, start the test */
set (upsTestSpinLock = lockvalue, upsTestId =
requestedtest)
if (errorindex == 1) { /* (upsTestSpinLock
failed) */
/* if problem is not access control, then
some other manager slipped in ahead of us
*/
goto tryagain
}
if (errorindex == 2) { /* (upsTestId) */
/* cannot perform the test */
give up
}
/* test started ok */
/* wait for test completion by polling
upsTestResultsSummary */
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
while (upsTestResultsSummary == inProgress) {
short delay
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
}
/* when test completes, retrieve any additional
test results */
/* if upsTestSpinLock == lockvalue + 1, then
these are our test */
/* results (as opposed to another manager's */
The initial value of upsTestSpinLock at agent
initialization shall
be 1.(*)
The results of the current or last UPS diagnostics
test performed. The values for donePass(1),
doneWarning(2), and doneError(3) indicate that the
test completed either successfully, with a warning, or
with an error, respectively. The value aborted(4) is
returned for tests which are aborted by setting the
value of upsTestId to upsTestAbortTestInProgress.
Tests which have not yet concluded are indicated by
inProgress(5). The value noTestsInitiated(6)
indicates that no previous test results are available,
such as is the case when no tests have been run since
the last reinitialization of the network management
subsystem and the system has no provision for non-
volatile storage of test results.(*)
The value of sysUpTime at the time the test in
progress was initiated, or, if no test is in progress,
the time the previous test was initiated. If the
value of upsTestResultsSummary is noTestsInitiated(6),
upsTestStartTime has the value 0.(*)
The amount of time, in TimeTicks, since the test in
progress was initiated, or, if no test is in progress,
the previous test took to complete. If the value of
upsTestResultsSummary is noTestsInitiated(6),
upsTestElapsedTime has the value 0.(*)
The system is placed on battery to a discharge level,
set by the manufacturer, sufficient to determine
battery replacement and battery run-time with a high
degree of confidence. WARNING: this test will leave
the battery in a low charge state and will require
time for recharging to a level sufficient to provide
normal battery duration for the protected load.(*)
This object determines the nature of the action to be
taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration
objects reaches zero.
Setting this object to output(1) indicates that
shutdown requests should cause only the output of the
UPS to turn off. Setting this object to system(2)
indicates that shutdown requests will cause the entire
UPS system to turn off.(*)
Setting this object will shutdown (i.e., turn off)
either the UPS output or the UPS system (as determined
by the value of upsShutdownType at the time of
shutdown) after the indicated number of sevenths, or
less if the UPS batteries become depleted. Setting
this object to 0 will cause the shutdown to occur
immediately. Setting this object to -1 will abort the
countdown. If the system is already in the desired
state at the time the countdown reaches 0, then
nothing will happen. That is, there is no additional
action at that time if upsShutdownType = system and
the system is already off. Similarly, there is no
additional action at that time if upsShutdownType =
output and the output is already off. When read,
upsShutdownAfterDelay will return the number of
sevenths remaining until shutdown, or -1 if no shutdown
countdown is in effect. On some systems, if the agent
is restarted while a shutdown countdown is in effect,
the countdown may be aborted. Sets to this object
override any upsShutdownAfterDelay already in effect.(*)
Setting this object will start the output after the
indicated number of sevenths, including starting the
UPS, if necessary. Setting this object to 0 will
cause the startup to occur immediately. Setting this
object to -1 will abort the countdown. If the output
is already on at the time the countdown reaches 0,
then nothing will happen. Sets to this object
override the effect of any upsStartupAfterDelay
countdown or upsRebootWithDuration countdown in
progress. When read, upsStartupAfterDelay will return
the number of sevenths until startup, or -1 if no
startup countdown is in effect. If the countdown
expires during a utility failure, the startup shall
not occur until the utility power is restored. On
some systems, if the agent is restarted while a
startup countdown is in effect, the countdown is
aborted.(*)
Setting this object will immediately shutdown (i.e.,
turn off) either the UPS output or the UPS system (as
determined by the value of upsShutdownType at the time
of shutdown) for a period equal to the indicated
number of sevenths, after which time the output will be
started, including starting the UPS, if necessary. If
the number of sevenths required to perform the request
is greater than the requested duration, then the
requested shutdown and startup cycle shall be
performed in the minimum time possible, but in no case
shall this require more than the requested duration
plus 60 sevenths. When read, upsRebootWithDuration
shall return the number of sevenths remaining in the
countdown, or -1 if no countdown is in progress. If
the startup should occur during a utility failure, the
startup shall not occur until the utility power is
restored.(*)
Setting this object to 'on' will cause the UPS system
to restart after a shutdown if the shutdown occurred
during a power loss as a result of either a
upsShutdownAfterDelay or an internal battery depleted
condition. Setting this object to 'off' will prevent
the UPS system from restarting after a shutdown until
an operator manually or remotely explicitly restarts
it. If the UPS is in a startup or reboot countdown,
then the UPS will not restart until that delay has
been satisfied.(*)
The present state of the receptacle. Setting this
object to 'on' will cause the receptacle to be turned
on. Setting this object to 'off' will turn the
receptacle off. If the receptacle is already in the
desired state nothing will happen. After an
autorestart (see upsAutoRestart) the receptacle will
be on.
The operation mode off the UPS. Off-line indicates a
mode in which the input power is transferred to the
output directly or via a step-up or step-down
transformer. On-line mode indicates a mode in which
the output power is regenerated through some convertor.
the operating mode of the UPS may be fixed, or may be
selectable (e.g. an on-line UPS with ecomode)
The present state of the rectifier. Setting this
object to 'on' will cause the rectifier to be turned
on. Setting this object to 'off' will turn the
rectifier off. If the rectifier is already in the
desired state nothing will happen.
The present state of the charge method. Setting this
object to 'Normal charge' will cause the battery to be
charged using the normal method. Setting this object to
'Boost charge' will charge the battery in boost mode.
If the charge method is already in the desired state
nothing will happen.
The present state of the inverter. Setting this
object to 'on' will cause the inverter to be turned
on. Setting this object to 'off' will turn the
inverter off. If the inverter is already in the
desired state nothing will happen.
The present state of the bypass. Setting this
object to 'on' will cause the bypass to be activated.
Setting this object to 'off' will deactivate the
bypass. If the UPS is already in the
desired state nothing will happen.
The present source of the load. Setting this
object to 'On bypass' will cause the load to be
supplied by the bypass.
Setting this object to 'On inverter' will cause the
load to be supplied by the inverter.
If the load is already supplied by the desired
source nothing will happen.
The magnitude of the nominal input voltage. On those
systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal input frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The magnitude of the nominal output voltage. On
those systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal output frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The value of upsEstimatedMinutesRemaining at which a
lowBattery condition is declared. For agents which
support only discrete (discontinuous) values, then the
agent shall round up to the next supported value. If
the requested value is larger than the largest
supported value, then the largest supported value
shall be selected.(*)
The requested state of the audible alarm. When in
the disabled state, the audible alarm should never
sound. The enabled state is self-describing. Setting
this object to muted(3) when the audible alarm is
sounding shall temporarily silence the alarm. It will
remain muted until it would normally stop sounding and
the value returned for read operations during this
period shall equal muted(3). At the end of this
period, the value shall revert to enabled(2). Writes
of the value muted(3) when the audible alarm is not
sounding shall be accepted but otherwise shall have no
effect.(*)
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventSetStartingTimeStamp
will be used as the start value of the table with the lowest index number.
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventLastTime will
be used as the last value of the table with the highest index number.
Returns SNMPNOSUCHNAME for UPSs that don't support this command.
A list of event table entries. The number of entries is always
10, and the value of upsEventTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..10)):
PDU-SET upsSetStartingTimeStamp
The status of the UPS at the moment that the event was generated.
The format is specified at the 'upsStatus' command.
If the UPS is not able to deliver status information, then
SNMPNOSUCHNAME is returned.
The number of parameters to retreive from the UPS.
When this object is set the ParameterTable will be filled with the
requested number of entries. The value upsParametersStartAddress
will be used as the start value of the table with the lowest index
number.
The number of parameters to write to the UPS.
When this object is set the ParameterTable will be send to the ups.
The value upsParametersStartAddress will be used for the seventh value
of the table with the lowest index number.
A list of parameter entries. The number of entries is always
16, and the value of upsParameterTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..16)):
Read sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParametersRead
PDU-GET upsParameterTableSize
PDU-GET upsParameterValue 1
PDU-GET upsParameterValue 2
..
PDU-GET upsParameterValue
The table is read up to requested number of events and the
management software afterwards decides which entries are
valid, as indicated by the upsParameterTableSize.
Write sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParameterValue 1
PDU-SET upsParameterValue 2
..
PDU-SET upsParameterValue
PDU-SET upsParametersWrite
The current timestamp (or real-time) of the UPS. For the format,
see 'Timestamp' specifications. The write-command has to comply with the
correct timestamp format expected by the UPS (counter value or real-time-clock
value). Missing to doing so will result in a SNMPseventhERROR,
meaning 'command not supported'. It is possible to know which is the timestamp
format supported by the UPS, by issuing a read-command or by reading events,
which includes timestamps.
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The indication of the capacity remaining in the UPS
system's batteries. A value of batteryNormal
indicates that the remaining run-time is greater than
upsConfigLowBattTime. A value of batteryLow indicates
that the remaining battery run-time is less than or
equal to upsConfigLowBattTime. A value of
batteryDepleted indicates that the UPS will be unable
to sustain the present load when and if the utility
power is lost (including the possibility that the
utility power is currently absent and the UPS is
unable to sustain the output).(*)
If the unit is on battery power, the elapsed time
since the UPS last switched to battery power, or the
time since the network management subsystem was last
restarted, whichever is less. Zero shall be returned
if the unit is not on battery power.(*)
An estimate of the time to battery charge depletion
under the present load conditions if the utility power
is off and remains off, or if it were to be lost and
remain off.(*)
A count of the number of times the input entered an
out-of-tolerance condition as defined by the
manufacturer. This count is incremented by one each
time the input transitions from zero out-of-tolerance
lines to one or more input lines out-of-tolerance.(*)
The present source of output power. The enumeration
none(2) indicates that there is no source of output
power (and therefore no output power), for example,
the system has opened the output breaker.(*)
The percentage of the UPS power capacity presently
being used on this output line, i.e., the greater of
the percent load of true power capacity and the
percent load of VA.(*)
The present output power factor.
The returned value correspond to the cosf of the load.
A positive value indicate an inductive load;
a negative value indicate a capacitive load;
value 1 indicate a resistive load.
If the measure is not available due to a small load for
a consistent calculation, the NA value is then returned.(*)
In a parallel system ideally all the UPS are requested to
contribute to the load with the same amount of current,
i.e. with no current share. The current share occurs when an
UPS exchanges some current with another UPS, so that this
current component doesn't feed the load.
The share part of the UPS current represents an undesired UPS
loading, and therefore it should be minimized. If the share
current is too high, the UPS results overloaded and in some
conditions (i.e. very high load) the system could turn on
bypass reducing dramatically the global system reliability.
PMAD detects the amount of share currents in a parallel system,
generating an alarm if this value is above a parameter-based threshold.
Single UPS systems don't have this feature, NA will be provided.(*)
A list of alarm table entries. The table contains
zero, one, or many rows at any moment, depending upon
the number of alarm conditions in effect. The table
is initially empty at agent startup. The agent
creates a row in the table each time a condition is
detected and deletes that row when that condition no
longer pertains. The agent creates the first row with
upsAlarmId equal to 1, and increments the value of
upsAlarmId each time a new row is created, wrapping to
the first free value greater than or equal to 1 when
the maximum value of upsAlarmId would otherwise be
exceeded. Consequently, after multiple operations,
the table may become sparse, e.g., containing entries
for rows 95, 100, 101, and 203 and the entries should
not be assumed to be in chronological order because
upsAlarmId might have wrapped.
Alarms are named by an AutonomousType (OBJECT
IDENTIFIER), upsAlarmDescr, to allow a single table to
reflect well known alarms plus alarms defined by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device. No
two rows will have the same value of upsAlarmDescr,
since alarms define conditions. In order to meet this
requirement, care should be taken in the definition of
alarm conditions to insure that a system cannot enter
the same condition multiple times simultaneously.
The number of rows in the table at any given time is
reflected by the value of upsAlarmsPresent.(*)
A reference to an alarm description object. The
object referenced should not be accessible, but rather
be used to provide a unique description of the alarm
condition.(*)
The value of sysUpTime when the alarm condition was
detected. If the alarm condition was detected at the
time of agent startup and presumably existed before
agent startup, the value of upsAlarmTime shall equal
0.(*)
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.(*)
Specifies which alarm can be handled by the UPS.
The 'Mask' parameter is a Long Integer32. The meaning
of every bit is the same as for the 'upsAlarmGroupA'
command. A bit having value=1 indicates that the
corresponding alarm is handled by the UPS.
The test is named by an OBJECT IDENTIFIER which
allows a standard mechanism for the initiation of
tests, including the well known tests identified in
this document as well as those introduced by a
particular implementation, i.e., as documented in the
private enterprise MIB definition for the device.
Setting this variable initiates the named test. Sets
to this variable require the presence of
upsTestSpinLock in the same SNMP message.
The set request will be rejected with an appropriate
error message if the requested test cannot be
performed, including attempts to start a test when
another test is already in progress. The status of
the current or last test is maintained in
upsTestResultsSummary. Tests in progress may be
aborted by setting the upsTestId variable to
upsTestAbortTestInProgress.
Read operations return the value of the name of the
test in progress if a test is in progress or the name
of the last test performed if no test is in progress,
unless no test has been run, in which case the well
known value upsTestNoTestsInitiated is returned.(*)
A spin lock on the test subsystem. The spinlock is
used as follows.
Before starting a test, a manager-station should make
sure that a test is not in progress as follows:
tryagain:
get (upsTestSpinLock)
while (upsTestResultsSummary == inProgress) {
/* loop while a test is running for another
manager */
short delay
get (upsTestSpinLock)
}
lockvalue = upsTestSpinLock
/* no test in progress, start the test */
set (upsTestSpinLock = lockvalue, upsTestId =
requestedtest)
if (errorindex == 1) { /* (upsTestSpinLock
failed) */
/* if problem is not access control, then
some other manager slipped in ahead of us
*/
goto tryagain
}
if (errorindex == 2) { /* (upsTestId) */
/* cannot perform the test */
give up
}
/* test started ok */
/* wait for test completion by polling
upsTestResultsSummary */
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
while (upsTestResultsSummary == inProgress) {
short delay
get (upsTestSpinLock, upsTestResultsSummary,
upsTestResultsDetail)
}
/* when test completes, retrieve any additional
test results */
/* if upsTestSpinLock == lockvalue + 1, then
these are our test */
/* results (as opposed to another manager's */
The initial value of upsTestSpinLock at agent
initialization shall
be 1.(*)
The results of the current or last UPS diagnostics
test performed. The values for donePass(1),
doneWarning(2), and doneError(3) indicate that the
test completed either successfully, with a warning, or
with an error, respectively. The value aborted(4) is
returned for tests which are aborted by setting the
value of upsTestId to upsTestAbortTestInProgress.
Tests which have not yet concluded are indicated by
inProgress(5). The value noTestsInitiated(6)
indicates that no previous test results are available,
such as is the case when no tests have been run since
the last reinitialization of the network management
subsystem and the system has no provision for non-
volatile storage of test results.(*)
The value of sysUpTime at the time the test in
progress was initiated, or, if no test is in progress,
the time the previous test was initiated. If the
value of upsTestResultsSummary is noTestsInitiated(6),
upsTestStartTime has the value 0.(*)
The amount of time, in TimeTicks, since the test in
progress was initiated, or, if no test is in progress,
the previous test took to complete. If the value of
upsTestResultsSummary is noTestsInitiated(6),
upsTestElapsedTime has the value 0.(*)
The system is placed on battery to a discharge level,
set by the manufacturer, sufficient to determine
battery replacement and battery run-time with a high
degree of confidence. WARNING: this test will leave
the battery in a low charge state and will require
time for recharging to a level sufficient to provide
normal battery duration for the protected load.(*)
This object determines the nature of the action to be
taken at the time when the countdown of the
upsShutdownAfterDelay and upsRebootWithDuration
objects reaches zero.
Setting this object to output(1) indicates that
shutdown requests should cause only the output of the
UPS to turn off. Setting this object to system(2)
indicates that shutdown requests will cause the entire
UPS system to turn off.(*)
Setting this object will shutdown (i.e., turn off)
either the UPS output or the UPS system (as determined
by the value of upsShutdownType at the time of
shutdown) after the indicated number of eighths, or
less if the UPS batteries become depleted. Setting
this object to 0 will cause the shutdown to occur
immediately. Setting this object to -1 will abort the
countdown. If the system is already in the desired
state at the time the countdown reaches 0, then
nothing will happen. That is, there is no additional
action at that time if upsShutdownType = system and
the system is already off. Similarly, there is no
additional action at that time if upsShutdownType =
output and the output is already off. When read,
upsShutdownAfterDelay will return the number of
eighths remaining until shutdown, or -1 if no shutdown
countdown is in effect. On some systems, if the agent
is restarted while a shutdown countdown is in effect,
the countdown may be aborted. Sets to this object
override any upsShutdownAfterDelay already in effect.(*)
Setting this object will start the output after the
indicated number of eighths, including starting the
UPS, if necessary. Setting this object to 0 will
cause the startup to occur immediately. Setting this
object to -1 will abort the countdown. If the output
is already on at the time the countdown reaches 0,
then nothing will happen. Sets to this object
override the effect of any upsStartupAfterDelay
countdown or upsRebootWithDuration countdown in
progress. When read, upsStartupAfterDelay will return
the number of eighths until startup, or -1 if no
startup countdown is in effect. If the countdown
expires during a utility failure, the startup shall
not occur until the utility power is restored. On
some systems, if the agent is restarted while a
startup countdown is in effect, the countdown is
aborted.(*)
Setting this object will immediately shutdown (i.e.,
turn off) either the UPS output or the UPS system (as
determined by the value of upsShutdownType at the time
of shutdown) for a period equal to the indicated
number of eighths, after which time the output will be
started, including starting the UPS, if necessary. If
the number of eighths required to perform the request
is greater than the requested duration, then the
requested shutdown and startup cycle shall be
performed in the minimum time possible, but in no case
shall this require more than the requested duration
plus 60 eighths. When read, upsRebootWithDuration
shall return the number of eighths remaining in the
countdown, or -1 if no countdown is in progress. If
the startup should occur during a utility failure, the
startup shall not occur until the utility power is
restored.(*)
Setting this object to 'on' will cause the UPS system
to restart after a shutdown if the shutdown occurred
during a power loss as a result of either a
upsShutdownAfterDelay or an internal battery depleted
condition. Setting this object to 'off' will prevent
the UPS system from restarting after a shutdown until
an operator manually or remotely explicitly restarts
it. If the UPS is in a startup or reboot countdown,
then the UPS will not restart until that delay has
been satisfied.(*)
The present state of the receptacle. Setting this
object to 'on' will cause the receptacle to be turned
on. Setting this object to 'off' will turn the
receptacle off. If the receptacle is already in the
desired state nothing will happen. After an
autorestart (see upsAutoRestart) the receptacle will
be on.
The operation mode off the UPS. Off-line indicates a
mode in which the input power is transferred to the
output directly or via a step-up or step-down
transformer. On-line mode indicates a mode in which
the output power is regenerated through some convertor.
the operating mode of the UPS may be fixed, or may be
selectable (e.g. an on-line UPS with ecomode)
The present state of the rectifier. Setting this
object to 'on' will cause the rectifier to be turned
on. Setting this object to 'off' will turn the
rectifier off. If the rectifier is already in the
desired state nothing will happen.
The present state of the charge method. Setting this
object to 'Normal charge' will cause the battery to be
charged using the normal method. Setting this object to
'Boost charge' will charge the battery in boost mode.
If the charge method is already in the desired state
nothing will happen.
The present state of the inverter. Setting this
object to 'on' will cause the inverter to be turned
on. Setting this object to 'off' will turn the
inverter off. If the inverter is already in the
desired state nothing will happen.
The present state of the bypass. Setting this
object to 'on' will cause the bypass to be activated.
Setting this object to 'off' will deactivate the
bypass. If the UPS is already in the
desired state nothing will happen.
The present source of the load. Setting this
object to 'On bypass' will cause the load to be
supplied by the bypass.
Setting this object to 'On inverter' will cause the
load to be supplied by the inverter.
If the load is already supplied by the desired
source nothing will happen.
The magnitude of the nominal input voltage. On those
systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal input frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The magnitude of the nominal output voltage. On
those systems which support read-write access to this
object, if there is an attempt to set this variable to
a value that is not supported, the request must be
rejected and the agent shall respond with an
appropriate error message, i.e., badValue for SNMPv1,
or inconsistentValue for SNMPv2.(*)
The nominal output frequency. On those systems which
support read-write access to this object, if there is
an attempt to set this variable to a value that is not
supported, the request must be rejected and the agent
shall respond with an appropriate error message, i.e.,
badValue for SNMPv1, or inconsistentValue for SNMPv2.(*)
The value of upsEstimatedMinutesRemaining at which a
lowBattery condition is declared. For agents which
support only discrete (discontinuous) values, then the
agent shall round up to the next supported value. If
the requested value is larger than the largest
supported value, then the largest supported value
shall be selected.(*)
The requested state of the audible alarm. When in
the disabled state, the audible alarm should never
sound. The enabled state is self-describing. Setting
this object to muted(3) when the audible alarm is
sounding shall temporarily silence the alarm. It will
remain muted until it would normally stop sounding and
the value returned for read operations during this
period shall equal muted(3). At the end of this
period, the value shall revert to enabled(2). Writes
of the value muted(3) when the audible alarm is not
sounding shall be accepted but otherwise shall have no
effect.(*)
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventSetStartingTimeStamp
will be used as the start value of the table with the lowest index number.
The number of events to retreive from the UPS event buffer.
When this object is set the EventTable will be filled with the
requested number of entries. The value upsEventLastTime will
be used as the last value of the table with the highest index number.
Returns SNMPNOSUCHNAME for UPSs that don't support this command.
A list of event table entries. The number of entries is always
10, and the value of upsEventTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..10)):
PDU-SET upsSetStartingTimeStamp
The status of the UPS at the moment that the event was generated.
The format is specified at the 'upsStatus' command.
If the UPS is not able to deliver status information, then
SNMPNOSUCHNAME is returned.
The number of parameters to retreive from the UPS.
When this object is set the ParameterTable will be filled with the
requested number of entries. The value upsParametersStartAddress
will be used as the start value of the table with the lowest index
number.
The number of parameters to write to the UPS.
When this object is set the ParameterTable will be send to the ups.
The value upsParametersStartAddress will be used for the eighth value
of the table with the lowest index number.
A list of parameter entries. The number of entries is always
16, and the value of upsParameterTableSize gives the number of valid
entries from the begging of the table. Invalid entries return 0.
To prevent problems with simultaneous queries from several agents,
these values MUST be accessed using several PDUs in the
same SNMP message ( is (1..16)):
Read sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParametersRead
PDU-GET upsParameterTableSize
PDU-GET upsParameterValue 1
PDU-GET upsParameterValue 2
..
PDU-GET upsParameterValue
The table is read up to requested number of events and the
management software afterwards decides which entries are
valid, as indicated by the upsParameterTableSize.
Write sequence:
PDU-SET upsSetStartingAddress
PDU-SET upsParameterValue 1
PDU-SET upsParameterValue 2
..
PDU-SET upsParameterValue
PDU-SET upsParametersWrite
The current timestamp (or real-time) of the UPS. For the format,
see 'Timestamp' specifications. The write-command has to comply with the
correct timestamp format expected by the UPS (counter value or real-time-clock
value). Missing to doing so will result in a SNMPeighthERROR,
meaning 'command not supported'. It is possible to know which is the timestamp
format supported by the UPS, by issuing a read-command or by reading events,
which includes timestamps.
A test is in progress, as initiated and indicated by
the Test Group. Tests initiated via other
implementation-specific mechanisms can indicate the
presence of the testing in the alarm table, if
desired, via a OBJECT-IDENTITY macro in the MIB
document specific to that implementation and are
outside the scope of this OBJECT-IDENTITY.
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
Bit oriented values associated to the ID of the UPS
(bit0 = UPS1 ... bit7 = UPS8).
The correspondent UPS is not present on the high speed
bus communication JA if bit=0.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
The critical components are associated to Service
parameters indicating the remaining lifetime.
They are initially set to default values depending
to the data given by the component supplier.
The parameter values decrease over time and when one
of them reaches zero (lifetime expiration) a service
check warning is generated, indicating that a check or
a replacement is suggested for that component.
The service technician is then required to re-set the
default value after the replacing of the component.(*)
