DISMAN-PING-MIB
Functions Overview
RFC 2929 defines DISMAN-PING-MIB. This MIB is used to realize automatic pings between network devices, and to record ping results.
The OID of the root object:
iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).pingMIB(80)
Description of Single Objects
pingMaxConCurrentRequests
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
---|---|---|---|---|---|
1.3.6.1.2.1.80.1.1 |
pingMaxConCurrentRequests |
INTEGER (0..4294967295) |
Read-write |
The maximum number of concurrent active ping requests that are allowed within an agent implementation. A value of 0 for this object implies that there is no limit for the number of concurrent active requests in effect. The limit applies only to new requests being activated. When a new value is set, the agent will continue processing all the requests already active, even if their number exceeds the limit just imposed. |
Value range for the number of test instances that can be configured: 0 to 5000. |
Description of MIB Tables
pingCtlTable
This table lists all types of parameters needed for the HWPing service test. According to the different types of services being tested, you can decide which parameter is mandatory and which is optional.
The indexes of this table are pingCtlOwnerIndex and pingCtlTestName.
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
---|---|---|---|---|---|
1.3.6.1.2.1.80.1.2.1.1 |
pingCtlOwnerIndex |
SnmpAdminString (SIZE(0..32)) |
Not-accessible |
To facilitate the provisioning of access control by a security administrator using the View-Based Access Control Model (RFC 2575, VACM) for tables in which multiple users may need to create or modify entries independently, the initial index is used as an 'owner index'. Such an initial index has the SnmpAdminString syntax and can thus be trivially mapped to a securityName or groupName defined in VACM, in accordance with a security policy. When used in conjunction with such a security policy, all entries in the table belonging to a particular user (or group) will have the same value for this initial index. For a given user's entries in a particular table, the object identifiers for the information in these entries will have the same subidentifiers (except for the 'column' subidentifier) up to the end of the encoded owner index. To configure VACM to permit access to this portion of the table, one would create vacmViewTreeFamilyTable entries with the value of vacmViewTreeFamilySubtree including the owner index portion, and vacmViewTreeFamilyMask 'wildcarding' the column subidentifier. More elaborate configurations are possible. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.2 |
pingCtlTestName |
SnmpAdminString (SIZE(0..32)) |
Not-accessible |
The name of the ping test. This is locally unique, within the scope of an pingCtlOwnerIndex. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.3 |
pingCtlTargetAddressType |
INTEGER{unknown(0),ipv4(1),ipv6(2),ipv4z(3),ipv6z(4),dns(16)} |
Read-create |
Specifies the type of host address to be used at a remote host for performing a ping operation. |
Only supports IPv4. The value of this object: ipv4(1), unknown(0). The default value is unknown(0). |
1.3.6.1.2.1.80.1.2.1.4 |
pingCtlTargetAddress |
OCTET STRING (SIZE (0..255)) |
Read-create |
Specifies the host address to be used at a remote host for performing a ping operation. The host address type is determined by the object value of corresponding pingCtlTargetAddressType. A value for this object MUST be set prior to transitioning its corresponding pingCtlEntry to active(1) via pingCtlRowStatus. |
Only supports IPv4. |
1.3.6.1.2.1.80.1.2.1.5 |
pingCtlDataSize |
Unsigned32 (0..65507) |
Read-create |
Specifies the size of the data portion to be transmitted in a ping operation, in octets. Whether this value can be applied depends on the selected implementation method for performing a ping operation, indicated by pingCtlType in the same conceptual row. If the method used allows applying the value contained in this object, then it MUST be applied. If the specified size is not appropriate for the chosen ping method, the implementation SHOULD use whatever size (appropriate to the method) is closest to the specified size. The maximum value for this object was computed by subtracting the smallest possible IP header size of 20 octets (IPv4 header with no options) and the UDP header size of 8 octets from the maximum IP packet size. An IP packet has a maximum size of 65535 octets (excluding IPv6 Jumbograms). |
The value ranges from 0 to 8100. |
1.3.6.1.2.1.80.1.2.1.6 |
pingCtlTimeOut |
Unsigned32 (1..60) |
Read-create |
Specifies the time-out value, in seconds, for a remote ping operation. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.7 |
pingCtlProbeCount |
Unsigned32 (1..15) |
Read-create |
Specifies the number of times to perform a ping operation at a remote host as part of a single ping test. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.8 |
pingCtlAdminStatus |
INTEGER { enabled(1), disabled(2) } |
Read-create |
Reflects the desired state that a pingCtlEntry should be in:
|
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.9 |
pingCtlDataFill |
OCTET STRING (SIZE(0..1024)) |
Read-create |
The content of this object is used together with the corresponding pingCtlDataSize value to determine how to fill the data portion of a probe packet. The option of selecting a data fill pattern can be useful when links are compressed or have data pattern sensitivities. The contents of pingCtlDataFill should be repeated in a ping packet when the size of the data portion of the ping packet is greater than the size of pingCtlDataFill |
The value ranges from 0 to 240. |
1.3.6.1.2.1.80.1.2.1.10 |
pingCtlFrequency |
INTEGER (0..4294967295) |
Read-create |
The number of seconds to wait before repeating a ping test as defined by the value of the various objects in the corresponding row. A single ping test consists of a series of ping probes. The number of probes is determined by the value of the corresponding pingCtlProbeCount object. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.11 |
pingCtlMaxRows |
INTEGER (0..4294967295) |
Read-create |
The maximum number of corresponding entries allowed in the pingProbeHistoryTable. An implementation of this MIB will remove the oldest corresponding entry in the pingProbeHistoryTable to allow the addition of a new entry once the number of corresponding rows in the pingProbeHistoryTable reaches this value. Old entries are not removed when a new test is started. Entries are added to the pingProbeHistoryTable until pingCtlMaxRows is reached before entries begin to be removed. A value of 0 for this object disables creation of pingProbeHistoryTable entries. |
The value ranges from 0 to 50. |
1.3.6.1.2.1.80.1.2.1.12 |
pingCtlStorageType |
INTEGER {other(1),volatile(2),nonVolatile(3),permanent(4),readOnly(5)} |
Read-create |
The storage type for this conceptual row. Conceptual rows having the value 'permanent' need not allow write-access to any columnar objects in the row. NOTE:
pingCtlStorageType supports only nonVolatile. |
Read-only. |
1.3.6.1.2.1.80.1.2.1.13 |
pingCtlTrapGeneration |
BITS { probeFailure(0), testFailure(1), testCompletion(2) } |
Read-create |
The value of this object determines when and whether to generate a notification for this entry:
|
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.14 |
pingCtlTrapProbeFailureFilter |
Unsigned32 (0..15) |
Read-create |
The value of this object is used to determine when to generate a pingProbeFailed NOTIFICATION. Setting BIT probeFailure(0) of object pingCtlTrapGeneration to '1' implies that a pingProbeFailed NOTIFICATION is generated only when the number of consecutive ping probes is equal to the value of pingCtlTrapProbeFailureFilter within a given ping test. After triggering the notification, the probe failure counter is reset to zero. |
The value ranges from 1 to 15. |
1.3.6.1.2.1.80.1.2.1.15 |
pingCtlTrapTestFailureFilter |
Unsigned32 (0..15) |
Read-create |
The value of this object is used to determine when to generate a pingTestFailed NOTIFICATION. Setting BIT testFailure(1) of object pingCtlTrapGeneration to '1' implies that a pingTestFailed NOTIFICATION is generated only when a number of consecutive ping tests equal to the value of pingCtlTrapProbeFailureFilter fail. After triggering the notification, the test failure counter is reset to zero. |
The value ranges from 1 to 15. |
1.3.6.1.2.1.80.1.2.1.16 |
pingCtlType |
OBJECT IDENTIFIER |
Read-create |
The value of this object is used either to report or to select the implementation method to be used for calculating a ping response time. The value of this object MAY be selected from pingImplementationTypeDomains. Additional implementation types SHOULD be allocated as required by implementers of the DISMAN-PING-MIB under their enterprise-specific registration point and not beneath pingImplementationTypeDomains. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.17 |
pingCtlDescr |
OCTET STRING (SIZE (0..255)) |
Read-create |
The purpose of this object is to provide a descriptive name of the remote ping test. |
The value ranges from 0 to 240. |
1.3.6.1.2.1.80.1.2.1.18 |
pingCtlSourceAddressType |
INTEGER{unknown(0),ipv4(1),ipv6(2),ipv4z(3),ipv6z(4),dns(16)} |
Read-create |
Specifies the type of the source address, pingCtlSourceAddress, to be used at a remote host when performing a ping operation. |
Only supports IPv4. |
1.3.6.1.2.1.80.1.2.1.19 |
pingCtlSourceAddress |
OCTET STRING (SIZE (0..255)) |
Read-create |
Use the specified IP address (which must be given in numeric form, not as a hostname) as the source address in outgoing probe packets. On hosts with more than one IP address, this option can be used to select the address to be used. If the IP address is not one of this machine's interface addresses, an error is returned and nothing is sent. A zero-length octet string value for this object disables source address specification. The address type (InetAddressType) that relates to this object is specified by the corresponding value of pingCtlSourceAddressType. |
Only supports IPv4. |
1.3.6.1.2.1.80.1.2.1.20 |
pingCtlIfIndex |
Integer32 (0..2147483647) |
Read-create |
Setting this object to an interface's ifIndex prior to starting a remote ping operation directs the ping probes to be transmitted over the specified interface. A value of zero for this object means that this option is not enabled. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.21 |
pingCtlByPassRouteTable |
INTEGER{true(1),false(2)} |
Read-create |
The purpose of this object is to optionally enable bypassing the routing table. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.22 |
pingCtlDSField |
Unsigned32 (0..255) |
Read-create |
Specifies the value to store in the Differentiated Services (DS) Field in the IP packet used to encapsulate the ping probe. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.2.1.23 |
pingCtlRowStatus |
INTEGER{active(1),notInService(2),notReady(3),createAndGo(4),createAndWait(5),destroy(6)} |
Read-create |
Specifies the Status of row. |
This object is not supported not: InService(2), notReady(3) and createAndWait(5). |
Creation Restriction
When creating this table, you must specify index pingCtlOwnerIndex, pingCtlTestName, and pingCtlType.
When setting the row, make sure to be accordant with the snmp v2 row-creating standard.
pingCtlTargetAddressType and pingCtlTargetAddress must be delivered simultaneously.
Modification Restriction
Modifying a single object is supported.
pingCtlRowStatus is set when the table row is created.
When the test team is carrying out the service testing, that is, when the pingCtlAdminStatus is enabled, the parameters, except pingCtlAdminStatus, of the test team cannot be modified.
Deletion Restriction
When the test team is operating service testing, that is, when the status of pingCtlAdminStatus is enabled, the test team cannot be deleted.
Entries in pingResultsTable and pingProbeHistoryTable will be deleted if you delete this table.
Access Restriction
The entries in this table can be read without restriction.
pingResultsTable
This table is used to save the test results. The index of this table is the index of the pingCtlTable. Each row of the pingCtlTable generates one row of the pingResultsTable only. When the test row is being tested, a test result is created correspondingly. The test-result parameter records the most updated test result only.
The indexes of this table are pingCtlOwnerIndex and pingCtlTestName.
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
---|---|---|---|---|---|
1.3.6.1.2.1.80.1.3.1.1 |
pingResultsOperStatus |
INTEGER { enabled(1), disabled(2), completed(3) } |
Read-only |
Reflects the operational state of a pingCtlEntry.
|
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.3.1.2 |
pingResultsIpTargetAddressType |
INTEGER{unknown(0),ipv4(1),ipv6(2),ipv4z(3),ipv6z(4),dns(16)} |
Read-only |
This object indicates the type of address stored in the corresponding pingResultsIpTargetAddress object. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.3.1.3 |
pingResultsIpTargetAddress |
InetAddress |
Read-only |
This object reports the IP address associated with a pingCtlTargetAddress value when the destination address is specified as a DNS name. The value of this object should be a zero-length octet string when a DNS name is not specified or when a specified DNS name fails to resolve. The address type (InetAddressType) that relates to this object is specified by the corresponding value of pingResultsIpTargetAddressType. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.3.1.4 |
pingResultsMinRtt |
INTEGER (0..4294967295) |
Read-only |
The minimum ping round-trip-time (RTT) received. A value of 0 for this object implies that no RTT has been received. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.3.1.5 |
pingResultsMaxRtt |
INTEGER (0..4294967295) |
Read-only |
The maximum ping round-trip-time (RTT) received. A value of 0 for this object implies that no RTT has been received. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.3.1.6 |
pingResultsAverageRtt |
INTEGER (0..4294967295) |
Read-only |
The current average ping round-trip-time (RTT). |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.3.1.7 |
pingResultsProbeResponses |
INTEGER (0..4294967295) |
Read-only |
Number of responses received for the corresponding pingCtlEntry and pingResultsEntry. The value of this object MUST be reported as 0 when no probe responses have been received. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.3.1.8 |
pingResultsSentProbes |
INTEGER (0..4294967295) |
Read-only |
The value of this object reflects the number of probes sent for the corresponding pingCtlEntry and pingResultsEntry. The value of this object MUST be reported as 0 when no probes have been sent. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.3.1.9 |
pingResultsRttSumOfSquares |
INTEGER (0..4294967295) |
Read-only |
This object contains the sum of the squares for all ping responses received. Its purpose is to enable standard deviation calculation. The value of this object MUST be reported as 0 when no ping responses have been received. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.3.1.10 |
pingResultsLastGoodProbe |
OCTET STRING (SIZE (8 | 11)) |
Read-only |
Date and time when the last response was received for a probe. |
This object is implemented as defined in the corresponding MIB files. |
Creation Restriction
This table cannot be set. Test results rows are automatically created when pingCtlTable carries out a test.
Modification Restriction
The entries in this table cannot be modified.
Deletion Restriction
The entries in this table cannot be deleted. When a row of the pingCtlTable is deleted, the system would delete the corresponding test results automatically.
Access Restriction
The entries in this table can be read without restriction.
pingProbeHistoryTable
This table is used to save the historical records of the HWPing service tests. The index of the pingCtlTable and the index of another gradually increasing object act together as the index of this table.
The indexes of this table are pingCtlOwnerIndex, pingCtlTestName, and pingProbeHistoryIndex.
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
---|---|---|---|---|---|
1.3.6.1.2.1.80.1.4.1.1 |
pingProbeHistoryIndex |
Unsigned32 (1..'ffffffff'h) |
Not-accessible |
An entry in this table is created when the result of a ping probe is determined. The initial 2 instance identifier index values identify the pingCtlEntry that a probe result (pingProbeHistoryEntry) belongs to. An implementation MUST start assigning pingProbeHistoryIndex values at 1 and wrap after exceeding the maximum possible value as defined by the limit of this object ('ffffffff'h). |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.4.1.2 |
pingProbeHistoryResponse |
INTEGER (0..4294967295) |
Read-only |
The amount of time measured in milliseconds from when a probe was sent to when its response was received or when it timed out. The value of this object is reported as 0 when it is not possible to transmit a probe. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.4.1.3 |
pingProbeHistoryStatus |
INTEGER {responseReceived(1),unknown(2),internalError(3),requestTimedOut(4),unknownDestinationAddress(5),noRouteToTarget(6),interfaceInactiveToTarget(7),arpFailure(8),maxConcurrentLimitReached(9),unableToResolveDnsName(10),invalidHostAddress(11)} |
Read-only |
The result of a particular probe done by a remote host. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.4.1.4 |
pingProbeHistoryLastRC |
Integer32 |
Read-only |
The last implementation-method-specific reply code received. If the ICMP Echo capability is being used, then a successful probe ends when an ICMP response is received that contains the code ICMP_ECHOREPLY(0). The ICMP codes are maintained by IANA. Standardized ICMP codes are listed at http://www.iana.org/assignments/icmp-parameters. The ICMPv6 codes are listed at http://www.iana.org/assignments/icmpv6-parameters. |
This object is implemented as defined in the corresponding MIB files. |
1.3.6.1.2.1.80.1.4.1.5 |
pingProbeHistoryTime |
OCTET STRING (SIZE (8 | 11)) |
Read-only |
Timestamp recorded when this probe result was determined. |
This object is implemented as defined in the corresponding MIB files. |
Creation Restriction
This table cannot be set. Test the auto created historical record row in the pingCtlTable.
Modification Restriction
The entries in this table cannot be modified.
Deletion Restriction
The entries in this table cannot be deleted. When a row of the pingCtlTabl is deleted, the system would delete the corresponding test historical record automatically.
Access Restriction
The entries in this table can be read without restriction.
Description of Alarm Objects
pingProbeFailed
OID |
Object Name |
Bound Variable |
Description |
Implemented Specifications |
---|---|---|---|---|
1.3.6.1.2.1.80.0.1 |
pingProbeFailed |
|
Generated when a probe failure is detected, when the corresponding pingCtlTrapGeneration object is set to probeFailure(0), subject to the value of pingCtlTrapProbeFailureFilter. The object pingCtlTrapProbeFailureFilter can be used to specify the number of consecutive probe failures that are required before this notification can be generated. |
This object is implemented as defined in the corresponding MIB files. |
pingTestFailed
OID |
Object Name |
Bound Variable |
Description |
Implemented Specifications |
---|---|---|---|---|
1.3.6.1.2.1.80.0.2 |
pingTestFailed |
|
Generated when a ping test is determined to have failed, when the corresponding pingCtlTrapGeneration object is set to testFailure(1). In this instance, pingCtlTrapTestFailureFilter should specify the number of probes in a test required to have failed in order to consider the test failed. |
This object is implemented as defined in the corresponding MIB files. |
pingTestCompleted
OID |
Object Name |
Bound Variable |
Description |
Implemented Specifications |
---|---|---|---|---|
1.3.6.1.2.1.80.0.3 |
pingTestCompleted |
|
Generated at the completion of a ping test when the corresponding pingCtlTrapGeneration object has the testCompletion(2) bit set. |
This object is implemented as defined in the corresponding MIB files. |