PowerNet Management Information Base (MIB) Version 3.4.
REFERENCE GUIDE: POWERNET® MANAGEMENT INFORMATION BASE (MIB), VERSION 3.4.4 AMERICAN POWER CONVERSION CORPORATION - SOFTWARE LICENSE AGREEMENT This software license agreement (the “agreement”) is a legal agreement between American Power Conversion Corporation as the “licensor” (hereafter referred to as APC) and you (hereafter referred to as the “customer”) for the APC software accompanying this agreement.
4. RESTRICTIONS The customer is not permitted to do any of the following: • Reverse assemble, reverse compile, or otherwise attempt to create the source code from the software. • Create derivative works of the software or any portion thereof. • Localize or translate the software or its documentation, without the prior written consent of APC. • Publish or provide any results of benchmark tests run on the software to a third party without the prior written consent of APC. 5.
8.
Contents About This Guide 1 Guide Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Terms Used in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Control a UPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [upsControl] OIDs 17 [upsBasicControl] 17 [upsAdvControl] 18 How to Configure a UPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [upsConfig] 20 [upsBasicConfig] 20 [upsAdvConfig] 21 How to Test a UPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 6: How to Manage a MasterSwitch VM Unit 43 [sPDUIdentVM] Identification OIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [sPDUMasterControlVM] Master Control OIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [sPDUMasterConfigVM] Master Configuration OIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [sPDUMasterStatusVM] Master Status OIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About This Guide This introduction provides the following information to help you use this guide. • Guide Purpose • Guide Structure • Related Documents • Terms Used in This Guide For assistance with this or any other APC product, contact APC Worldwide Customer Support as described at the end of this manual. Guide Purpose This guide describes how to use the PowerNet management information base (MIB), version 3.4.
About This Guide Related Documents • Chapter 8, How to Manage an Automatic Transfer Switch Chapter 9, PowerNet MIB Traps Describes the PowerNet MIB traps and how to define which NMSs can receive those traps. Related Documents This guide describes how to use the PowerNet MIB only. For information about an APC product that you manage using the PowerNet MIB, see the user’s guide or owner’s manual for that product. See your network management system (NMS) documentation for information about your NMS.
Chapter 1: PowerNet MIB Structure This chapter categorizes the PowerNet MIB into its major OID and trap components as follows: • PowerNet MIB Traps • PowerNet MIB OIDs PowerNet MIB Traps Any Management Card, PowerNet Agent, or MasterSwitch unit can send traps to an NMS when specific events occur. The NMS does not need the PowerNet MIB to receive the trap, but it does need the MIB to interpret the trap’s meaning.
Chapter 1: PowerNet MIB OIDs SNMP Access Controls A Management Card or MasterSwitch unit has a console programs that you can use to define specific SNMP access values for up to four SNMP channels. Action Result Disable SNMP access completely Prevent SNMP access by any NMS. Use an NMS IP Address as a SNMP channel value Limit channel access to only the defined NMS. Define a non-default password for an SNMP channel Limit channel access to an NMS that knows the password.
Chapter 1: PowerNet MIB OIDs Under [products], there are three categories, two of which ([hardware] and [software]) provide OIDs that you use to manage specific products. [hardware] [software] This category contains sub-categories for each type of hardware product that you can manage using PowerNet MIB OIDs.
Chapter 2: How to Manage Agents and Management Cards This chapter describes how to use PowerNet MIB OIDs to manage a Management Card, or to view software data for a PowerNet Agent. It also includes information on managing the SNMP agent of a MasterSwitch unit or Automatic Transfer Switch. In the following cases, the network connection allows an NMS to use an SNMP browser and PowerNet MIB OIDs to manage the UPS, Environmental Monitor, MasterSwitch unit, or Automatic Transfer Switch.
Chapter 2: How to Manage the SNMP Agent at a Hardware Device [powerNetSoftwareSystem] The following table describes the [powerNetSoftwareSystem] OIDs. OID Information Provided powerNetSoftwareSystemDescription Information about an Agent, including its version number. powerNetSoftwareOid The technology that the Agent uses to implement the PowerNet MIB. powerNetSoftwareSystemUpTime The length of time that the Agent has been continuously running on the network.
Chapter 2: How to Manage the SNMP Agent at a Hardware Device [mcontrol] The following table describes the one OID in the [mcontrol] category. Value (3), not documented, is obsolete. OID Values You Can SET mcontrolRestartAgent restartCurrentAgent (1): Reboots the SNMP Agent. continueCurrentAgent (2): Continues the Agent without rebooting. restartWithoutAgent (4): Restarts the system without starting the Agent. The next time the system restarts, the Agent also restarts.
Chapter 2: How to Manage the SNMP Agent at a Hardware Device [mtrapargs] The following table describes the [mtrapargs] OIDs, which enable APC traps to use a specific type of argument, which, in each case, may not be defined as part of the APC MIB. OID Argument That APC Traps Are Alowed to Use mtrapsapargsInteger An integer argument. mtrapsapargsIpAddress An IP address argument. mtrapsapargsString An octet string argument. mtrapsapargsGauge A Gauge argument.
Chapter 2: How to Manage the SNMP Agent at a Hardware Device [mfiletransferConfig] The following table describes the three sub-categories in the [mfiletransferConfig] category and the OIDs in each of those sub-categories. OID Sub-category OIDs in Each Sub-category [mfiletransferConfigSettings] mfiletransferConfigSettingsFileName: The name and path of the file to be transferred. [mfiletransferConfigTFTP] mfiletransferConfigTFTPServerAddress: The IP Address of the remote TFTP Server.
Chapter 3: How to Manage a UPS This chapter describes how to use PowerNet MIB OIDs to manage a UPS through its Management Card or its PowerNet Agent. ThePowerNet MIB OIDs that you can use to manage (monitor, configure, control and test) a UPS are in nine categories under the heading [ups]. To list the nine categories, perform the following steps: 1. Select [products] under [apc]. 2. Select [hardware]. 3. Select [ups].
Chapter 3: How to Monitor a UPS How to Monitor a UPS You use GETs (SNMP read commands) to PowerNet MIB OIDs to monitor (view information about) the UPS. Most PowerNet MIB categories have OIDs that you can use to view information about the operation of the UPS. With few exceptions, these OIDs respond to GETs, but not to SETs: You can view (GET) information about UPS operation, but you cannot affect (SET) that operation. OID Categories Information Reported [upsIdent] The UPS identification parameters.
Chapter 3: How to Monitor a UPS [upsAdvIdent] OID Information Reported upsAdvIdentFirmwareRevision The UPS firmware version. upsAdvIdentDateOfManufacture The date on which the UPS completed the manufacturing process. upsAdvIdentSerialNumber The UPS serial number. [upsBattery] UPS Battery OIDs The [upsBattery] category has nine OIDs in two sub-categories, [upsBasicBattery] and [upsAdvBattery] that provide UPS battery status information.
Chapter 3: How to Monitor a UPS [upsAdvBattery] OID Information Reported upsAdvBatteryCapacity The battery’s remaining capacity as a percentage of full battery capacity. upsAdvBatteryTemperature The internal temperature of the UPS, in Celsius. upsAdvBatteryRunTimeRemaining How long the UPS battery can provide output voltage.
Chapter 3: How to Monitor a UPS [upsAdvInput] OID Information Reported upsAdvInputLineVoltage The current input voltage in VAC. upsAdvInputMaxLineVoltage The maximum input voltage, in VAC, sensed by the UPS during the last minute. upsAdvInputMinLineVoltage The minimum input voltage, in VAC, sensed by the UPS during the last minute. upsAdvInputFrequency The current input voltage frequency in Hertz. upsAdvLineFailCause The reason for the most recent transfer to battery.
Chapter 3: How to Monitor a UPS [upsOutput] UPS Output OIDS The [upsOutput] category has six read-only OIDs in two subcategories, [upsBasicOutput] and [upsAdvOutput], that provide information about the UPS output voltage. You can access all six OIDs through any Management Card. A PowerNet Agent that connects to the UPS through a smart-signalling cable can use all the OIDs except upsAdvOutputCurrent.
Chapter 3: How to Control a UPS [upsAdvOutput] OID Information Reported upsAdvOutputVoltage The output voltage of the UPS in VAC. upsAdvOutputFrequency The output voltage frequency of the UPS in Hertz. upsAdvOutputLoad The equipment load placed on the UPS by its supported equipment as a percentage of rated load capacity.
Chapter 3: How to Control a UPS [upsAdvControl] Management Cards and PowerNet Agents that use smart-signalling to connect with the UPS can use SETs to the OIDs in the [upsAdvControl] category, with the following exceptions: • Three OIDs each have a value that you can use only with a Management Card. - The upsAdvControlUpsOff OID’s value of turnUpsOffGracefully (3). - The upsAdvControlRebootUps OID’s value of rebootUpsGracefully (3).
Chapter 3: How to Control a UPS OID Task (page 2 of 2) upsAdvControlUpsSleep Cause the UPS to turn off its outlets and wait in “sleep mode” for the period of time defined by upsAdvConfigUpsSleepTime, a UPS configuration OID (See How to Configure a UPS.) • noPutUpsToSleep (1): The value always returned for a GET. Setting this value has no effect. • putUpsToSleep (2): All Management Cards turn off UPS power immediately.
Chapter 3: How to Configure a UPS How to Configure a UPS You can use the OIDS in the [upsConfig] category to define how the UPS responds to specific operating conditions. [upsConfig] Which [upsConfig] OIDs you can use depends on how the Management Card or PowerNet Agent connects to the UPS. The [upsConfig] category has two subcategories: • [upsBasicConfig] for simple-signalling connections, which provide basic power management and protection but offer few additional configuration and monitoring options.
Chapter 3: How to Configure a UPS [upsAdvConfig] The OIDs in the [upsAdvConfig] category enable you to view or configure operating and shutdown parameters for a UPS connected in smart-signalling mode. A Management Card can use all the OIDS in this category. A PowerNet Agent can use all but four of the OIDs, as noted in the following table. OID Task (page 1 of 3) upsAdvConfigRatedOutputVoltage1 Define the UPS nominal VAC output voltage. This value is read-only for most 120 VAC UPSs.
Chapter 3: How to Configure a UPS OID Task (page 2 of 3) upsAdvConfigSensitivity Define the sensitivity of the UPS to input line abnormalities or “noise.” • auto (1): The only setting recognized by UPSs with automatic voltage regulators, e.g Matrix-UPS and Symmetra UPS. • low (2) • medium (3) • high (4) upsAdvConfigLowBatteryRunTime2 Define when a low-battery condition will occur, based on how much battery runtime remains, in seconds.
Chapter 3: How to Test a UPS OID Task {upsAdvConfigAllowedSetTable} Obtain the allowed values for all settable OIDs in the [upsAdvConfig] group. {apcUpsConfigEntry} apcUpsConfigFieldIndex apcUpsConfigFieldOID apcUpsConfigFieldValueRange 1 2 (page 3 of 3) • The index to an EEPROM field entry. • The OID of the current configurable value.
Chapter 3: How to Test a UPS OID Task upsAdvTestDiagnosticSchedule Define the self-test schedule for the UPS: • unknown (1): The Management Card or Agent cannot determine the setting. • biweekly (2): Self-tests will occur bi-weekly. • weekly (3): A self-test will occur once every week. • atTurnOn (4): A self-test will occur whenever the UPS turns on. • never (5): No self-test will be performed. Cause the UPS to perform an immediate self-test.
Chapter 3: How to Use OIDs for 3-Phase UPS Models How to Use OIDs for 3-Phase UPS Models The [upsPhase] category has OIDs in three subcategories • [upsPhaseResetValues]: Set of OIDs you use to reset the counters for the corresponding OID in the [upsPhaseInput] and [upsPhaseOutput] groups that report minimum and maximum values. • [upsPhaseInput]: Set of OIDs you use to obtain information about the input phases. • [upsPhaseOutput]: Set of OIDs you use to obtain information about the ouput phases.
Chapter 3: How to Use OIDs for 3-Phase UPS Models [upsPhaseInput] All of the OIDs in this category are read-only except for the upsPhaseInputName OID, a {upsPhaseInputEntry} in the {upsPhaseInputTable}. OID Task upsPhaseNumInputs {upsPhaseInputTable} Use these read-only OIDs to obtain information about the number of input feeds to the UPS, and information about each of those feeds.
Chapter 3: How to Use OIDs for 3-Phase UPS Models [upsPhaseOutput] All of the OIDs in this category are read-only except for the upsPhaseOutputName OID, a {upsPhaseOutputEntry} in the {upsPhaseOutputTable}. OID Task upsPhaseNumOutputs {upsPhaseOutputTable} Use these read-only OIDs to obtain information about the number of output feeds to the UPS, and information about each of those feeds.
Chapter 4: How to Manage an Environmental Monitor This chapter describes how to use the following PowerNet MIB OIDs to manage (monitor, configure, and control) an Environmental Monitor through its Management Card or PowerNet Agent.
Chapter 4: External Environmental Monitor (em) OIDs [emConfig] OIDs Two sets of [emConfig] OIDs are available to configure an external Environmental Monitor: • [emConfigProbes] OIDs • [emConfigContacts] OIDs [emConfigProbes] OIDs You use the following [emConfigProbes] OIDs to view and change values used by the temperature and humidity probes at an external Environmental Monitor. OID Task emConfigProbesNumProbes View how many probes are available (read-only).
Chapter 4: External Environmental Monitor (em) OIDs [emConfigContacts] OIDs You use the following [emConfigContacts] OIDs to view and change values used by the input contacts at an external Environmental Monitor. OID Task emConfigContactsNumContacts View how many contacts are available (read-only).
Chapter 4: External Environmental Monitor (em) OIDs [emStatusProbes] OIDs You use the following [emStatusProbes] read-only OIDs to view information about the temperature and humidity probes at an external Environmental Monitor.
Chapter 4: Integrated Environmental Monitor (iem) OIDs (AP9618 or AP9619 Network Management Card Only) Integrated Environmental Monitor (iem) OIDs (AP9618 or AP9619 Network Management Card Only) Three categories of iem OIDs provide for managing the Integrated Environmental Monitor at an AP9618 or AP9619 Network Management Card. • [iemIdent] OID • [iemConfig] OIDs • [iemStatus] OIDs Note: The Integrated Environmental Monitor has one probe, two input contacts, and an output relay available.
Chapter 4: Integrated Environmental Monitor (iem) OIDs (AP9618 or AP9619 Network Management Card Only) [iemConfigProbes] OIDs You use the following [iemConfigProbes] OIDs to view and change values used by the temperature and humidity probe at an Integrated Environmental Monitor. OID Task iemConfigProbesNumProbes View whether the single probe is available (read-only).
Chapter 4: Integrated Environmental Monitor (iem) OIDs (AP9618 or AP9619 Network Management Card Only) [iemStatus] OIDs Three types of [iemStatus] read-only OIDs are available to view the status at an external Environmental Monitor: • [iemStatusProbes] OIDs • [iemStatusContacts] OIDs • [iemStatusRelays] OIDs [iemStatusProbes] OIDs You use the following [iemStatusProbes] read-only OIDs to view information about the temperature and humidity probes at an Integrated Environmental Monitor.
Chapter 4: Measure-UPS (mUps) OIDs [iemStatusContacts] OIDs You use the following [iemStatusContacts] read-only OIDs to view information about the input contacts at an Integrated Environmental Monitor.
Chapter 4: Measure-UPS (mUps) OIDs [mUpsEnviron] Environment OIDs An Environmental Monitor can monitor an environment’s ambient temperature and relative humidity. You use two read-only [mUpsEnviron] OIDs to view those temperature and humidity values. OID Information Reported mUpsEnvironAmbientTemperature The ambient temperature, in Celsius or Farrenheit, depending on the configuration, sensed by the Environmental Monitor.
Chapter 5: How to Manage a MasterSwitch Unit This chapter describes how to use PowerNet MIB OIDs to manage a MasterSwitch unit, MasterSwitch VM unit, or MasterSwitch Plus unit. For information on how to manage the Agent that these units use, see How to Manage the SNMP Agent at a Hardware Device in Chapter 2. To list the five OID categories that you use to manage a MasterSwitch unit, perform the following steps: 1. Select [products] under [apc]. 2. Select [hardware]. 3. Select [masterswitch].
Chapter 5: [sPDUIdent] Identification OIDS [sPDUIdent] Identification OIDS The [sPDUIdent] category has five read-only OIDs that report MasterSwitch unit identification parameter values. Note: MasterSwitch unit version 2.
Chapter 5: [sPDUMasterControl] Master Control OIDs [sPDUMasterControl] Master Control OIDs The [sPDUMasterControl] category has two OIDs that respond to GETs with information about all eight outlets and a third OID that uses SETs to directly affect the operation of all outlets simultaneously. OID Task sPDUMasterControlSwitch Affect the operation of all outlets. • turnAllOnNow (1): Immediately turn on all outlets.
Chapter 5: [sPDUMasterConfig] Master Configuration OIDs [sPDUMasterConfig] Master Configuration OIDs The [sPDUMasterConfig] category has three OIDs that allow you to use SETs to define two overall operational values and a name for the MasterSwitch unit. If the MasterSwitch unit uses firmware version 2.x, the sPDUMasterConfigReboot OID is read-only. OID Task sPDUMasterConfigPowerOn Define how long a delay will occur after power is applied to the MasterSwitch unit until it supplies power to the outlets.
Chapter 5: [sPDUOutletControl] Outlet Control OIDs [sPDUOutletControl] Outlet Control OIDs The [sPDUOutletControl] category has a read-only OID and a tabled set of OIDs. OID Task sPDUOutletControlTableSize Identify the number of MasterSwitch unit outlets (always 8) {sPDUOutletControlTable} {sPDUOutletControlEntry} View and control each outlet individually: sPDUOutletControlIndex sPDUOutletPending • The outlet number (read-only).
Chapter 5: [sPDUOutletConfig] Outlet Configuration OIDs [sPDUOutletConfig] Outlet Configuration OIDs The [sPDUOutletConfig] category has a read-only OID and a tabled set of OIDs. OID Task sPDUOutletConfigTableSize Identify the number of MasterSwitch unit outlets (always 8). {sPDUOutletConfigTable} {sPDUOutletConfigEntry} View and configure each outlet individually.
Chapter 6: How to Manage a MasterSwitch VM Unit This chapter describes how to use PowerNet MIB OIDs to manage (monitor, configure, control and test) a MasterSwitch VM unit. The MasterSwitch VM unit has its own SNMP agent that allows you to use SNMP to manage the MasterSwitch VM unit or any of its eight relay-controlled outlets. A maximum of four MasterSwitch VM units can be connected in a daisy chain and managed via SNMP.
Chapter 6: [sPDUIdentVM] Identification OIDs [sPDUIdentVM] Identification OIDs The [sPDUIdentVM] category has a read-only OID and a tabled set of read-only OIDs that return values for MasterSwitch VM unit’s identification parameters. Note: The last five OIDs in the following table are set at the factory. OID Information Reported sPUIdentVMTableSize The number of MasterSwitch VM units. {sPDUIdentVMTable} {sPDUIdentVMEntry} View the following information about a specified MasterSwitch VM unit.
Chapter 6: [sPDUMasterControlVM] Master Control OIDs [sPDUMasterControlVM] Master Control OIDs The [sPDUMasterControlVM] category has a read-only OID and a tabled set of OIDS that provide information on the MasterSwitch VM unit and commands to control it. OID Task sPDUMasterControlVMTableSize The number of MasterSwitch VM units. {sPDUMasterControlVMTable} {sPDUMasterControlVMEntry} View and control a specified MasterSwitch VM unit.
Chapter 6: [sPDUMasterConfigVM] Master Configuration OIDs OID Task sPDUMasterConfigVMTableSize The number of MasterSwitch VM units. {sPDUMasterConfigVMTable} {sPDUMasterConfigVMEntry} View and configure a specified MasterSwitch VM unit.
Chapter 6: [sPDUMasterStatusVM] Master Status OIDs [sPDUMasterStatusVM] Master Status OIDs The [sPDUMasterStatusVM] category has a read-only OID and a tabled set of read-only OIDs that provide information on the status of the MasterSwitch VM unit. OID Information Reported sPDUMasterStatusVMTableSize The number of MasterSwitch VM units. {sPDUMasterStatusVMTable} {sPDUMasterStatusVMEntry} Information about the status of a specified MasterSwitch VM unit.
Chapter 6: [sPDUOutletControlVM] Outlet Control OIDs [sPDUOutletControlVM] Outlet Control OIDs The [sPDUOutletControlVM] category has a tabled set of OIDs that provide information on MasterSwitch VM unit’s outlets and provide commands to control individual outlets. OID Task {sPDUOutletControlVMTable} {sPDUOutletControlVMEntry} Control a specified outlet. (The sPDUMasterStatusVMOutletCount OID identifies the number of table entries.) • The index to the MasterSwitch VM unit’s entry (read-only).
Chapter 6: [sPDUOutletConfigVM] Outlet Configuration OIDs [sPDUOutletConfigVM] Outlet Configuration OIDs The [sPDUOutletConfigVM] category has a tabled set of OIDs that provide information on outlets at the MasterSwitch VM unit and allow you to configure outlet values. OID Task {sPDUOutletConfigVMTable} {sPDUOutletConfigVMEntry} Configure a specified outlet. (The sPDUMasterStatusVMOutletCount OID identifies the number of table entries.) • The index to the MasterSwitch VM unit’s entry (read-only.
Chapter 6: [sPDUOutletStatusVM] Outlet Status OIDs [sPDUOutletStatusVM] Outlet Status OIDs The [sPDUOutletStatusVM] category has a tabled set of OIDs that provide information on the status of the outlets for a MasterSwitch VM unit. OID Information Provided {sPDUOutletStatusVMTable} {sPDUOutletStatusVMEntry} View the status of a specified outlet. (The sPDUMasterStatusVMOutletCount OID identifies the number of table entries.) • Index to the MasterSwitch VM unit’s entry (read only).
Chapter 7: How to Manage a MasterSwitch Plus Unit This chapter describes how to use PowerNet MIB OIDs to manage (monitor, configure, control and test) a MasterSwitch Plus unit. The MasterSwitch Plus unit has its own SNMP agent that allows you to use SNMP to manage the MasterSwitch Plus unit or any of its eight relay-controlled outlets. A maximum of four MasterSwitch Plus units can be connected in a daisy chain and managed via SNMP.
Chapter 7: [sPDUIdentMSP] Identification OIDs [sPDUIdentMSP] Identification OIDs The [sPDUIdentMSP] category has a read-only OID and a tabled set of read-only OIDS that return values for MasterSwitch Plus unit identification parameters. Note: The last five OIDs in the following table are set at the factory. OID Information Reported sPUIdentMSPTableSize The number of MasterSwitch Plus units.
Chapter 7: [sPDUMasterControlMSP] Master Control OIDs [sPDUMasterControlMSP] Master Control OIDs The [sPDUMasterControlMSP] category has a read-only OID and a tabled set of OIDS that provide information on the MasterSwitch Plus unit and commands to control it. OID Task sPDUMasterControlMSPTableSize The number of MasterSwitch Plus units. {sPDUMasterControlMSPTable} {sPDUMasterControlMSPEntry} sPDUMasterControlMSPIndex sPDUMasterControlMSPName View and control a specified MasterSwitch Plus unit.
Chapter 7: [sPDUMasterConfigMSP] Master Configuration OIDs [sPDUMasterConfigMSP] Master Configuration OIDs The [sPDUMasterConfigMSP] category has a read-only OID and a tabled set of OIDS that provide commands to configure the MasterSwitch Plus unit. OID Task sPDUMasterConfigMSPTableSize The number of MasterSwitch Plus units. {sPDUMasterConfigMSPTable} {sPDUMasterConfigMSPEntry} sPDUMasterConfigMSPindex sPDUMasterConfigMSPName View and configure a specified MasterSwitch Plus unit.
Chapter 7: [sPDUOutletControlMSP] Outlet Control OIDs [sPDUOutletControlMSP] Outlet Control OIDs The [sPDUOutletControlMSP] category has a tabled set of OIDS that provide information on the outlets at a MasterSwitch Plus unit and provide commands to control individual outlets. OID Task {sPDUOutletControlMSPTable} {sPDUOutletControlMSPEntry} Control a specified outlet. (The sPDUMasterStatusMSPOutletCount OID identifies the number of table entries.
Chapter 7: [sPDUOutletConfigMSPall] Outlet Configuration OIDs [sPDUOutletConfigMSPall] Outlet Configuration OIDs The [sPDUOutletConfigMSPall] category contains a tabled set of OIDS that provide information on the outlets at a MasterSwitch Plus unit and allow you to configure values for individual outlets. OID Task {sPDUOutletConfigMSPallTable} {sPDUOutletConfigMSPallEntry} Configure individual MasterSwitch Plus outlets. (The sPDUMasterStatusMSPOutletCount OID identifies the number of table entries.
Chapter 7: [sPDUOutConfigMSPgs] Outlet Configuration OIDS OID Task {sPDUOutletConfigMSPgsTable} {sPDUOutletConfigMSPgsEntry} sPDUOutletConfigMSPgsIndex sPDUOutletConfigMSPgsName View and configure a specified outlet for Graceful Shutdown mode. (The OID sPDUMasterStatusMSPOutletCount identifies the number of table entries.) • The index to the MasterSwitch Plus unit’s entry (read only). • The name of the MasterSwitch Plus unit (read only). (You use the sPDUMasterConfigMSPName OID to define this name).
Chapter 7: [sPDUOutConfigMSPgs] Outlet Configuration OIDS Example of a “Load-Shedding” Configuration You can configure the eight outlets of the MasterSwitch Plus unit to turn off in up to seven stages during a power outage so that devices attached to those outlets shut down in an ordered sequence based on the importance you assign to them.
Chapter 7: [sPDUOutConfigMSPgs] Outlet Configuration OIDS If the UPS’s Low Battery Signal Time is set to 25 minutes, and the UPS switches to battery operation with 60 minutes of Runtime Remaining, the outlets will turn off as follows: • Outlet 1 will begin its turn-off sequence immediately, without waiting the 6-minute Low Battery Warning, because the Runtime Remaining of 60 minutes is already less than 175 minutes (Low Battery Multiplier x the Low Battery Signal Time of the UPS).
Chapter 7: [sPDUOutConfigMSPannun] Outlet Configuration OIDS [sPDUOutConfigMSPannun] Outlet Configuration OIDS The [sPDUOutConfigMSPannun] category has a has a tabled set of OIDS to configure individual outlets in Annunciator mode. OID Task {sPDUOutletConfigMSPannunTable} {sPDUOutletConfigMSPannunEntry} View and configure individual outlets in Annunciator Mode. The OID sPDUMasterStatusMSPOutletCount contains the number of entries in this table.
Chapter 7: [sPDUOutConfigMSPmups] Outlet Configuration OIDs [sPDUOutConfigMSPmups] Outlet Configuration OIDs The [sPDUOutConfigMSPmups] category has a has a tabled set of OIDS to configure individual outlets to begin their turn-off sequence in response to alarm conditions from the Environmental Monitor or to ignore those alarm conditions.
Chapter 7: [sPDUOutConfigMSPmups] Outlet Configuration OIDs OID Task {sPDUOutletConfigMSPmupsTable} {sPDUOutletConfigMSPmupsEntry} View and configuration a spcifived outlet. (The sPDUMasterStatusMSPOutletCount OID identifies the number of table entries.) • The index to the MasterSwitch Plus unit’s entry (read only). • The name of the MasterSwitch Plus unit (read only). (You use the sPDUMasterConfigMSPName OID to define this name). • The outlet number (read only) • The name of the outlet (read only).
Chapter 7: [sPDUOutletStatusMSP] Outlet Status OIDs [sPDUOutletStatusMSP] Outlet Status OIDs The [sPDUOutletStatusMSP] category has a tabled set of OIDS that provides information on the status of the outlets for MasterSwitch Plus unit. OID Information Provided {sPDUOutletStatusMSPTable} {sPDUOutletStatusMSPEntry} View status information for a specified outlet. (The sPDUMasterStatusMSPOutletCount OID identifies the number of table entries.) • The index to the MasterSwitch Plus unit’s entry (read only).
Chapter 8: How to Manage an Automatic Transfer Switch This chapter describes how to use PowerNet MIB OIDs to manage (monitor, configure, control and test) an Automatic Transfer Switch. The Automatic Transfer Switch also has an embedded Network Management Card. To manage that management card, see Chapter 2, How to Manage Agents and Management Cards. To list the seven categories of PowerNet MIB OIDs that you use to manage an Automatic Transfer Switch, perform the following steps: 1. 2. 3.
Chapter 8: [atsIdent] Identification OIDs [atsIdent] Identification OIDs The [atsIdent] category has eight read-only OIDs that return values for Automatic Transfer Switch identification parameters. Note: The first six OIDs in the following table are set at the factory. OID Information Reported atsIdentHardwareRev The hardware version of the Automatic Transfer Switch. atsIdentFirmwareRev The firmware version of the Automatic Transfer Switch.
Chapter 8: [atsCalibration] Calibration OIDs [atsCalibration] Calibration OIDs The [atsCalibration] category has five read-only OIDs and three tabled sets of read-only OIDS that return values related to the Automatic Transfer Switch’s input lines and output lines, including information on their phases and calibration factors. The OIDs also identify the number, type, and calibration factors of power supplies supported.
Chapter 8: [atsControl] Control OIDs [atsControl] Control OIDs The [atsControl] category has two read-write OIDs that provide commands to control the resetting of the Automatic Transfer Switch and the clearing of all its alarms. OID Task atsControlResetATS Setting this variable determines whether the Automatic Transfer Switch performs a reset when power is applied. none (1): Does not perform a reset. reset (2): Performs a power-on reset.
Chapter 8: [atsStatus] Status OIDs [atsStatus] Status OIDs The [atsStatus] category has six read-only OIDs that report the status of Automatic Transfer Switch components and operation and one read-write OID that you can use to restart the recording of minimum and maximum values that occurred for various operational parameters of the Automatic Transfer Switch.
Chapter 8: [atsStatus] Status OIDs OID Information Reported atsStatusResetMaxMinValues Resets the following maximum and minimum Automatic Transfer Switch values, which are the maximum and minimum Automatic Transfer Switch values recorded since the last time they were read or reset by atsStatusResetMaxMinValues. none (1): Do not reset the values. reset (2): Reset the values. Parameters that are unsupported by your model of the Automatic Transfer Switch return –1.
Chapter 8: [atsStatusInput] Input OIDs [atsStatusInput] Input OIDs The [atsStatusInput] category has an OID and two tabled set of OIDS that provide information on the Automatic Transfer Switch’s input feeds and their phases. All OIDs in this category are read-only except atsInputName, which is read-write. OID Information Reported atsNumInputs The number of input feeds to this device. This number defines the number of rows in atsInputTable.
Chapter 8: [atsStatusInput] Input OIDs OID Information Reported {atsInputPhaseTable} {atsInputPhaseEntry} A tabled set of OIDs providing the following information for each input phase. Parameters that are unsupported by your model of the Automatic Transfer Switch return –1. • The input identifier. • The input phase identifier. • The input voltage in VAC. • The maximum input voltage in VAC recorded since the last time this value was read or reset by atsStatusResetMaxMinValues.
Chapter 8: [atsStatusOutput] Output OIDs [atsStatusOutput] Output OIDs The [atsStatusOutput] category has a read-only OID and two tabled set of read-only OIDS that provide information on the Automatic Transfer Switch’s output feeds and their phases. OID Information Reported atsNumOutputs The number of output feeds to this device.This number defines the number of rows in atsOutputTable.
Chapter 8: [atsStatusOutput] Output OIDs OID Information Reported {atsOutputPhaseTable} {atsOutputPhaseEntry} A tabled set of OIDs providing the following information for each output phase: Parameters that are unsupported by your model of the Automatic Transfer Switch return –1. • The output identifier. • Description of each output phase used in this device and one for neutral: phase 1 (1), phase 2 (2), phase 3 (3), and neutral (4). • The output voltage in VAC. • The output current, in 0.
Chapter 9: Chapter 9: PowerNet MIB Traps This chapter describes the PowerNet MIB traps that a Management Card, PowerNet Agent, MasterSwitch unit, or Automatic Transfer Switch can send to an NMS to alert the NMS that a specific event has occurred and describes how to define which NMSs can receive those traps. (See How To Define Trap Receivers.) Devices and Agents and the Traps They Can Generate Management Card All UPS traps PowerNet Agent Only UPS traps supported for an Agent by the PowerNet MIB 2.
Chapter 9: Trap Severity Levels Trap Severity Levels Each trap has one of the following severity levels. Severe Warning Informational Alerts a trap receiver of an event that requires immediate corrective action. Alerts a trap receiver of an event that Alerts a trap receiver of an event can adversely affect a device’s that can not adversely affect a operation if the situation worsens. device’s operation.
Chapter 9: PowerNet MIB Trap Definitions PowerNet MIB Trap Definitions APC devices can generate the traps defined in the following table: Trap Severity Number and Description communicationLost Severe 1: The Management Card’s SNMP Agent lost communication with the UPS. upsOverload Severe 2: The UPS sensed a load greater than the ratedload capacity. upsDiagnosticsFailed Severe 3: The UPS failed a self-test.
Chapter 9: PowerNet MIB Trap Definitions Trap Severity Number and Description (Sheet 2 of 9) returnFromBypass Informational 23: The Matrix-UPS returned from bypass mode. bypassPowerSupplyFailure Severe 24: The Matrix-UPS base module bypass power supply needs repair. baseFanFailure Severe 25: The Matrix-UPS base module fan needs repair batteryPackCommLost Severe 26: Communication with external battery packs was lost (Matrix-UPS or Smart-UPS XL).
Chapter 9: PowerNet MIB Trap Definitions Trap Severity Number and Description (Sheet 3 of 9) configChangeOutlet Warning 45: The configuration of the MasterSwitch outlet specified by sPDUOutletConfigIndex changed, or if that value is 0, the master outlet configuration changed. accessViolationConsole Warning 46: Three unsuccessful MasterSwitch console login attempts occurred. accessViolationHTTP Warning 47: An unsuccessful MasterSwitch HTTP login attempt occurred.
Chapter 9: PowerNet MIB Trap Definitions Trap Severity Number and Description (Sheet 4 of 9) mupsCommunicationEstablished Informational 65: Communication with the Environmental Monitor has been established. mupsCommunicationLost Warning batteryIncrease Informational 67: The number of Symmetra UPS batteries was increased. batteryDecrease Informational 68: The number of Symmetra UPS batteries was decreased.
Chapter 9: PowerNet MIB Trap Definitions Trap Severity Number and Description (Sheet 5 of 9) msvmCommunicationEstablished Informational 85: Communication with the MasterSwitch VM unit has been established. msvmCommunicationLost Severe 86: Communication with the MasterSwitch VM unit has been lost. msvmOverload Severe 87: The MasterSwitch VM unit is near or at an overload condition. msvmOverloadCleared Informational 88: The overload condition on the MasterSwitch VM unit has been cleared.
Chapter 9: PowerNet MIB Trap Definitions Trap Severity Number and Description (Sheet 6 of 9) rsSourceSwitched Informational 104: The Redundant Switch has switched source. -The first variable represents the current source: 0 for A, 1 for B. -The second variable is the 32-character name of the source.
Chapter 9: PowerNet MIB Trap Definitions Trap Severity Number and Description (Sheet 7 of 9) dcMajorAlarm Severe 113: A Major alarm is active in the DC power plant. dcMajorAlarmCleared Informational 114: A Major alarm is no longer active in the DC power plant. dcMinorAlarm Severe dcMinorAlarmCleared Informational 116: A Minor alarm is no longer active in the DC power plant. dcOutputRelayOn Warning dcOutputRelayOff Informational 118: An input relay has gone off in the DC power plant.
Chapter 9: PowerNet MIB Trap Definitions Trap Severity Number and Description (Sheet 8 of 9) atsOverCurrentCleared Informational 133: Output Current of the Automatic Transfer Switch has returned below threshold. atsPowerSupplyFailure Severe atsPowerSupplyFailureCleared Informational 135: The Automatic Transfer Switch Power Supply failure cleared. dcMainsFailAlarm Warning dcMainsFailAlarmCleared Informational 137: Mains Fail alarm is no longer active in the DC power plant.
Chapter 9: PowerNet MIB Trap Definitions Trap Severity Number and Description (Sheet 9 of 9) dcLVDImminentAlarmCleared Informational 153: An LVD Imminent alarm is no longer active in the DC power plant. dcFuseCBAlarm Warning dcFuseCBAlarmCleared Informational 155: A Fuse/CB alarm is no longer active in the DC power plant. dcBatteryTestFail Warning 156: A Battery Test failed in the DC power plant. dcTemperatureAlarm Warning 157: A Temperature alarm is active in the DC power plant.
Chapter 9: Symmetra UPS Subtraps Symmetra UPS Subtraps The abnormalCondition and abnormalConditionCleared traps for the Symmetra UPS have the following subtraps that identify the abnormal condition. Note: To make the MIB forward-compatible with future UPS models, subtraps 41 through 64 are defined but unused at the time this manual is being published.
Chapter 9: Symmetra UPS Subtraps Subtrap Description SYMtrapstr20 The bypass contactor is no longer stuck in the on-line position condition. SYMtrapstr21 The UPS is in bypass mode due to an internal fault. SYMtrapstr22 The internal fault condition that put the UPS into bypass mode has been corrected. SYMtrapstr23 The UPS is in bypass mode due to an overload. SYMtrapstr24 The overload condition that put the UPS in bypass mode has been cleared. SYMtrapstr25 The UPS is in maintenance bypass mode.
Chapter 9: Symmetra UPS Subtraps Subtrap Description SYMtrapstr49 Bit 24 of the Abnormal Condition register is set. SYMtrapstr50 Bit 24 of the Abnormal Condition register has been reset. SYMtrapstr51 Bit 25 of the Abnormal Condition register is set. SYMtrapstr52 Bit 25 of the Abnormal Condition register has been reset. SYMtrapstr53 Bit 26 of the Abnormal Condition register is set. SYMtrapstr54 Bit 26 of the Abnormal Condition register has been reset.
® APC Worldwide Customer Support Customer support for this or any other APC product is available at no charge in any of the following ways: • Visit the APC Web site to find answers to frequently asked questions (FAQs), to access documents in the APC Knowledge Base, and to submit customer support requests. – www.apc.com (Corporate Headquarters) Connect to localized APC Web sites for specific countries, each of which provides customer support information. – www.apc.
