SNMP Data Points
The tables below describe the PowerChute configuration details that are available for SNMP polling and/or configuration.
PowerChute Identity Information
|
Object Identifier Name |
Access |
Description |
|
pcnshostname |
read-only |
The hostname of the PowerChute instance. |
|
pcnsVersion |
read-only |
The version of PowerChute installed. |
|
pcnsOS |
read-only |
The version of the Operating System upon which PowerChute is installed. |
|
pcnsJavaVersion |
read-only |
The version of Java upon which PowerChute is running. |
PowerChute Networking Settings
|
Object Identifier Name |
Access |
Description |
| pcnsUIProtocol |
read-only |
The web protocol that is used to connect to the PowerChute web user interface. |
|
pcnsHttpPort |
read-only |
The port that is used to connect to the PowerChute web user interface. |
|
pcnsHttpsPort |
read-only |
The port that is used to connect via https to the PowerChute web user interface. |
|
pcnsNetworkConfig |
read-only |
Configuration of the TCP network: IPv4/IPv6. |
|
pcnsVirtualInstall |
read-only |
The Virtualization technology for which PowerChute is configured. |
PowerChute Network Management Card Settings
|
Object Identifier Name |
Access |
Description |
|
pcnsMode |
read-only |
The configuration of the UPSs that PowerChute is monitoring. See UPS Configuration Options. |
|
pcnsNMCPort |
read-only |
The port used to connect to all of the Network Management Card(s). |
|
pcnsNMCProtocol |
read-only |
The web protocol used to connect to all of the Network Management Card(s). |
|
NMC details are contained in an SNMP table named pcnsNmcTable. Each table entry contains: |
||
|
pcnsNMCIndex |
read-only |
The Index of the NMC within the PowerChute setup. |
|
pcnsNMCAddr |
read-only |
The IP address of the NMC |
|
pcnsNMCOutlet |
read-only |
The Outlet Group of the NMC on which PowerChute is enrolled. |
PowerChute Shutdown Settings
|
Object Identifier Name |
Access |
Description |
|
pcnsShutdownCommandFileEnabled* |
read-write |
Specify if Shutdown a Command File is configured to run if a UPS critical event is triggered. See Shutdown Command Files. |
|
pcnsShutdownCommandFileDelay* |
read-write |
The number of seconds that a host requires to shut down, before the command file is executed. This setting is applicable to virtualization support only. |
|
pcnsShutdownCommandFile* |
read-write |
The full path name of the command file, including the disk drive or volume name. See Shutdown Command Files. |
|
pcnsShutdownCommandFileDuration* |
read-write |
The number of seconds that the shutdown command file requires to execute. |
|
pcnsTurnOffUps* |
read-write |
The setting to turn off the UPS after performing a graceful shutdown. |
|
pcnsTurnOffSOG* |
read-write |
The setting to turn off the Outlet Group of the UPS when performing a graceful shutdown. |
|
pcnsRuntimeRemainingThreshold |
read-write |
This defines a threshold for runtime remaining. When the UPS in running on battery power and the runtime remaining on the UPS drops below the threshold, PowerChute triggers a shutdown sequence. See Sequenced Server Shutdown for more information. |
|
pcnsRuntimeRemainingCmdFileThreshold |
read-write |
This defines a threshold for runtime remaining. When runtime remaining drops below this threshold, PowerChute executes the command file. |
| * Note: These OIDs are not available for Advanced UPS Setups. See below for equivalent OIDs for Advanced UPS Setups. | ||
Shutdown Settings for Advanced UPS Setups
The PowerChute Shutdown Settings for Advanced UPS Setups are contained in an SNMP Table named pcnsAdvancedShutdownTable. To SNMP GET or SET a property of a specific Advanced UPS Configuration, you must specify the group number of the UPS Setup in the GET or SET command. To see a list of UPS Setups and their associated numbers, perform an SNMP Get on.pcnsAdvancedGroupName
To perform an SNMP GET or SET command on each UPS Setup is, use the format.[Object Identifier Name].[UPS Setup Number]
For example, to specify that a command file is configured for the first UPS Setup, the perform an SNMP SET on.pcnsAdvancedShutdownCommandFileEnabled.1
|
Object Identifier Name |
Access |
Description |
|
pcnsAdvancedGroupNo |
read-only |
The number of the Advanced UPS Setup. |
|
pcnsAdvancedGroupName |
read-write |
The name of the Advanced UPS Setup. |
|
pcnsAdvancedGroupNMC |
read-only |
A list of IP addresses of the NMCs in the Advanced UPS Setup, and the outlets in the associated outlet groups. |
|
pcnsAdvancedShutdownUPSRequiredForLoad |
read-write |
The number of UPS devices required to power the load. |
|
pcnsAdvancedShutdownCommandFileEnabled |
read-write |
Specify if a Shutdown Command File is configured to run if a UPS critical event is triggered. See Shutdown Command Files. |
|
pcnsAdvancedShutdownCommandFile |
read-write |
The full path name of the command file, including the disk drive or volume name. See Shutdown Command Files. |
|
pcnsAdvancedShutdownCommandFileDuration |
read-write |
The number of seconds that the shutdown command file requires to execute. |
|
pcnsAdvancedShutdownPowerchuteServer |
read-write |
The setting to gracefully shut down the physical machine running PowerChute. See Shutdown Settings for Advanced UPS Configurations. |
|
pcnsAdvancedShutdownOnLostRedundancy |
read-write |
If this option is enabled, when the number of UPS critical events is the same as the number of additional (redundant) UPS’s, a shutdown sequence will be triggered. See Shutdown Settings for Advanced UPS Configurations. |
|
pcnsAdvancedTurnOffUps |
read-write |
The setting to turn off the UPS when performing a graceful shutdown. |
|
pcnsAdvancedTurnOffSOG |
read-write |
The setting to turn off the Outlet Group of the UPS when performing a graceful shutdown. |
PowerChute Events
The table below details the OID Names of the Configurable Events that can be configured via SNMP, and the names of the Events as seen in the PowerChute User Interface.
|
Object Identifier Name |
PowerChute UI Reference |
|
pcnsPowerFailed |
UPS On Battery |
|
pcnsPowerRestored |
Input Power Restored |
|
pcnsOverload |
UPS Overloaded |
|
pcnsOverloadSolved |
UPS Overload Corrected |
|
pcnsRunTimExceeded |
Runtime exceeded |
|
pcnsRunTimeWithinRange |
Runtime is sufficient |
|
pcnsRunTimeBelowThreshold |
Runtime remaining below threshold |
|
pcnsRunTimeAboveThreshold |
Runtime remaining above threshold |
|
pcnsBatteryDischarged |
Battery Discharged |
|
pcnsBatteryChargeInRange |
Battery Recharged |
|
pcnsFaultBypassEnabled |
Bypass due to hardware error or overload |
|
pcnsBypassEnabled |
Maintenance Bypass |
|
pcnsBypassManualEnabled |
Bypass ended |
|
pcnsBypassDisabled |
Bypass ended |
|
pcnsBypassContactorFailed |
Bypass Switch failed |
|
pcnsBypasContactorOk |
Bypass Switch replaced |
|
pcnsCommunicationLostOnBattery |
Communication lost while on Battery |
|
pcnsCommunicationLost |
NMC cannot communicate with the UPS |
|
Object Identifier Name |
PowerChute UI Reference |
|
pcnsNetCommunicationLost |
PowerChute cannot communicate with the NMC |
|
pcnsCommunicationEstablished |
Communication established |
|
pcnsMinRedundancyLost |
Minimum Redundancy lost |
|
pcnsMinRedundancyRegained |
Minimum Redundancy restored |
|
pcnsParallelRedundancyLost |
Parallel Redundancy lost |
|
pcnsParallelRedundancyRegained |
Parallel Redundancy restored |
|
pcnsMaxInternalTempExceeded |
UPS Temperature Overheated |
|
pcnsMaxInternalTempInRange |
UPS Temperature Normal Again |
|
pcnsMinLoadCapabilityLost |
Load (kVA) Alarm Violation |
|
pcnsMinLoadCapabilityRegained |
Load (kVA) Alarm Violation cleared |
|
pcnsEnviornmentCommunicationEstablished |
Communication Established with EMC |
|
pcnsEnviornmentCommunicationLost |
Communication Lost with EMC |
|
pcnsTempInRangeProbeX |
Temperature Probe X In Range |
|
pcnsTempOutOfRangeProbeX |
Temperature Probe X Out Of Range |
|
pcnsHumidityInRangeProbeX |
Humidity Probe X In Range |
|
pcnsHumidityOutOfRangeProbeX |
Humidity Probe X Out Of Range |
| pcnsContactFaultX |
Contact Zone X Alarm |
|
pcnsContactNormalX |
Contact Zone X Normal |
For each event you can access:
|
OID Name |
Access |
Description |
| [event name]Desc |
read-only |
The description of the event. |
| [event name]EnableLogging |
read-write |
Enable or disable logging to the event log for this event. |
| [event name]EnableCommandFile |
read-write |
Enable or disable command file execution for this event. |
| [event name]CommandFilePath |
read-write |
Specify a Command File and full path to be executed upon this event. |
| [event name]CommandFileDelay |
read-write |
The number of seconds that a host requires to shut down, before the command file is executed. Note: This is not available for pcnsRunTimeBelowThreshold. See pcnsRunTimeBelowThresholdCommandFileThreshold. |
For some events you can access:
|
OID Name |
Access |
Description |
| [event name]EnableShutdown |
read-write |
Perform a graceful shutdown of the host when this event occurs. |
| [event name]ShutdownDelay |
read-write |
The amount of time in seconds that PowerChute should wait before initiating the shutdown process. |
For pcnsRunTimeBelowThreshold you can access:
PowerChute Traps
The table below details the OID Names of the SNMP traps sent by PowerChute for critical and lost communication events.
UPS Critical Events
|
OID Name |
Level |
Description |
|
pcnsCriticalEventActive |
Severe |
PowerChute Network Shutdown has begun a graceful shutdown of the host due to a critical event. |
|
pcnsCriticalEventResolved |
Informational |
The PowerChute Network Shutdown critical event has been resolved, and graceful shutdown of the host continues. |
Lost Communication Events
|
OID Name |
Level |
Description |
|
pcnsNetworkComsLost |
Severe |
PowerChute cannot communicate with the NMC. |
|
pcnsNetworkComsLostResolved |
Informational |
PowerChute has regained communication with the NMC. |
|
pcnsNMCComsLost |
Severe |
The NMC cannot communicate with the UPS. |
|
pcnsNMCComsLostResolved |
Informational |
The NMC has regained communication with the UPS. |
Other Events
|
OID Name |
Level |
Description |
|
pcnsTest |
Informational |
PowerChute has sent a test trap to the NMS. |
|
pcnsUpdateAvailable |
Informational |
PowerChute has detected that an update is available. |