Object Identifiers (OID)
An OID, in the context of the Simple Network Management Protocol (SNMP), consists of the object identifier for an object in a Management Information Base (MIB).
Management Information Base (MIB)
SNMP itself does not define which information (which variables) a managed system should offer. Rather, SNMP uses an extensible design, where the available information is defined by management information bases (MIBs). MIBs describe the structure of the management data of a device subsystem; they use a hierarchical namespace containing object identifiers (OID). Each OID identifies a variable that can be read or set via SNMP.
SNMP on SMG
All SNMP OIDs that can be queried on SMG can be observed by downloading the MIB files provided with the appliance (Administration > SNMP > Enable > MIBs).
Testing
To facilitate testing with SNMP queries and traps, it is recommended to avail of a MIB browser client/tool such as the iReasoning MIB Browser (http://ireasoning.com/mibbrowser.shtml)
The steps below should help in testing SNMP on SMG:
- Setup SNMP on SMG. See the SMG Admin Guide.
- Download all MIBs provided by SMG from the SNMP Settings page.
- Copy all MIBs into a folder.
- Load all SMG MIBs into the MIB Browser client.
Relevant Messaging Gateway SNMP OIDs
Host
- Name: sysDescr
- OID: .1.3.6.1.2.1.1.1
- MIB: RFC1213-MIB
- Syntax: DisplayString (OCTET STRING) (SIZE (0..255))
- Description: A textual description of the entity. This value should include the full name and version identification of the system's hardware type, software operating-system, and networking software. It is mandatory that this only contain printable ASCII characters.
- Name: sysName
- OID: .1.3.6.1.2.1.1.5
- MIB: RFC1213-MIB
- Syntax: DisplayString (OCTET STRING) (SIZE (0..255))
- Description: An administratively-assigned name for this managed node. By convention, this is the node's fully-qualified domain name.
- Name: hrMemorySize
- OID: .1.3.6.1.2.1.25.2.2
- MIB: HOST-RESOURCES-MIB
- Syntax: KBytes (Integer32) (0..2147483647)
- Description: The amount of physical read-write main memory, typically RAM, contained by the host.
- Name: sysUpTime
- OID: .1.3.6.1.2.1.1.3
- MIB: RFC1213-MIB
- Syntax: TIMETICKS
- Description: The time (in hundredths of a second) since the network management portion of the system was last re-initialized.
- Name: memTotalSwap
- OID: .1.3.6.1.4.1.2021.4.3
- MIB: UCD-SNMP-MIB
- Syntax: INTEGER32
- Description: Total Swap Size configured for the host.
- Name: memAvailSwap
- OID: .1.3.6.1.4.1.2021.4.4
- MIB: UCD-SNMP-MIB
- Syntax: INTEGER32
- Description: Available Swap Space on the host.
- Name: hrSystemNumUsers
- OID: .1.3.6.1.2.1.25.1.5
- MIB: HOST-RESOURCES-MIB
- Syntax: GAUGE32
- Description: The number of user sessions for which this host is storing state information. A session is a collection of processes requiring a single act of user authentication and possibly subject to collective job control.
- Name: hrSystemProcesses
- OID: .1.3.6.1.2.1.25.1.6
- MIB: HOST-RESOURCES-MIB
- Syntax: GAUGE32
- Description: The number of process contexts currently loaded or running on this system.
Additional host OIDs
Name |
OID |
MIB Module |
Description |
systemStats |
.1.3.6.1.4.1.2021.11 |
UCD-SNMP-MIB |
|
ssSwapIn |
.1.3.6.1.4.1.2021.11.3 |
UCD-SNMP-MIB |
Amount of memory swapped in from disk (kB/s). |
ssSwapOut |
.1.3.6.1.4.1.2021.11.4 |
UCD-SNMP-MIB |
Amount of memory swapped to disk (kB/s). |
ssCpuRawUser |
.1.3.6.1.4.1.2021.11.50 |
UCD-SNMP-MIB |
user CPU time. |
ssCpuRawNice |
.1.3.6.1.4.1.2021.11.51 |
UCD-SNMP-MIB |
nice CPU time. |
ssCpuRawSystem |
.1.3.6.1.4.1.2021.11.52 |
UCD-SNMP-MIB |
system CPU time. |
ssCpuRawIdle |
.1.3.6.1.4.1.2021.11.53 |
UCD-SNMP-MIB |
idle CPU time. |
ssCpuRawWait |
.1.3.6.1.4.1.2021.11.54 |
UCD-SNMP-MIB |
iowait CPU time. This is primarily a SysV thingie |
ssCpuRawKernel |
.1.3.6.1.4.1.2021.11.55 |
UCD-SNMP-MIB |
kernel CPU time. |
ssRawContexts |
.1.3.6.1.4.1.2021.11.60 |
UCD-SNMP-MIB |
Number of context switches |
MTA
Note: SMG may use up to three MTA instances, therefore each OID has and additional last digit indicating the MTA queue (.1 / .2 / .3).
OIDs associated with the MTA queue, like "queueSize", "queuedMessages", and "messageRate", will yield results exclusively for an appliance designated as a "scanner" or a Combo-box (Control Center and Scanner).
Command examples:
# snmpwalk -cpublic -v2c 192.0.2.6 -M/root/SMG_MIBS/ .1.3.6.1.4.1.393.200.130.2.2.1.1.3
.1.3.6.1.4.1.393.200.130.2.2.1.1.3.1 = Gauge32: 0
.1.3.6.1.4.1.393.200.130.2.2.1.1.3.2 = Gauge32: 0
.1.3.6.1.4.1.393.200.130.2.2.1.1.3.3 = Gauge32: 0
# snmpwalk -cpublic -v2c 192.0.2.6 -M/root/SMG_MIBS/ .1.3.6.1.4.1.393.200.130.2.2.1.1.7
.1.3.6.1.4.1.393.200.130.2.2.1.1.7.1 = Gauge32: 0
.1.3.6.1.4.1.393.200.130.2.2.1.1.7.2 = Gauge32: 0
.1.3.6.1.4.1.393.200.130.2.2.1.1.7.3 = Gauge32: 0
- Name: connections
- OID: .1.3.6.1.4.1.393.200.130.2.2.1.1.3
- MIB: SYMANTEC-EMAIL-SECURITY
- Syntax: GAUGE32
- Description: The number of connections for this MTA instance
- Name: dataRate
- OID: .1.3.6.1.4.1.393.200.130.2.2.1.1.4
- MIB: SYMANTEC-EMAIL-SECURITY
- Syntax: GAUGE32
- Description: The data rate for this MTA instance
- Name: queueSize
- OID: .1.3.6.1.4.1.393.200.130.2.2.1.1.7
- MIB: SYMANTEC-EMAIL-SECURITY
- Syntax: GAUGE32
- Description: The queue size for this MTA instance
- Name: queuedMessages
- OID: .1.3.6.1.4.1.393.200.130.2.2.1.1.8
- MIB: SYMANTEC-EMAIL-SECURITY
- Syntax: GAUGE32
- Description: The number of queued messages for this MTA instance
Hardware
Note: Some of the OIDs below may not return any result according to different SMG models.
- Name: cpuInternalTemperature
- OID: .1.3.6.1.4.1.393.200.130.2.1.1.5
- MIB: SYMANTEC-EMAIL-SECURITY
- Syntax: INTEGER {pass(1), fail(2), unknown(3), unavailable(4) }
- Description: Pass/Fail status of the CPU internal temperature
- Name: fanRedundancy
- OID: .1.3.6.1.4.1.393.200.130.2.1.2.2
- MIB: SYMANTEC-EMAIL-SECURITY
- Syntax: INTEGER {fullyRedundant(1), redundancyLost(2), redundancyUnknown(3) }
- Description: Redundancy status of the appliance fans.
- Name: powerSupplyRedundancy
- OID: .1.3.6.1.4.1.393.200.130.2.1.2.1
- MIB: SYMANTEC-EMAIL-SECURITY
- Syntax: INTEGER {fullyRedundant(1), redundancyLost(2), redundancyUnknown(3)}
- Description: Redundancy status of the appliance power supplies.
LSI MegaRAID
- Name: atAlarmState
- OID: .1.3.6.1.4.1.3582.4.1.6.1002
- MIB: LSI-MegaRAID-SAS-MIB
- Syntax: INTEGER
- Description: Alarm disabled/enabled. Values:disabled(0),enabled(1)!
- Name: vdNewState
- OID: .1.3.6.1.4.1.3582.4.1.7.1105
- MIB: LSI-MegaRAID-SAS-MIB
- Syntax: INTEGER
- Description: Virtual Drive state. Values are:offline(0),partially-degraded(1),degraded(2),optimal(3)
LSI MegaRAID-IR
- Name: vdNewState
- OID: .1.3.6.1.4.1.3582.5.1.4.6.1105
- MIB: LSI-megaRAID-SAS-IR-MIB
- Syntax: INTEGER
- Description: Virtual Drive state. Values are:offline(0),partially-degraded(1),degraded(2),optimal(3)
- Name: atAlarmState
- OID: .1.3.6.1.4.1.3582.5.1.4.6.1002
- MIB: LSI-megaRAID-SAS-IR-MIB
- Syntax: INTEGER
- Description: Alarm disabled(0)/enabled(1)
Traps
Below is the full list of SNMP v1 traps that can be handled by SMG. For more information on each trap, please refer to the MIB files provided by SMG, or use a freeware SNMP MIB Browser client.
- adpAlarmStateEnabled
- adpBGIRateChanged
- adpCacheDiscarded
- adpCacheRebootCantRecover
- adpCacheRebootRecover
- adpCacheVersionMismatch
- adpCCRateChanged
- adpFlashBadImage
- adpFlashEraseError
- adpFlashEraseTimeout
- adpFlashGeneralError
- adpFlashImage
- adpFlashOK
- adpFlashProgramError
- adpFlashProgramTimeout
- adpLogCleared
- adpLogWrapped
- adpPatrolReadComplete
- adpPatrolReadPaused
- adpPatrolReadResumed
- adpPatrolReadStarted
- adpShutdown
- adpHibernate
- adpCrash
- adpRRChanged
- adpPRRateChanged
- adpAlarmStateDisabled
- adpConfigCleared
- adpReconRateChanged
- adpDefault
- bbuPresent
- bbuNotPresent
- bbuNewBattery
- bbuReplaced
- bbuTempHigh
- bbuVoltageLow
- bbuCharging
- bbuDisCharging
- bbuTempNormal
- bbuReplace
- bbuRelearnStarted
- bbuRelearnProgress
- bbuRelearnComplete
- bbuRelearnTimeout
- bbuRelearnPending
- bbuRelearnPostponed
- bbuRemoved
- bbuCapacityLow
- bbuCapacityAbove
- bbuFRU
- revisionIdentifier
- adpLockKeyCreated
- adpLockKeyBackedup
- adpLockKeyVerifiedEscrow
- adpLockKeyRekeyed
- adpLockKeyRekeyFailed
- adpLockKeyInvalid
- adpLockKeyDestroyed
- adpEscrowKeyInvalid
- adpLockKeyFailed
- vdtBGIAborted
- vdtBGICompleted
- vdtBGIDoneWR
- vdtBGIFailed
- vdtBGIStarted
- vdtCCStarted
- vdtCCCompleted
- vdtCCFailed
- vdtCCAborted
- vdtCCCompCor
- vdtInitAborted
- vdtInitFailed
- vdtInitCompleted
- vdtInitFastStarted
- vdtInitFullStarted
- vdtReconStarted
- vdtReconCompleted
- vdtReconResumed
- vdtReconStopped
- vdtStateChange
- vdtCreated
- vdtDeleted
- vdtSecured
- vdtPartiallySecured
- vdtBbmLogCleared
- pdtClearAborted
- pdtClearFailed
- pdtClearStarted
- pdtClearCompleted
- pdtError
- pdtFormatStart
- pdtFormatCompleted
- pdtInserted
- pdtRblAborted
- pdtRblCompleted
- pdtRblFailedBS
- pdtRblFailedBT
- pdtRblStart
- pdtRblResumed
- pdtRblStartA
- pdtRemoved
- pdtStateChange
- pdtRedundantPathBroken
- pdtRedundantPathRestored
- pdtRedundantEnclModuleInserted
- pdtRedundantEnclModuleRemoved
- pdtFRU
- pdtSecured
- pdtUnsecured
- pdtReprovisioned
- pdtLockKeyRekeyed
- pdtSecurityFailure
- pdtPowerStateChange
- pdtNotSupported
- pdtNotCertified
- irAdpAlarmStateEnabled
- irAdpBGIRateChanged
- irAdpCacheDiscarded
- irAdpCacheRebootCantRecover
- irAdpCacheRebootRecover
- irAdpCacheVersionMismatch
- irAdpCCRateChanged
- irAdpFlashBadImage
- irAdpFlashEraseError
- irAdpFlashEraseTimeout
- irAdpFlashGeneralError
- irAdpFlashImage
- irAdpFlashOK
- irAdpFlashProgramError
- irAdpFlashProgramTimeout
- irAdpLogCleared
- irAdpLogWrapped
- irAdpPatrolReadComplete
- irAdpPatrolReadPaused
- irAdpPatrolReadResumed
- irAdpPatrolReadStarted
- irAdpShutdown
- irAdpHibernate
- irAdpCrash
- irAdpRRChanged
- irAdpPRRateChanged
- irAdpAlarmStateDisabled
- irAdpConfigCleared
- irAdpReconRateChanged
- irAdpDefault
- irVdtBGIAborted
- irVdtBGICompleted
- irVdtBGIDoneWR
- irVdtBGIFailed
- irVdtBGIStarted
- irVdtCCStarted
- irVdtCCCompleted
- irVdtCCFailed
- irVdtCCAborted
- irVdtCCCompCor
- irVdtInitAborted
- irVdtInitFailed
- irVdtInitCompleted
- irVdtInitFastStarted
- irVdtInitFullStarted
- irVdtReconStarted
- irVdtReconCompleted
- irVdtReconResumed
- irVdtReconStopped
- irVdtStateChange
- irVdtCreated
- irVdtDeleted
- irPdtClearAborted
- irPdtClearFailed
- irPdtClearStarted
- irPdtClearCompleted
- irPdtError
- irPdtFormatStart
- irPdtFormatCompleted
- irPdtInserted
- irPdtRblAborted
- irPdtRblCompleted
- irPdtRblFailedBS
- irPdtRblFailedBT
- irPdtRblStart
- irPdtRblResumed
- irPdtRblStartA
- irPdtRemoved
- irPdtStateChange
- irPdtSENSEAlert
- irPdtPredictiveThresholdExceed
- irBbuPresent
- irBbuNotPresent
- irBbuNewBattery
- irBbuReplaced
- irBbuTempHigh
- irBbuVoltageLow
- irBbuCharging
- irBbuDisCharging
- irBbuTempNormal
- irBbuReplace
- irBbuRelearnStarted
- irBbuRelearnProgress
- irBbuRelearnComplete
- irBbuRelearnTimeout
- irBbuRelearnPending
- irBbuRelearnPostponed
- irBbuRemoved
- irBbuCapacityLow
- irBbuCapacityAbove
Output examples
Note: The command line utility “snmpwalk” was used to retrieve the examples below.
# snmpwalk -cpublic -v2c 192.0.2.6 -M/root/SMG_MIBS/ .1.3.6.1.2.1.25.2.2
iso.3.6.1.2.1.25.2.2.0 = INTEGER: 4043716
# snmpwalk -cpublic -v2c 192.0.2.6 -M/root/SMG_MIBS/ .1.3.6.1.2.1.1.3
iso.3.6.1.2.1.1.3.0 = Timeticks: (8416670) 23:22:46.70
# snmpwalk -cpublic -v2c 192.0.2.6 -M/root/SMG_MIBS/ .1.3.6.1.4.1.393.200.130.2.2.1.1.3
iso.3.6.1.4.1.393.200.130.2.2.1.1.3.1 = Gauge32: 0
iso.3.6.1.4.1.393.200.130.2.2.1.1.3.2 = Gauge32: 0
iso.3.6.1.4.1.393.200.130.2.2.1.1.3.3 = Gauge32: 0
# snmpwalk -cpublic -v2c 192.0.2.6 -M/root/SMG_MIBS/ .1.3.6.1.4.1.393.200.130.2.2.1.1.7
iso.3.6.1.4.1.393.200.130.2.2.1.1.7.1 = Gauge32: 0
iso.3.6.1.4.1.393.200.130.2.2.1.1.7.2 = Gauge32: 0
iso.3.6.1.4.1.393.200.130.2.2.1.1.7.3 = Gauge32: 0