DISMAN-PING-MIB

File: DISMAN-PING-MIB.mib (43832 bytes)

Imported modules

SNMPv2-SMI SNMPv2-CONF SNMPv2-TC
IF-MIB SNMP-FRAMEWORK-MIB INET-ADDRESS-MIB

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Integer32
Unsigned32 mib-2 NOTIFICATION-TYPE
OBJECT-IDENTITY MODULE-COMPLIANCE OBJECT-GROUP
NOTIFICATION-GROUP TEXTUAL-CONVENTION RowStatus
StorageType DateAndTime TruthValue
InterfaceIndexOrZero SnmpAdminString InetAddressType
InetAddress

Defined Types

OperationResponseStatus  
Used to report the result of an operation: responseReceived(1) - Operation completes successfully. unknown(2) - Operation failed due to unknown error. internalError(3) - An implementation detected an error in its own processing that caused an operation to fail. requestTimedOut(4) - Operation failed to receive a valid reply within the time limit imposed on it. unknownDestinationAddress(5) - Invalid destination address. noRouteToTarget(6) - Could not find a route to target. interfaceInactiveToTarget(7) - The interface to be used in sending a probe is inactive without an alternate route existing. arpFailure(8) - Unable to resolve a target address to a media specific address. maxConcurrentLimitReached(9) - The maximum number of concurrent active operations would have been exceeded if the corresponding operation was allowed. unableToResolveDnsName(10) - The DNS name specified was unable to be mapped to an IP address. invalidHostAddress(11) - The IP address for a host has been determined to be invalid. Examples of this are broadcast or multicast addresses.
TEXTUAL-CONVENTION    
  INTEGER responseReceived(1), unknown(2), internalError(3), requestTimedOut(4), unknownDestinationAddress(5), noRouteToTarget(6), interfaceInactiveToTarget(7), arpFailure(8), maxConcurrentLimitReached(9), unableToResolveDnsName(10), invalidHostAddress(11)  

PingCtlEntry  
SEQUENCE    
  pingCtlOwnerIndex SnmpAdminString
  pingCtlTestName SnmpAdminString
  pingCtlTargetAddressType InetAddressType
  pingCtlTargetAddress InetAddress
  pingCtlDataSize Unsigned32
  pingCtlTimeOut Unsigned32
  pingCtlProbeCount Unsigned32
  pingCtlAdminStatus INTEGER
  pingCtlDataFill OCTET STRING
  pingCtlFrequency Unsigned32
  pingCtlMaxRows Unsigned32
  pingCtlStorageType StorageType
  pingCtlTrapGeneration BITS
  pingCtlTrapProbeFailureFilter Unsigned32
  pingCtlTrapTestFailureFilter Unsigned32
  pingCtlType OBJECT IDENTIFIER
  pingCtlDescr SnmpAdminString
  pingCtlSourceAddressType InetAddressType
  pingCtlSourceAddress InetAddress
  pingCtlIfIndex InterfaceIndexOrZero
  pingCtlByPassRouteTable TruthValue
  pingCtlDSField Unsigned32
  pingCtlRowStatus RowStatus

PingResultsEntry  
SEQUENCE    
  pingResultsOperStatus INTEGER
  pingResultsIpTargetAddressType InetAddressType
  pingResultsIpTargetAddress InetAddress
  pingResultsMinRtt Unsigned32
  pingResultsMaxRtt Unsigned32
  pingResultsAverageRtt Unsigned32
  pingResultsProbeResponses Unsigned32
  pingResultsSentProbes Unsigned32
  pingResultsRttSumOfSquares Unsigned32
  pingResultsLastGoodProbe DateAndTime

PingProbeHistoryEntry  
SEQUENCE    
  pingProbeHistoryIndex Unsigned32
  pingProbeHistoryResponse Unsigned32
  pingProbeHistoryStatus OperationResponseStatus
  pingProbeHistoryLastRC Integer32
  pingProbeHistoryTime DateAndTime

Defined Values

pingMIB 1.3.6.1.2.1.80
The Ping MIB (DISMAN-PING-MIB) provides the capability of controlling the use of the ping function at a remote host.
MODULE-IDENTITY    

pingNotifications 1.3.6.1.2.1.80.0
OBJECT IDENTIFIER    

pingObjects 1.3.6.1.2.1.80.1
OBJECT IDENTIFIER    

pingConformance 1.3.6.1.2.1.80.2
OBJECT IDENTIFIER    

pingImplementationTypeDomains 1.3.6.1.2.1.80.3
OBJECT IDENTIFIER    

pingIcmpEcho 1.3.6.1.2.1.80.3.1
Indicates that an implementation is using the Internet Control Message Protocol (ICMP) 'ECHO' facility.
OBJECT-IDENTITY    

pingUdpEcho 1.3.6.1.2.1.80.3.2
Indicates that an implementation is using the UDP echo port (7).
OBJECT-IDENTITY    

pingSnmpQuery 1.3.6.1.2.1.80.3.3
Indicates that an implementation is an SNMP query to calculate a round trip time.
OBJECT-IDENTITY    

pingTcpConnectionAttempt 1.3.6.1.2.1.80.3.4
Indicates that an implementation is attempting to connect to a TCP port in order to calculate a round trip time.
OBJECT-IDENTITY    

pingMaxConcurrentRequests 1.3.6.1.2.1.80.1.1
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.
OBJECT-TYPE    
  Unsigned32  

pingCtlTable 1.3.6.1.2.1.80.1.2
Defines the ping Control Table for providing, via SNMP, the capability of performing ping operations at a remote host. The results of these operations are stored in the pingResultsTable and the pingProbeHistoryTable.
OBJECT-TYPE    
  SEQUENCE OF  
    PingCtlEntry

pingCtlEntry 1.3.6.1.2.1.80.1.2.1
Defines an entry in the pingCtlTable. The first index element, pingCtlOwnerIndex, is of type SnmpAdminString, a textual convention that allows for use of the SNMPv3 View-Based Access Control Model (RFC 2575 [11], VACM) and allows an management application to identify its entries. The second index, pingCtlTestName (also an SnmpAdminString), enables the same management application to have multiple outstanding requests.
OBJECT-TYPE    
  PingCtlEntry  

pingCtlOwnerIndex 1.3.6.1.2.1.80.1.2.1.1
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 independently create or modify entries, the initial index is used as an 'owner index'. Such an initial index has a syntax of SnmpAdminString, and can thus be trivially mapped to a securityName or groupName as 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.
OBJECT-TYPE    
  SnmpAdminString Size(0..32)  

pingCtlTestName 1.3.6.1.2.1.80.1.2.1.2
The name of the ping test. This is locally unique, within the scope of an pingCtlOwnerIndex.
OBJECT-TYPE    
  SnmpAdminString Size(0..32)  

pingCtlTargetAddressType 1.3.6.1.2.1.80.1.2.1.3
Specifies the type of host address to be used at a remote host for performing a ping operation.
OBJECT-TYPE    
  InetAddressType  

pingCtlTargetAddress 1.3.6.1.2.1.80.1.2.1.4
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.
OBJECT-TYPE    
  InetAddress  

pingCtlDataSize 1.3.6.1.2.1.80.1.2.1.5
Specifies the size of the data portion to be transmitted in a ping operation in octets. A ping request is usually an ICMP message encoded into an IP packet. An IP packet has a maximum size of 65535 octets. Subtracting the size of the ICMP or UDP header (both 8 octets) and the size of the IP header (20 octets) yields a maximum size of 65507 octets.
OBJECT-TYPE    
  Unsigned32 0..65507  

pingCtlTimeOut 1.3.6.1.2.1.80.1.2.1.6
Specifies the time-out value, in seconds, for a remote ping operation.
OBJECT-TYPE    
  Unsigned32 1..60  

pingCtlProbeCount 1.3.6.1.2.1.80.1.2.1.7
Specifies the number of times to perform a ping operation at a remote host.
OBJECT-TYPE    
  Unsigned32 1..15  

pingCtlAdminStatus 1.3.6.1.2.1.80.1.2.1.8
Reflects the desired state that a pingCtlEntry should be in: enabled(1) - Attempt to activate the test as defined by this pingCtlEntry. disabled(2) - Deactivate the test as defined by this pingCtlEntry. Refer to the corresponding pingResultsOperStatus to determine the operational state of the test defined by this entry.
OBJECT-TYPE    
  INTEGER enabled(1), disabled(2)  

pingCtlDataFill 1.3.6.1.2.1.80.1.2.1.9
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.
OBJECT-TYPE    
  OCTET STRING Size(0..1024)  

pingCtlFrequency 1.3.6.1.2.1.80.1.2.1.10
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. After a single test completes the number of seconds as defined by the value of pingCtlFrequency MUST elapse before the next ping test is started. A value of 0 for this object implies that the test as defined by the corresponding entry will not be repeated.
OBJECT-TYPE    
  Unsigned32  

pingCtlMaxRows 1.3.6.1.2.1.80.1.2.1.11
The maximum number of entries allowed in the pingProbeHistoryTable. An implementation of this MIB will remove the oldest entry in the pingProbeHistoryTable to allow the addition of an new entry once the number of 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.
OBJECT-TYPE    
  Unsigned32  

pingCtlStorageType 1.3.6.1.2.1.80.1.2.1.12
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.
OBJECT-TYPE    
  StorageType  

pingCtlTrapGeneration 1.3.6.1.2.1.80.1.2.1.13
The value of this object determines when and if to generate a notification for this entry: probeFailure(0) - Generate a pingProbeFailed notification subject to the value of pingCtlTrapProbeFailureFilter. The object pingCtlTrapProbeFailureFilter can be used to specify the number of successive probe failures that are required before a pingProbeFailed notification can be generated. testFailure(1) - Generate a pingTestFailed notification. In this instance the object pingCtlTrapTestFailureFilter can be used to determine the number of probe failures that signal when a test fails. testCompletion(2) - Generate a pingTestCompleted notification. The value of this object defaults to zero, indicating that none of the above options have been selected.
OBJECT-TYPE    
  BITS probeFailure(0), testFailure(1), testCompletion(2)  

pingCtlTrapProbeFailureFilter 1.3.6.1.2.1.80.1.2.1.14
The value of this object is used to determine when to generate a pingProbeFailed NOTIFICATION. Setting pingCtlTrapGeneration to probeFailure(0) implies that a pingProbeFailed NOTIFICATION is generated only when the number of successive probe failures as indicated by the value of pingCtlTrapPrbefailureFilter fail within a given ping test.
OBJECT-TYPE    
  Unsigned32 0..15  

pingCtlTrapTestFailureFilter 1.3.6.1.2.1.80.1.2.1.15
The value of this object is used to determine when to generate a pingTestFailed NOTIFICATION. Setting pingCtlTrapGeneration to testFailure(1) implies that a pingTestFailed NOTIFICATION is generated only when the number of ping failures within a test exceed the value of pingCtlTrapTestFailureFilter.
OBJECT-TYPE    
  Unsigned32 0..15  

pingCtlType 1.3.6.1.2.1.80.1.2.1.16
The value of this object is used to either report or 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.
OBJECT-TYPE    
  OBJECT IDENTIFIER  

pingCtlDescr 1.3.6.1.2.1.80.1.2.1.17
The purpose of this object is to provide a descriptive name of the remote ping test.
OBJECT-TYPE    
  SnmpAdminString  

pingCtlSourceAddressType 1.3.6.1.2.1.80.1.2.1.18
Specifies the type of the source address, pingCtlSourceAddress, to be used at a remote host when performing a ping operation.
OBJECT-TYPE    
  InetAddressType  

pingCtlSourceAddress 1.3.6.1.2.1.80.1.2.1.19
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 force the source address to be something other than the primary IP address of the interface the probe packet is sent on. 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.
OBJECT-TYPE    
  InetAddress  

pingCtlIfIndex 1.3.6.1.2.1.80.1.2.1.20
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.
OBJECT-TYPE    
  InterfaceIndexOrZero  

pingCtlByPassRouteTable 1.3.6.1.2.1.80.1.2.1.21
The purpose of this object is to optionally enable bypassing the route table. If enabled, the remote host will bypass the normal routing tables and send directly to a host on an attached network. If the host is not on a directly-attached network, an error is returned. This option can be used to perform the ping operation to a local host through an interface that has no route defined (e.g., after the interface was dropped by routed).
OBJECT-TYPE    
  TruthValue  

pingCtlDSField 1.3.6.1.2.1.80.1.2.1.22
Specifies the value to store in the Differentiated Services (DS) Field in the IP packet used to encapsulate the ping probe. The DS Field is defined as the Type of Service (TOS) octet in a IPv4 header or as the Traffic Class octet in a IPv6 header. The value of this object must be a decimal integer in the range from 0 to 255. This option can be used to determine what effect an explicit DS Field setting has on a ping response. Not all values are legal or meaningful. A value of 0 means that the function represented by this option is not supported. DS Field usage is often not supported by IP implementations and not all values are supported. Refer to RFC 2474 for guidance on usage of this field.
OBJECT-TYPE    
  Unsigned32 0..255  

pingCtlRowStatus 1.3.6.1.2.1.80.1.2.1.23
This object allows entries to be created and deleted in the pingCtlTable. Deletion of an entry in this table results in all corresponding (same pingCtlOwnerIndex and pingCtlTestName index values) pingResultsTable and pingProbeHistoryTable entries being deleted. A value MUST be specified for pingCtlTargetAddress prior to a transition to active(1) state being accepted. Activation of a remote ping operation is controlled via pingCtlAdminStatus and not by changing this object's value to active(1). Transitions in and out of active(1) state are not allowed while an entry's pingResultsOperStatus is active(1) with the exception that deletion of an entry in this table by setting its RowStatus object to destroy(6) will stop an active ping operation. The operational state of a ping operation can be determined by examination of its pingResultsOperStatus object.
OBJECT-TYPE    
  RowStatus  

pingResultsTable 1.3.6.1.2.1.80.1.3
Defines the Ping Results Table for providing the capability of performing ping operations at a remote host. The results of these operations are stored in the pingResultsTable and the pingPastProbeTable. An entry is added to the pingResultsTable when an pingCtlEntry is started by successful transition of its pingCtlAdminStatus object to enabled(1). An entry is removed from the pingResultsTable when its corresponding pingCtlEntry is deleted.
OBJECT-TYPE    
  SEQUENCE OF  
    PingResultsEntry

pingResultsEntry 1.3.6.1.2.1.80.1.3.1
Defines an entry in the pingResultsTable. The pingResultsTable has the same indexing as the pingCtlTable in order for a pingResultsEntry to correspond to the pingCtlEntry that caused it to be created.
OBJECT-TYPE    
  PingResultsEntry  

pingResultsOperStatus 1.3.6.1.2.1.80.1.3.1.1
Reflects the operational state of a pingCtlEntry: enabled(1) - Test is active. disabled(2) - Test has stopped.
OBJECT-TYPE    
  INTEGER enabled(1), disabled(2)  

pingResultsIpTargetAddressType 1.3.6.1.2.1.80.1.3.1.2
This objects indicates the type of address stored in the corresponding pingResultsIpTargetAddress object.
OBJECT-TYPE    
  InetAddressType  

pingResultsIpTargetAddress 1.3.6.1.2.1.80.1.3.1.3
This objects 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.
OBJECT-TYPE    
  InetAddress  

pingResultsMinRtt 1.3.6.1.2.1.80.1.3.1.4
The minimum ping round-trip-time (RTT) received. A value of 0 for this object implies that no RTT has been received.
OBJECT-TYPE    
  Unsigned32  

pingResultsMaxRtt 1.3.6.1.2.1.80.1.3.1.5
The maximum ping round-trip-time (RTT) received. A value of 0 for this object implies that no RTT has been received.
OBJECT-TYPE    
  Unsigned32  

pingResultsAverageRtt 1.3.6.1.2.1.80.1.3.1.6
The current average ping round-trip-time (RTT).
OBJECT-TYPE    
  Unsigned32  

pingResultsProbeResponses 1.3.6.1.2.1.80.1.3.1.7
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.
OBJECT-TYPE    
  Unsigned32  

pingResultsSentProbes 1.3.6.1.2.1.80.1.3.1.8
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.
OBJECT-TYPE    
  Unsigned32  

pingResultsRttSumOfSquares 1.3.6.1.2.1.80.1.3.1.9
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.
OBJECT-TYPE    
  Unsigned32  

pingResultsLastGoodProbe 1.3.6.1.2.1.80.1.3.1.10
Date and time when the last response was received for a probe.
OBJECT-TYPE    
  DateAndTime  

pingProbeHistoryTable 1.3.6.1.2.1.80.1.4
Defines a table for storing the results of a ping operation. Entries in this table are limited by the value of the corresponding pingCtlMaxRows object. 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 entry is removed from this table when its corresponding pingCtlEntry is deleted. An implementation of this MIB will remove the oldest entry in the pingProbeHistoryTable to allow the addition of an new entry once the number of rows in the pingProbeHistoryTable reaches the value specified by pingCtlMaxRows.
OBJECT-TYPE    
  SEQUENCE OF  
    PingProbeHistoryEntry

pingProbeHistoryEntry 1.3.6.1.2.1.80.1.4.1
Defines an entry in the pingProbeHistoryTable. The first two index elements identify the pingCtlEntry that a pingProbeHistoryEntry belongs to. The third index element selects a single probe result.
OBJECT-TYPE    
  PingProbeHistoryEntry  

pingProbeHistoryIndex 1.3.6.1.2.1.80.1.4.1.1
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).
OBJECT-TYPE    
  Unsigned32 1..FFFFFFFF  

pingProbeHistoryResponse 1.3.6.1.2.1.80.1.4.1.2
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.
OBJECT-TYPE    
  Unsigned32  

pingProbeHistoryStatus 1.3.6.1.2.1.80.1.4.1.3
The result of a particular probe done by a remote host.
OBJECT-TYPE    
  OperationResponseStatus  

pingProbeHistoryLastRC 1.3.6.1.2.1.80.1.4.1.4
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 responses are defined normally in the ip_icmp include file.
OBJECT-TYPE    
  Integer32  

pingProbeHistoryTime 1.3.6.1.2.1.80.1.4.1.5
Timestamp for when this probe result was determined.
OBJECT-TYPE    
  DateAndTime  

pingProbeFailed 1.3.6.1.2.1.80.0.1
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 successive probe failures that are required before this notification can be generated.
NOTIFICATION-TYPE    

pingTestFailed 1.3.6.1.2.1.80.0.2
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 as failed.
NOTIFICATION-TYPE    

pingTestCompleted 1.3.6.1.2.1.80.0.3
Generated at the completion of a ping test when the corresponding pingCtlTrapGeneration object is set to testCompletion(4).
NOTIFICATION-TYPE    

pingCompliances 1.3.6.1.2.1.80.2.1
OBJECT IDENTIFIER    

pingGroups 1.3.6.1.2.1.80.2.2
OBJECT IDENTIFIER    

pingCompliance 1.3.6.1.2.1.80.2.1.1
The compliance statement for the DISMAN-PING-MIB.
MODULE-COMPLIANCE    

pingGroup 1.3.6.1.2.1.80.2.2.1
The group of objects that comprise the remote ping capability.
OBJECT-GROUP    

pingTimeStampGroup 1.3.6.1.2.1.80.2.2.2
The group of DateAndTime objects.
OBJECT-GROUP    

pingNotificationsGroup 1.3.6.1.2.1.80.2.2.3
The notification which are required to be supported by implementations of this MIB.
NOTIFICATION-GROUP