Ethernet & SNMP

Operator’s Guide
Ethernet & SNMP
Military Grade UninterrUptible power SUpply
UPS-1500-S-1U
UPS-1500-E-2U
Made in USA
Advancing The Power Curve
1.888.567.9596 (USA only) | SynQor Headquarters 155 Swanson Road, Boxborough, MA 01719-1316 USA |
®
www.synqor.com
UPS with Ethernet Interface Option
Contents
1
Overview ............................................................................................................................................... 2
2
Initial Configuration .............................................................................................................................. 2
3
4
2.1
DHCP Server .................................................................................................................................. 2
2.2
NetBIOS Hostname ....................................................................................................................... 2
2.3
Local Connection ........................................................................................................................... 2
Web Interface ....................................................................................................................................... 3
3.1
MONITOR Page ............................................................................................................................. 4
3.2
CONTROL Page .............................................................................................................................. 5
3.3
NETWORK Page ............................................................................................................................. 7
3.4
ALERTS Page .................................................................................................................................. 9
3.5
SNMP Page .................................................................................................................................. 10
3.6
DEBUG Page ................................................................................................................................ 13
SNMP Interface ................................................................................................................................... 14
4.1
SNMP Exposed Objects ............................................................................................................... 14
4.2
SNMP Traps ................................................................................................................................. 26
4/8/2015
Page 1 of 26
www.synqor.com
1 Overview
The Ethernet Interface Option on the SynQor UPS-1500 and UPS-3000 products adds a web interface
and an SNMP interface for control, configuration, and reporting. This guide provides information
regarding initial setup and functionality of the network interfaces.
The web interface provides a dynamically updated set of pages for user interaction. The SNMP interface
exposes the RFC-1628 standard UPS-MIB interface.
2 Initial Configuration
In order to facilitate connecting to the web interface, the UPS network interface provides multiple
methods to identify the UPS on the network. The user must load the web interface to enable or
configure the SNMP interface.
2.1 DHCP Server
The UPS network interface will recognize a DHCP server on the network and use the IP address assigned
by the server. A network administrator can register the MAC address of the network interface with the
DHCP server to assign the UPS to a static IP address. The MAC address can be read in two ways: (1) via
the RS232 serial command “NETWORK?”; and (2) via the web interface, assuming a connection is made
before the static IP address is assigned (see below).
Once a DHCP server assigns an IP address to the UPS, the web interface can be loaded by pointing a web
browser to the address http://x.x.x.x/, where “x.x.x.x” is the assigned IP address.
2.2 NetBIOS Hostname
The UPS network interface will use NetBIOS to advertise its hostname to the local network. The default
hostname is “SYNQORUPS”. If an IP address is assigned via a DHCP server and NetBIOS is permitted on
the local network, directing a browser on the network to http://synqorups/ or https://synqorups/ will
load the UPS web interface.
Once an initial connection is made to the web interface, the user should assign a unique hostname on
the Network tab (see below), so that the name does not interfere with other SynQor UPS devices on the
network.
2.3 Local Connection
The UPS network interface can connect to a host computer directly via an RJ-45 Ethernet cable. Either a
straight-through or crossover type cable can be used. In this mode, the web interface is available via the
address http://169.254.1.1/. The UPS implements its own DHCP server which will provide an IP address
on the 169.254 subnet to the host computer. Once a connection is established in this way, the user can
configure the default IP address and hostname as desired, as well as read the MAC address for the
purposes of assigning a static IP address.
4/8/2015
Page 2 of 26
www.synqor.com
3 Web Interface
The web interface provides a portal to monitor, control, and configure the UPS. Some of the
configuration options, such as those to setup the email and SNMP interfaces are only available through
the web interface. The interface will work well through any common web browser, though different
browsers may render with slight differences. The pages rely on Javascript to do continuous updates and
submit forms, so scripting must be enabled in the browser. Older browser versions may not support
some of the methods used.
Unsecured HTTP requests are processed at port 80. Secure SSL HTTPS requests are processed at port
443. SSL connections utilize encryption to protect data passed between the UPS and the browser from
snooping. Upon initiation of an SSL connection, the UPS will provide a Certificate to the browser to
verify its identity. The Certificate served will be a “self-signed” certificate, and the browser will warn
that the site is untrusted and request confirmation that you want to continue.
To avoid the warning message on future connections, use facilities in most browsers to mark the UPS
Certificate as a trusted certificate. Note that the certificate includes the NetBIOS name as the
“common-name” as part of its verification criteria, so the certificate is rebuilt after a change to the
NetBIOS name (Section 3.3.1). The browser verifies, and may enforce, that the name in the address bar
matches the common-name in the certificate. If a static IP address (e.g. https://20.1.1.24/) is used to
connect to the UPS, NetBIOS can be disabled and the hostname set to the fixed IP address (e.g.
20.1.1.24) to build a certificate with a common-name that matches the loaded address, avoiding a
browser security error.
SSL certificates specify a date range for validity. The web browser may or may not allow access if the
access date is outside the validity window. The certificates generated by the UPS have validity range
extending twenty years from the date of certificate generation. In order to force certificate
regeneration (and hence create a new validity window), change the NetBIOS name and then change it
back to the desired value. Times and dates used for the certificate are based on the SNTP time server,
see Section 3.3.4.
When SSL is used, the interface can be locked with a username and password, see Section 3.3.5.
The web interface can be disabled completely, see Section 3.3.6.
4/8/2015
Page 3 of 26
www.synqor.com
3.1 MONITOR Page
The Monitor page is the default page shown when you point the browser at the UPS with no page
specified. This page gives an overview of monitored parameters and configuration. The items that are
displayed vary based on the installed options. For example, if the UPS does not have the DC2 output
option installed, the DC2 output parameters will not appear.
Figure A Monitor Page of Web Interface
The Monitor page (as well as all other pages) has a flashing green dot in the top right of the title bar
which indicates that there is a connection to the UPS and the displayed data is continuously updated. If
the connection is broken, the dot will turn red to indicate stale data.
Figure B Status "LED" on Webpage Header
4/8/2015
Page 4 of 26
www.synqor.com
3.2 CONTROL Page
The Control page is the main page to use to interact with and configure the UPS. There is a small header
section at the top which actively updates to give the present configuration and operational state.
Actions available to interact with the UPS:








Enable and Disable the UPS Output
Silence Alarms (if active)
Run fan diagnostics
Manually set fan speed
Set unit to reboot the output after a designated off time
Set the unit to shutdown the output after a designated delay
Set the unit to enable the output after a designated delay
Abort a pending startup or shutdown delay
Configuration options available on the Control page are:





Set / clear alarms to permanent mute
Set / clear autostart option for automatic startup when power is applied
Disable automatic operation of fan diagnostics
Set system outputs to enable or disable with the main output (you might disable the AC output
while enabling the DC1 output or vice versa)
Set inverter output frequency to 50 / 60 /400 Hz
All actions taken on the Control page take effect immediately. The Configuration options are stored to
non-volatile memory. Note that the commands will be acknowledged on the serial interface just as if
they were entered through the serial interface.
4/8/2015
Page 5 of 26
www.synqor.com
Figure C Control Page in Web Interface
4/8/2015
Page 6 of 26
www.synqor.com
3.3 NETWORK Page
The Network page offers options to configure the UPS on the network. Changes on this page do not
take effect until the user presses the Apply button at the bottom of the page. Configuration changes are
stored in non-volatile memory. A status window at the top of the page shows the present configuration
on the network.
Figure D Network Configuration Status Pane
3.3.1 NETBIOS
NetBIOS is a protocol that allows a device to register a default hostname on the network. With this
hostname, a user can address a device without knowing the assigned IP address. By default, the UPS is
configured to register the hostname “SYNQORUPS”. The user has the option to disable NetBIOS, in
which case they would need the IP address assigned to the device to use the web interface. The IP
address could instead be assigned to a static address by the router based on the MAC address.
When the NetBIOS name changes, the UPS rebuilds the SSL Certificate that will be served to browsers
connecting to the web interface via an SSL (https://) connection.
3.3.2 ADDRESS RESOLUTION
DHCP is a protocol which allows the router to assign an IP address to a device on the network. By
default, DHCP is enabled and the UPS will be assigned an IP address by a service on the network. A
DHCP-assigned address has an expiration time (lease). The UPS will attempt to renew its DHCP lease
before it expires. When DHCP is disabled, the UPS reverts to the default IP address specified. In this
situation, the UPS will transmit DHCP discovery requests once per minute to determine if a DHCP host is
present on the network.
AutoIP is an alternate IP address assignment protocol. With AutoIP, the device starts using a particular
address and observes if there are any conflicts. By default, AutoIP is disabled, and DHCP is the
recommended address resolution protocol.
The Local DHCP Server option allows the UPS to hand out addresses over a local network, such as when
the UPS is directly connected to a computer’s Ethernet port. When this option is disabled, the UPS does
not respond to DHCP requests and the DHCP discovery requests are halted. The UPS will not respond to
DHCP requests if it detects that a DHCP server is present on the network.
4/8/2015
Page 7 of 26
www.synqor.com
3.3.3 DEFAULT ADDRESSES
If DHCP is not enabled or available, the UPS reverts to the default addresses entered here. The default
addresses are also used when the network interface first initializes and attempts to locate a DHCP
server. DHCP can be disabled if the device is assigned a static address by the network administrator.
3.3.4 TIME SERVER
If enabled, the UPS will poll a network timeserver to determine the actual clock-time. A dropdown
allows the user to select from a standard set of timer servers or enter a custom time server. The global
time is resynchronized every ten minutes.
The clock-time is used in reporting alerts via the email alert feature and the validity dates of generated
SSL Certificates.
3.3.5 AUTHENTICATION
The authentication feature locks the entire web interface, requiring the user to enter a username and
password to load the interface. You should only need to enter the username and password once for a
single browser session – the browser will retain the username and password and resend it with each
additional request in the session.
In order to protect the password, an SSL connection is required to enable authentication (and at all
times while using an authenticated connection).
3.3.6 WEB INTERFACE
The Enable Web Interface checkbox completely disables the device from responding to HTTP requests.
If this box is checked and the Apply button is activated, the interface is disabled and the setting is stored
in a non-volatile setting. The only way to restore the web interface in this case is to transmit the RS232
command NET RESTORE.
When the web interface is disabled, the device will still respond to SNMP commands. Because the
SNMP configuration is controlled through the web interface, if the desired configuration is with SNMP
active and HTTP disabled, the user must enable and configure SNMP before disabling the web interface.
3.3.7 RESTORE DEFAULTS
Network configuration settings (including the authentication password) can be restored to the factory
default values by transmitting the RS232 command “NET RESTORE”.
4/8/2015
Page 8 of 26
www.synqor.com
3.4 ALERTS Page
The Alerts page gives the user the ability to setup email transmissions for selected alarm conditions.
The email engine uses SMTP, so the user must provide the address of an SMTP server to transmit the
messages. The SMTP server will then decode the email addresses and route the messages accordingly.
If no SMTP server is entered, the UPS will attempt to send the message via the domain of the email user
selected.
Select any items from the list of alarm conditions desired to initiate an email transmission.
Alert configuration is stored in non-volatile memory after the “Save Settings” button is pressed. The
“Send Test Email” button can be used to send a test message to the designated address before
modifying the configuration with the “Save Settings” button.
Email / alert configuration settings can be restored to the factory default values by transmitting the
RS232 command “EMAIL RESTORE”.
Figure E Configure Email Alerts
Figure F Test Email Message Example
4/8/2015
Page 9 of 26
www.synqor.com
3.5 SNMP Page
The SNMP page configures the SNMP Interface (see section 0). The UPS currently supports SNMPv1,
SNMPv2, and SNMPv3 messages. SNMPv3 includes options for encryption and authentication of
messages. If authentication is required for the SNMP interface, it is highly recommended that the web
interface also utilize authentication, see Section 3.3.5. Despite security on the SNMP interface, a
malicious actor could simply connect to the UPS via the web interface if the web interface is left
unsecured.
By default, the SNMP interface is not enabled, and must be explicitly enabled via the web interface on
the SNMP Configuration Pane (see Figure G).
All changes on this page are stored in non-volatile memory when the appropriate Apply button is
pressed.
Figure G SNMP Configuration Pane
3.5.1 Communities
SNMP v1 and v2 messages are authenticated by a community name. The interface allows the user to set
up three different read and write communities. Write communities are also given read access. The
community assigned in the UPS web interface must also be entered on the SNMP monitoring host which
will communicate with the UPS.
Community names are not encrypted within SNMP transmissions, so SNMPv1 and SNMPv2 communities
offer only very loose security. Community names can be read directly via examination of packets on the
network. To disable SNMPv1 and SNMPv2 access, do not enter any community names in the
configuration pane.
4/8/2015
Page 10 of 26
www.synqor.com
3.5.2 SNMPv3 Access Control
SNMP v3 messages reference a user which must be defined on the target device (the UPS). The
messages may contain authentication or authentication with encryption. An authenticated message
contains a password which establishes the identity of the user, but the contents of the message are
readable to other devices on the network. A message with authentication and encryption establishes
the identity of the user and the message itself is encrypted to prevent protect the content of the
message.
Using the SNMP Configuration Pane (see Figure G), you can configure whether the UPS will require
either authentication or encryption to allow access to elements of the MIB via SNMP. Separate access
control parameters can be set for the System MIB objects and the UPS MIB objects. The System MIB
objects reference network parameters, such as access errors, device up-time, and network identification
variables. The UPS MIB objects reference parameters related to the operation of the UPS.
3.5.3 SNMPv3 Users
The UPS allows the definition of up to three different users for the purposes of SNMP v3 access. For
each user, a separate password can be entered for authentication (access control) and encryption
(message privacy). For authentication purposes, a choice is offered between MD5 and SHA1 hashing of
the authentication password. Note that even if authentication and encryption passwords are defined
for a user, SNMP v3 will still allow a monitoring device to send an unauthenticated or unencrypted
message referencing that user name. The access control for the UPS reporting and control must be set
separately, see Section 3.5.2.
Figure H SNMP v3 User Setup Pane
4/8/2015
Page 11 of 26
www.synqor.com
3.5.4 SNMP Trap Receivers
An SNMP “Trap” is a message sent from the device (agent) to a monitoring computer. Traps that the
UPS will generate are listed in Section 0. In general, the messages alert the monitoring computer of
alarm conditions so that polling is not required to determine when action needs to be taken. The UPS
allows the user to configure up to two receivers for UPS traps.
The hostname of the trap receiver can either be the fully qualified domain name of the computer to
receive the traps, or the fixed IP address of the computer. Traps can be sent either via the SNMP v2
message format or the SNMP v3 message format.
SNMP v2 traps have their own community that must be recognized by the receiver. Enter a community
name recognized by the receiver to transmit with the trap.
SNMP v3 traps are sent with the credentials of a user defined in the UPS. Select one of the three users
defined in the UPS to associate with the trap message. SNMP v3 traps can also be sent with either
authentication or authentication and encryption. Select the desired check boxes to protect the trap
message contents.
Figure I SNMP Trap Receiver Configuration Pane
3.5.5 RESTORE DEFAULTS
SNMP configuration settings can be restored to the factory default values by transmitting the RS232
command “SNMP RESTORE”.
4/8/2015
Page 12 of 26
www.synqor.com
3.6 DEBUG Page
The Debug page does not have a link from the other pages. Select the Debug page by loading
http://synqorups/debug.htm (substitute “syqnorups” for the selected hostname or IP address). The
debug page provides a scrollable mirror of the RS232 serial interface. The user can also transmit ‘virtual’
serial commands by entering the commands and clicking the Send button.
Note that the debug.htm form should only be accessed from a single browser at a time. If two browsers
simultaneously view the page, the output pane will not display accurately.
Figure J debug.htm Serial Interface Mirror
4/8/2015
Page 13 of 26
www.synqor.com
4 SNMP Interface
The SNMP interface exposes the industry standard RFC-1628 UPS Management Information Base (MIB).
This guide is not meant to provide a description of the SNMP protocol or recommendations for software
to be installed on any monitoring computer.
By default, the SNMP Agent in the UPS network interface is disabled, and it must be enabled via the web
interface SNMP page (see Section 0). Enter a community for read and write operations, and enter these
same community names on the monitoring device along with the device IP address.
The UPS SNMP Agent will recognize SNMP v1 and SNMP v2 formatted messages. Transmitted traps use
the SNMP v2 format, per the RFC-1628 specification. (SNMP v3 messages use the same format as SNMP
v2 messages, with the addition of authentication and encryption.)
4.1 SNMP Exposed Objects
In the following list of objects exposed by the SynQor UPS, the Object ID references the upsObjects
prefix, which has the address 1.3.6.1.2.1.33.1.
4.1.1 upsIdent Group
Object Name: upsIdentManufacturer
OID: upsObjects.1.1
Type: String
Access: Read-Only
Returns “SynQor Inc.”
Object Name: upsIdentModel
OID: upsObjects.1.2
Type: String
Access: Read-Only
Returns the SynQor assigned full model number for this device.
Object Name: upsIdentUPSSoftwareVersion
OID: upsObjects.1.3
Type: String
Access: Read-Only
Object returns a summary of the code revisions of the modules internal to the UPS: Mother Board, ac/dc
Primary, ac/dc Secondary, and dc/ac Inverter.
4/8/2015
Page 14 of 26
www.synqor.com
Object Name: upsIdentAgentSoftwareVersion
OID: upsObjects.1.4
Type: String
Access: Read-Only
Object returns the SynQor assigned code revision of the communications card implementing the
network interface.
Object Name: upsIdentName
OID: upsObjects.1.5
Type: String
Access: Read-Write
This field is a user assignable name available to identify this device. Default value is blank.
Object Name: upsIdentAttachedDevices
OID: upsObjects.1.6
Type: String
Access: Read-Write
This field is a user assignable string available to identify this device. Default value is blank.
4.1.2 upsBattery Group
Object Name: upsBatteryStatus
OID: upsObjects.2.1
Type: Integer, {unknown=1, batteryNormal=2, batteryLow=3, batteryDepleted=4}
Access: Read-Only
This object returns the status of the installed battery. The “batteryLow” status is determined by
comparing the projected runtime at the present load to the value stored in the “upsConfigLowBattTime”
object.
Object Name: upsSecondsOnBattery
OID: upsObjects.2.2
Type: Integer
Access: Read-Only
Object value is the number of seconds the UPS has been running on battery; value is zero if the UPS is
not currently running from battery power.
Object Name: upsEstimatedMinutesRemaining
OID: upsObjects.2.3
Type: Integer
Access: Read-Only
Object value is the current estimate of the time the battery could support the present load based on the
current battery charge level.
4/8/2015
Page 15 of 26
www.synqor.com
Object Name: upsEstimatedChargeRemaining
OID: upsObjects.2.4
Type: Integer
Access: Read-Only
Object value is the estimate of the battery charge remaining, expressed as a percentage of the estimate
of the fully charged battery capacity.
Object Name: upsBatteryVoltage
OID: upsObjects.2.5
Type: Non-negative Integer
Access: Read-Only
Object returns the battery voltage expressed in tenths of volts.
Object Name: upsBatteryCurrent
OID: upsObjects.2.6
Type: Integer
Access: Read-Only
Value returned is the present battery current, expressed in tenths of amps. A negative current
represents a discharge current. A positive current represents a current charging the battery.
Object Name: upsBatteryTemperature
OID: upsObjects.2.7
Type: Integer
Access: Read-Only
Object value is a reading of the battery internal temperature. Units are degrees Celsius.
4.1.3 upsInput Group
Object Name: upsInputLineBads
OID: upsObjects.3.1
Type: Counter32
Access: Read-Only
Object returns the count of times an input voltage transitions from good to bad. In a UPS with two
inputs (for example AC input and DC input), a transition from a good value to a bad value on either input
will increment the count.
Object Name: upsInputNumLines
OID: upsObjects.3.2
Type: Non-negative Integer
Access: Read-Only
Object reports the number of inputs installed on this UPS.
4/8/2015
Page 16 of 26
www.synqor.com
4.1.3.1 upsInputTable
The upsInputTable object (upsObjects.3.3) contains a single entry for each input installed in the device.
Each entry contains up to four fields, as listed here.
Object Name: upsInputFrequency
OID: upsObjects.3.3.1.2
Type: Non-negative Integer
Access: Read-Only
Object returns the measured frequency from this input source in tenths of Hertz. A DC input will return
a value of 0.
Object Name: upsInputVoltage
OID: upsObjects.3.3.1.3
Type: Non-negative Integer
Access: Read-Only
Object returns the measured input voltage of this source. AC input sources return the RMS input
voltage in units of volts. DC input sources return the voltage in units of tenths of volts.
Object Name: upsInputCurrent
OID: upsObjects.3.3.1.4
Type: Non-negative Integer
Access: Read-Only
Object returns the measured input current of an AC input in units of tenths of Amps RMS. Object does
not exist for table entries of DC input sources. The DC input of the UPS does not have a dedicated input
current measurement.
Object Name: upsInputTruePower
OID: upsObjects.3.3.1.5
Type: Non-negative Integer
Access: Read-Only
Object returns the measured true input power an AC input in units of Watts. Object does not exist for
table entries associated with DC input sources.
4.1.4 upsOutput Group
Object Name: upsOutputSource
OID: upsObjects.4.1
Type: Integer, {other=1, none=2, normal=3, bypass=4, battery=5, booster=6, reducer=7}
Access: Read-Only
Object returns the present source of output power. If the output is not presently on, the value returned
will be 2 (none). If the output is enabled and running from AC or DC input power, the value returned
4/8/2015
Page 17 of 26
www.synqor.com
will be 3 (normal). When running from battery power, the value returned will be 5 (battery). The other
enumeration values are unused by the SynQor Agent.
Object Name: upsOutputFrequency
OID: upsObjects.4.2
Type: Non-negative Integer
Access: Read-Only
Object returns the present frequency setpoint of any AC outputs. Value reported is in tenths of Hertz.
Object is valid whether the output is enabled or not. Output frequency can be modified with the
upsConfigOutputFreq object.
Object Name: upsOutputNumLines
OID: upsObjects.4.3
Type: Non-negative Integer
Access: Read-Only
Object returns the number of outputs installed in the UPS device.
4.1.4.1 upsOutputTable
The upsOutputTable object (upsObjects.4.4) contains an entry for each output installed in the UPS
device. Each output contains up to four fields, as listed here.
Object Name: upsOutputVoltage
OID: upsObjects.4.4.1.2
Type: Non-negative Integer
Access: Read-Only
Object returns the output voltage of the corresponding UPS output in units of Volts. Certain output
types (for example the DC1 option) do not provide output voltage readback, and this object will not be
available for those outputs.
Object Name: upsOutputCurrent
OID: upsObjects.4.4.1.3
Type: Non-negative Integer
Access: Read-Only
Object returns the output current of the corresponding UPS output in units of tenths of Amps RMS.
Certain output types (for example the DC1 option) do not provide output current readback, and this
object will not be available for those outputs.
Object Name: upsOutputPower
OID: upsObjects.4.4.1.4
Type: Non-negative Integer
Access: Read-Only
Object returns the output voltage of the corresponding UPS output in units of Watts.
4/8/2015
Page 18 of 26
www.synqor.com
Object Name: upsOutputPercentLoad
OID: upsObjects.4.4.1.5
Type: Non-negative Integer
Access: Read-Only
Object returns the percent output load as a percentage of full rated power of the UPS. For AC outputs,
the returned value is the greater of the percent output load and the percent output VA.
4.1.5 upsBypass Group
The upsBypass group is not implemented by the SynQor UPS SNMP Agent because the UPS models do
not contain internal bypass devices.
4.1.6 upsAlarm Group
Object Name: upsAlarmsPresent
OID: upsObjects.6.1
Type: Non-negative Integer
Access: Read-Only
Object returns the total number of active alarms in the upsAlarmsTable.
4.1.6.1 upsAlarmTable
The upsAlarmTable (upsObjects.6.2) contains an entry for each active alarm condition. Any given alarm
condition will only appear in the table once.
Object Name: upsAlarmDescr
OID: upsObjects.6.2.1.2
Type: OID (object identifier)
Access: Read-Only
Object returns the object identifier for the alarm condition represented by a given entry in the Alarm
table. For example, a low battery condition would be identified with the upsAlarmOnBattery OID of
1.3.6.1.2.1.33.1.6.3.2. The list of possible alarm conditions is defined in the RFC-1628 group
upsWellKnownAlarms.
Object Name: upsAlarmTime
OID: upsObjects.6.2.1.3
Type: Timestamp
Access: Read-Only
Object returns the timestamp that the given alarm condition was first detected. The timestamp is the
value of the sysUpTime object (1.3.6.1.2.1.1.3) at the time of detection.
4.1.7 upsTest Group
The upsTest group provides an interface to launch self-tests of the UPS hardware. To initiate a test, the
monitoring computer must execute a write instruction which includes both the upsTestId object and the
upsTestSpinLock object. The OID of the desired test sequence is written to upsTestId. The value written
4/8/2015
Page 19 of 26
www.synqor.com
to upsTestSpinLock must be the present value read from upsTestSpinLock. The spin-lock provides a
semaphore, allowing only one device to launch a self-test sequence at a time. Once a test sequence
completes, the upsTestSpinLock variable increments by one.
Object Name: upsTestId
OID: upsObjects.7.1
Type: OID (object identifier)
Access: Read-write
This object identifies the test in progress or last completed. As described above, to initiate a test a
single PDU write must be issued to upsTestId and upsTestSpinLock. To abort a test in progress, send the
OID upsTestAbortTestInProgress (1.3.6.1.2.1.33.1.7.7.2). Valid OIDs for self-test sequences are defined
by the upsWellKnownTests group. The three test options are upsTestGeneralSystemsTest,
upsTestQuickBatteryTest, and upsTestDeepBatteryCalibration. The UPS output must be enabled for
these tests to return a passing result. The upsTestDeepBatteryCalibration sequence discharges the
battery to 20% charge to determine runtime; the test time will vary strongly based on the load
configuration.
Object Name: upsTestSpinLock
OID: upsObjects.7.2
Type: Test-and-Increment
Access: Read-write
To initiate a test, the monitoring computer must read this object value, and return the present value
along with a valid OID for upsTestId. The value of this object increments after a self-test completes.
Object Name: upsTestResultsSummary
OID: upsObjects.7.3
Type: Integer, {done/pass=1, done/warning=2, done/error=3, aborted=4, in progress=5, no test
initiated=6}
Access: Read-Only
This object returns a summary of the result of a previously initiated self-test routine.
Object Name: upsTestResultsDetail
OID: upsObjects.7.4
Type: String
Access: Read-Only
Value of this object is a string describing the result of the last self-test routine. If the test ended with an
error or warning, the string will describe the error or warning.
Object Name: upsTestStartTime
OID: upsObjects.7.5
Type: Timestamp
Access: Read-Only
4/8/2015
Page 20 of 26
www.synqor.com
Object returns the value of the sysUpTime object (1.3.6.1.2.1.1.3) at the time the previous self-test was
initiated.
Object Name: upsTestElapsedTime
OID: upsObjects.7.6
Type: Time-interval
Access: Read-Only
Object returns the elapsed running time of the previous self-test.
4.1.8 upsControl Group
Object Name: upsShutdownType
OID: upsObjects.8.1
Type: Integer, {output = 1, system = 2}
Access: Read-Only
For the SynQor UPS, all commanded shutdowns disable the outputs, and do not power-down the UPS
hardware. This object will always return a value of 1, indicating output-shutdown.
Object Name: upsShutdownAfterDelay
OID: upsObjects.8.2
Type: Integer
Access: Read-write
A write to this object will initiate a shutdown of the UPS outputs after the designated number of
seconds. A write of the value 0 will cause the UPS outputs to shutdown immediately. A write of -1 will
abort a pending shutdown.
Object Name: upsStartupAfterDelay
OID: upsObjects.8.3
Type: Integer
Access: Read-write
A write to this object will initiate a startup of the UPS outputs after the designated number of seconds.
A subsequent write of -1 will abort the timer. A write of the value 0 will cause the UPS outputs to start
immediately.
Object Name: upsAutoRestart
OID: upsObjects.8.4
Type: Integer, {on=1, off=2}
Access: Read-write
The auto-restart feature will automatically enable the UPS outputs when the device receives input
power from a powered-off state. This feature is disabled by default. A write of the value 1 to this object
will enable the auto-restart feature. The setting is stored in non-volatile memory.
4/8/2015
Page 21 of 26
www.synqor.com
4.1.9 upsConfig Group
Object Name: upsConfigInputVoltage
OID: upsObjects.9.1
Type: Non-negative Integer
Access: Read-Only
Object returns the nominal designed input voltage of the device. The SynQor UPS is a universal input
device (115/230V) and this object will always return the value 115.
Object Name: upsConfigInputFreq
OID: upsObjects.9.2
Type: Non-negative Integer
Access: Read-Only
Object returns the nominal designed input frequency of the device. This object will always return the
value 600, representing 60Hz.
Object Name: upsConfigOutputVoltage
OID: upsObjects.9.3
Type: Non-negative Integer
Access: Read-Only
Object returns the nominal designed output voltage of the device. It will return either 115 or 230,
depending on the particular UPS model.
Object Name: upsConfigOutputFreq
OID: upsObjects.9.4
Type: Non-negative Integer
Access: Read-write
Object sets or returns the output frequency of the device. Allowable values are 500, 600, or 4000,
representing 50Hz, 60Hz, and 400Hz respectively.
Object Name: upsConfigOutputVA
OID: upsObjects.9.5
Type: Non-negative Integer
Access: Read-Only
Object returns the Volt-Amp rating of the UPS device, in units of Volts·Amps.
Object Name: upsConfigOutputPower
OID: upsObjects.9.6
Type: Non-negative Integer
Access: Read-Only
Object returns the rated power of the UPS device, in units of Watts.
4/8/2015
Page 22 of 26
www.synqor.com
Object Name: upsConfigLowBattTime
OID: upsObjects.9.7
Type: Non-negative Integer
Access: Read-write
Object sets or returns the threshold for low-battery alerts and traps in units of minutes. Alerts trigger
based on the estimated run time at the present device load current and battery capacity calculations.
Object Name: upsConfigAudibleStatus
OID: upsObjects.9.8
Type: Integer, {disabled=1, enabled=2, muted=3}
Access: Read-write
Object returns or sets the state of the audible alarms.
 A read value of 1 indicates that audible alarms are disabled and will never be triggered.
 A read value of 2 indicates that audible alarms are enabled (default state)
 A read value of 3 indicates that an audible alarm is currently active, but has been muted by a
user action.
 A write value of 1 will disable audible alarms (non-volatile setting)
 A write value of 2 will enable audible alarms (non-volatile setting)
 A write value of 3 will mute an audible alarm if one is currently active. If a new alarm condition
triggers, the audible alarm will resume.
Object Name: upsConfigLowVoltageTransferPoint
OID: upsObjects.9.9
Type: Non-negative Integer
Access: Read-Only
Object returns the value 85Vrms. The actual transfer point from AC input to DC input or battery power
will vary based on the applied load, as described in the UPS Operator’s Guide.
Object Name: upsConfigHighVoltageTransferPoint
OID: upsObjects.9.10
Type: Non-negative Integer
Access: Read-Only
Object returns the maximum rated line voltage of the AC input, 265Vrms.
4.1.10 Non-UPS MIB Objects
The UPS also exposes a number of objects defined in the SNMPv2 MIB.
Object Name: sysDescr
OID: 1.3.6.1.2.1.1.1
Type: String
Access: Read-Only
4/8/2015
Page 23 of 26
www.synqor.com
Object returns the SynQor model number of this UPS device. The value returned by this object is
identical to that returned by the upsIdentModel object.
Object Name: sysObjectID
OID: 1.3.6.1.2.1.1.2
Type: OID
Access: Read-Only
Object returns the object identifier of the UPS MIB, 1.3.6.1.2.1.33.
Object Name: sysUpTime
OID: 1.3.6.1.2.1.1.3
Type: Timeticks
Access: Read-Only
Object returns the time-ticks value since the network interface first powered up.
Object Name: sysContact
OID: 1.3.6.1.2.1.1.4
Type: String
Access: Read-Write
Object provides a user-settable string to enter contact information for management of this device. The
default value is an empty string.
Object Name: sysName
OID: 1.3.6.1.2.1.1.5
Type: String
Access: Read-Write
Object provides a user-settable string to enter an identifier for this device. The value returned by this
object is identical to that returned by the upsIdentName object.
Object Name: sysLocation
OID: 1.3.6.1.2.1.1.6
Type: String
Access: Read-Write
Object provides a user-settable string to enter an identifier for this device. The value returned by this
object is identical to that returned by the upsIdentAttachedDevices object.
Object Name: sysServices
OID: 1.3.6.1.2.1.1.7
Type: Integer
Access: Read-Only
Object returns the value 64, indicating the UPS SNMP agent provides applications services.
4/8/2015
Page 24 of 26
www.synqor.com
Object Name: snmpEnableAuthenTraps
OID: 1.3.6.1.2.1.11.30
Type: Integer, {enabled=1, disabled=2}
Access: Read-Write
This object sets or returns whether the UPS Agent should transmit authenticationFailure traps when
receiving SNMP messages with an incorrect community string. This setting is stored in non-volatile
memory, and the default setting is enabled.
Object Name: snmpEngineID
OID: 1.3.6.1.6.3.10.2.1.1
Type: Octet String
Access: Read-Only
This is the uniquely defined snmpEngineID used for SNMP v3 identification and localization. This object
is only accessible when using SNMP v3 messages.
Object Name: snmpEngineBoots
OID: 1.3.6.1.6.3.10.2.1.2
Type: Integer
Access: Read-Only
This is the number of times the SNMP engine has booted. This parameter is used for SNMP v3 message
authentication. Message authentication requires messages include the proper snmpEngineBoots
parameter from the target device to prevent message replay attacks. This object is only accessible when
using SNMP v3 messages.
Object Name: snmpEngineTime
OID: 1.3.6.1.6.3.10.2.1.3
Type: Integer
Access: Read-Only
This is the times since the SNMP engine last booted. This parameter is used for SNMP v3 message
authentication. Message authentication requires messages include a recent snmpEnginetime parameter
(within the last 150 seconds) from the target device to prevent message replay attacks. This object is
only accessible when using SNMP v3 messages.
Object Name: snmpEngineMaxMessageSize
OID: 1.3.6.1.6.3.10.2.1.4
Type: Integer
Access: Read-Only
This is maximum messages size (in bytes) that can be sent or received by the UPS SNMP engine. This
object is only accessible when using SNMP v3 messages.
4/8/2015
Page 25 of 26
www.synqor.com
4.2 SNMP Traps
The SynQor UPS SNMP Agent will issue SNMP traps as defined in the RFC-1628 UPS MIB. The agent will
also issue an authentication failure trap when addressed with an incorrect community name. In order
for traps to be transmitted, the SNMP interface must be enabled as described in Section 0, and the
hostname or IP address of the intended trap-receiver computers must also be configured as described in
Section 0.
4.2.1 upsTrapOnBattery Trap
The upsTrapOnBattery trap (OID = 1.3.6.1.2.1.33.2.1) issues when the UPS is running from battery
power. The trap includes the estimated runtime remaining, the number of seconds the UPS has been
running on battery, and the value of the upsConfigLowBattTime alert warning level. This trap will reissue at one minute intervals until power is restored on the battery capacity is depleted.
4.2.2 upsTrapTestCompleted Trap
The upsTrapTestCompleted trap (OID = 1.3.6.1.2.1.33.2.2) issues after a user-initiated self-test sequence
completes within the UPS. The trap data includes all objects in the upsTest group, providing a summary
of the test results.
4.2.3 upsTrapAlarmEntryAdded Trap
The upsTrapAlarmEntryAdded trap (OID = 1.3.6.1.2.1.33.2.3) issues every time a new alarm entry is
added to the upsAlarmTable table. Two exceptions are that there is no notification for the
upsAlarmOnBattery or upsAlarmTestInProgress alarms. The trap data includes the index of the new
entry and the OID of the alarm description.
4.2.4 upsTrapAlarmEntryRemoved Trap
The upsTrapAlarmEntryRemoved trap (OID = 1.3.6.1.2.1.33.2.4) issues whenever an entry is removed
from the upsAlarmTable table. This means that the specified alarm condition is no longer active. One
exception is that there is no trap issued when the upsAlarmTestInProgress alarm clears. The trap data
includes the index of the entry removed and the description of the alarm.
4.2.5 authenticationFailure Trap
The authenticationFailure trap (OID = 1.3.6.1.6.3.1.1.5.5) issues when the UPS SNMP agent receives an
improperly authenticated message. For SNMPv1 and SNMPv2 message, this means that an
unrecognized community value was included in the message. This trap will not be retransmitted more
frequently than once per second. The authenticationFailure trap may be suppressed by setting the
snmpEnableAuthenTraps object (OID = 1.3.6.1.2.1.11.30).
4/8/2015
Page 26 of 26
www.synqor.com
Operator’s Guide
Ethernet & SNMP
Military Grade UninterrUptible power SUpply
Made in USA
006-0006503 Apr 8, 2015 Rev F
Advancing The Power Curve
1.888.567.9596 (USA only) | SynQor Headquarters 155 Swanson Road, Boxborough, MA 01719-1316 USA |
®
www.synqor.com