home *** CD-ROM | disk | FTP | other *** search
/ Thomson (Residential) / TGSTPv7203.iso / mac / SNMP_MIBs / extended / DISMAN-PING-MIB.mib < prev    next >
Text File  |  2008-02-08  |  41KB  |  1,162 lines
  1. DISMAN-PING-MIB DEFINITIONS ::= BEGIN
  2.  
  3.  
  4. IMPORTS
  5.     MODULE-IDENTITY, OBJECT-TYPE, Integer32,
  6.     Unsigned32, mib-2,
  7.     NOTIFICATION-TYPE, OBJECT-IDENTITY
  8.         FROM SNMPv2-SMI                  -- RFC2578
  9.     TEXTUAL-CONVENTION, RowStatus,
  10.     StorageType, DateAndTime, TruthValue
  11.         FROM SNMPv2-TC                   -- RFC2579
  12.     MODULE-COMPLIANCE, OBJECT-GROUP,
  13.     NOTIFICATION-GROUP
  14.         FROM SNMPv2-CONF                 -- RFC2580
  15.     InterfaceIndexOrZero                 -- RFC2863
  16.         FROM IF-MIB
  17.     SnmpAdminString
  18.         FROM SNMP-FRAMEWORK-MIB          -- RFC2571
  19.     InetAddressType, InetAddress
  20.         FROM INET-ADDRESS-MIB;           -- RFC2851
  21.  
  22.  pingMIB MODULE-IDENTITY
  23.     LAST-UPDATED "200009210000Z"         -- 21 September 2000
  24.     ORGANIZATION "IETF Distributed Management Working Group"
  25.     CONTACT-INFO
  26.  
  27.         "Kenneth White
  28.  
  29.         International Business Machines Corporation
  30.         Network Computing Software Division
  31.         Research Triangle Park, NC, USA
  32.  
  33.         E-mail: wkenneth@us.ibm.com"
  34.     DESCRIPTION
  35.         "The Ping MIB (DISMAN-PING-MIB) provides the capability of
  36.         controlling the use of the ping function at a remote
  37.         host."
  38.  
  39.      --  Revision history
  40.  
  41.      REVISION     "200009210000Z"         -- 21 September 2000
  42.      DESCRIPTION
  43.          "Initial version, published as RFC 2925."
  44.  
  45.     ::= { mib-2 80 }
  46.  
  47.  -- Textual Conventions
  48.  
  49.   OperationResponseStatus ::= TEXTUAL-CONVENTION
  50.     STATUS  current
  51.     DESCRIPTION
  52.         "Used to report the result of an operation:
  53.  
  54.          responseReceived(1) - Operation completes successfully.
  55.          unknown(2) - Operation failed due to unknown error.
  56.          internalError(3) - An implementation detected an error
  57.               in its own processing that caused an operation
  58.               to fail.
  59.          requestTimedOut(4) - Operation failed to receive a
  60.               valid reply within the time limit imposed on it.
  61.          unknownDestinationAddress(5) - Invalid destination
  62.               address.
  63.          noRouteToTarget(6) - Could not find a route to target.
  64.          interfaceInactiveToTarget(7) - The interface to be
  65.               used in sending a probe is inactive without an
  66.               alternate route existing.
  67.          arpFailure(8) - Unable to resolve a target address to a
  68.               media specific address.
  69.          maxConcurrentLimitReached(9) - The maximum number of
  70.               concurrent active operations would have been exceeded
  71.               if the corresponding operation was allowed.
  72.          unableToResolveDnsName(10) - The DNS name specified was
  73.               unable to be mapped to an IP address.
  74.          invalidHostAddress(11) - The IP address for a host
  75.  
  76.               has been determined to be invalid.  Examples of this
  77.               are broadcast or multicast addresses."
  78.     SYNTAX INTEGER {
  79.                  responseReceived(1),
  80.                  unknown(2),
  81.                  internalError(3),
  82.                  requestTimedOut(4),
  83.                  unknownDestinationAddress(5),
  84.                  noRouteToTarget(6),
  85.                  interfaceInactiveToTarget(7),
  86.                  arpFailure(8),
  87.                  maxConcurrentLimitReached(9),
  88.                  unableToResolveDnsName(10),
  89.                  invalidHostAddress(11)
  90.               }
  91.  
  92.  -- Top level structure of the MIB
  93.  
  94.  pingNotifications              OBJECT IDENTIFIER ::= { pingMIB 0 }
  95.  pingObjects                    OBJECT IDENTIFIER ::= { pingMIB 1 }
  96.  pingConformance                OBJECT IDENTIFIER ::= { pingMIB 2 }
  97.  
  98.  -- The registration node (point) for ping implementation types
  99.  
  100.  pingImplementationTypeDomains  OBJECT IDENTIFIER ::= { pingMIB 3 }
  101.  
  102.  pingIcmpEcho OBJECT-IDENTITY
  103.     STATUS      current
  104.     DESCRIPTION
  105.         "Indicates that an implementation is using the Internet
  106.         Control Message Protocol (ICMP) 'ECHO' facility."
  107.     ::= { pingImplementationTypeDomains 1 }
  108.  
  109.  pingUdpEcho OBJECT-IDENTITY
  110.     STATUS      current
  111.     DESCRIPTION
  112.         "Indicates that an implementation is using the UDP echo
  113.         port (7)."
  114.     REFERENCE
  115.         "RFC 862, 'Echo Protocol'."
  116.     ::= { pingImplementationTypeDomains 2 }
  117.  
  118.  pingSnmpQuery OBJECT-IDENTITY
  119.     STATUS      current
  120.     DESCRIPTION
  121.         "Indicates that an implementation is an SNMP query to
  122.         calculate a round trip time."
  123.  
  124.     ::= { pingImplementationTypeDomains 3 }
  125.  
  126.  pingTcpConnectionAttempt OBJECT-IDENTITY
  127.     STATUS      current
  128.     DESCRIPTION
  129.         "Indicates that an implementation is attempting to
  130.         connect to a TCP port in order to calculate a round
  131.         trip time."
  132.     ::= { pingImplementationTypeDomains 4 }
  133.  
  134.  -- Simple Object Definitions
  135.  
  136.  pingMaxConcurrentRequests OBJECT-TYPE
  137.     SYNTAX      Unsigned32
  138.     UNITS       "requests"
  139.     MAX-ACCESS  read-write
  140.     STATUS      current
  141.     DESCRIPTION
  142.        "The maximum number of concurrent active ping requests
  143.        that are allowed within an agent implementation.  A value
  144.        of 0 for this object implies that there is no limit for
  145.        the number of concurrent active requests in effect."
  146.     DEFVAL { 10 }
  147.     ::= { pingObjects 1 }
  148.  
  149.  -- Ping Control Table
  150.  
  151.  pingCtlTable OBJECT-TYPE
  152.     SYNTAX      SEQUENCE OF PingCtlEntry
  153.     MAX-ACCESS  not-accessible
  154.     STATUS      current
  155.     DESCRIPTION
  156.         "Defines the ping Control Table for providing, via SNMP,
  157.         the capability of performing ping operations at
  158.         a remote host.  The results of these operations are
  159.         stored in the pingResultsTable and the
  160.         pingProbeHistoryTable."
  161.    ::= { pingObjects 2 }
  162.  
  163.  pingCtlEntry OBJECT-TYPE
  164.     SYNTAX      PingCtlEntry
  165.     MAX-ACCESS  not-accessible
  166.     STATUS      current
  167.     DESCRIPTION
  168.         "Defines an entry in the pingCtlTable.  The first index
  169.         element, pingCtlOwnerIndex, is of type SnmpAdminString,
  170.         a textual convention that allows for use of the SNMPv3
  171.  
  172.         View-Based Access Control Model (RFC 2575 [11], VACM)
  173.         and allows an management application to identify its
  174.         entries.  The second index, pingCtlTestName (also an
  175.         SnmpAdminString), enables the same management
  176.         application to have multiple outstanding requests."
  177.     INDEX {
  178.              pingCtlOwnerIndex,
  179.              pingCtlTestName
  180.           }
  181.     ::= { pingCtlTable 1 }
  182.  
  183.  PingCtlEntry ::=
  184.     SEQUENCE {
  185.         pingCtlOwnerIndex             SnmpAdminString,
  186.         pingCtlTestName               SnmpAdminString,
  187.         pingCtlTargetAddressType      InetAddressType,
  188.         pingCtlTargetAddress          InetAddress,
  189.         pingCtlDataSize               Unsigned32,
  190.         pingCtlTimeOut                Unsigned32,
  191.         pingCtlProbeCount             Unsigned32,
  192.         pingCtlAdminStatus            INTEGER,
  193.         pingCtlDataFill               OCTET STRING,
  194.         pingCtlFrequency              Unsigned32,
  195.         pingCtlMaxRows                Unsigned32,
  196.         pingCtlStorageType            StorageType,
  197.         pingCtlTrapGeneration         BITS,
  198.         pingCtlTrapProbeFailureFilter Unsigned32,
  199.         pingCtlTrapTestFailureFilter  Unsigned32,
  200.         pingCtlType                   OBJECT IDENTIFIER,
  201.         pingCtlDescr                  SnmpAdminString,
  202.         pingCtlSourceAddressType      InetAddressType,
  203.         pingCtlSourceAddress          InetAddress,
  204.         pingCtlIfIndex                InterfaceIndexOrZero,
  205.         pingCtlByPassRouteTable       TruthValue,
  206.         pingCtlDSField                Unsigned32,
  207.         pingCtlRowStatus              RowStatus
  208.     }
  209.  
  210.  pingCtlOwnerIndex OBJECT-TYPE
  211.     SYNTAX      SnmpAdminString (SIZE(0..32))
  212.     MAX-ACCESS  not-accessible
  213.     STATUS      current
  214.     DESCRIPTION
  215.        "To facilitate the provisioning of access control by a
  216.        security administrator using the View-Based Access
  217.        Control Model (RFC 2575, VACM) for tables in which
  218.        multiple users may need to independently create or
  219.        modify entries, the initial index is used as an 'owner
  220.  
  221.        index'.  Such an initial index has a syntax of
  222.        SnmpAdminString, and can thus be trivially mapped to a
  223.        securityName or groupName as defined in VACM, in
  224.        accordance with a security policy.
  225.  
  226.        When used in conjunction with such a security policy all
  227.        entries in the table belonging to a particular user (or
  228.        group) will have the same value for this initial index.
  229.        For a given user's entries in a particular table, the
  230.        object identifiers for the information in these entries
  231.        will have the same subidentifiers (except for the 'column'
  232.        subidentifier) up to the end of the encoded owner index.
  233.        To configure VACM to permit access to this portion of the
  234.        table, one would create vacmViewTreeFamilyTable entries
  235.        with the value of vacmViewTreeFamilySubtree including
  236.        the owner index portion, and vacmViewTreeFamilyMask
  237.        'wildcarding' the column subidentifier.  More elaborate
  238.        configurations are possible."
  239.     ::= { pingCtlEntry 1 }
  240.  
  241.  pingCtlTestName OBJECT-TYPE
  242.     SYNTAX      SnmpAdminString (SIZE(0..32))
  243.     MAX-ACCESS  not-accessible
  244.     STATUS      current
  245.     DESCRIPTION
  246.         "The name of the ping test.  This is locally unique, within
  247.         the scope of an pingCtlOwnerIndex."
  248.     ::= { pingCtlEntry 2 }
  249.  
  250.  pingCtlTargetAddressType OBJECT-TYPE
  251.     SYNTAX      InetAddressType
  252.     MAX-ACCESS  read-create
  253.     STATUS      current
  254.     DESCRIPTION
  255.         "Specifies the type of host address to be used at a remote
  256.         host for performing a ping operation."
  257.     DEFVAL { unknown }
  258.     ::= { pingCtlEntry 3 }
  259.  
  260.  pingCtlTargetAddress OBJECT-TYPE
  261.     SYNTAX      InetAddress
  262.     MAX-ACCESS  read-create
  263.     STATUS      current
  264.     DESCRIPTION
  265.         "Specifies the host address to be used at a remote host for
  266.         performing a ping operation.  The host address type is
  267.         determined by the object value of corresponding
  268.         pingCtlTargetAddressType.
  269.  
  270.         A value for this object MUST be set prior to transitioning
  271.         its corresponding pingCtlEntry to active(1) via
  272.         pingCtlRowStatus."
  273.     DEFVAL { ''H }
  274.     ::= { pingCtlEntry 4 }
  275.  
  276.  pingCtlDataSize OBJECT-TYPE
  277.     SYNTAX      Unsigned32 (0..65507)
  278.     UNITS       "octets"
  279.     MAX-ACCESS  read-create
  280.     STATUS      current
  281.     DESCRIPTION
  282.         "Specifies the size of the data portion to be
  283.         transmitted in a ping operation in octets.  A ping
  284.         request is usually an ICMP message encoded
  285.         into an IP packet.  An IP packet has a maximum size
  286.         of 65535 octets.  Subtracting the size of the ICMP
  287.         or UDP header (both 8 octets) and the size of the IP
  288.         header (20 octets) yields a maximum size of 65507
  289.         octets."
  290.     DEFVAL { 0 }
  291.     ::= { pingCtlEntry 5 }
  292.  
  293.  pingCtlTimeOut OBJECT-TYPE
  294.     SYNTAX      Unsigned32 (1..60)
  295.     UNITS       "seconds"
  296.     MAX-ACCESS  read-create
  297.     STATUS      current
  298.     DESCRIPTION
  299.         "Specifies the time-out value, in seconds, for a
  300.         remote ping operation."
  301.     DEFVAL { 3 }
  302.     ::= { pingCtlEntry 6 }
  303.  
  304.  pingCtlProbeCount OBJECT-TYPE
  305.     SYNTAX      Unsigned32 (1..15)
  306.     UNITS       "probes"
  307.     MAX-ACCESS  read-create
  308.     STATUS      current
  309.     DESCRIPTION
  310.         "Specifies the number of times to perform a ping
  311.         operation at a remote host."
  312.     DEFVAL { 1 }
  313.     ::= { pingCtlEntry 7 }
  314.  
  315.  pingCtlAdminStatus OBJECT-TYPE
  316.     SYNTAX      INTEGER {
  317.                           enabled(1), -- test should be started
  318.  
  319.                           disabled(2) -- test should be stopped
  320.                         }
  321.     MAX-ACCESS  read-create
  322.     STATUS      current
  323.     DESCRIPTION
  324.         "Reflects the desired state that a pingCtlEntry should be
  325.         in:
  326.  
  327.            enabled(1)  - Attempt to activate the test as defined by
  328.                          this pingCtlEntry.
  329.            disabled(2) - Deactivate the test as defined by this
  330.                          pingCtlEntry.
  331.  
  332.         Refer to the corresponding pingResultsOperStatus to
  333.         determine the operational state of the test defined by
  334.         this entry."
  335.      DEFVAL { disabled }
  336.     ::= { pingCtlEntry 8 }
  337.  
  338.  pingCtlDataFill  OBJECT-TYPE
  339.     SYNTAX      OCTET STRING (SIZE(0..1024))
  340.     MAX-ACCESS  read-create
  341.     STATUS      current
  342.     DESCRIPTION
  343.         "The content of this object is used together with the
  344.         corresponding pingCtlDataSize value to determine how to
  345.         fill the data portion of a probe packet.  The option of
  346.         selecting a data fill pattern can be useful when links
  347.         are compressed or have data pattern sensitivities. The
  348.         contents of pingCtlDataFill should be repeated in a ping
  349.         packet when the size of the data portion of the ping
  350.         packet is greater than the size of pingCtlDataFill."
  351.     DEFVAL { '00'H }
  352.     ::= { pingCtlEntry 9 }
  353.  
  354.  pingCtlFrequency  OBJECT-TYPE
  355.     SYNTAX      Unsigned32
  356.     UNITS       "seconds"
  357.     MAX-ACCESS  read-create
  358.     STATUS      current
  359.     DESCRIPTION
  360.         "The number of seconds to wait before repeating a ping test
  361.         as defined by the value of the various objects in the
  362.         corresponding row.
  363.  
  364.         A single ping test consists of a series of ping probes.
  365.         The number of probes is determined by the value of the
  366.         corresponding pingCtlProbeCount object.  After a single
  367.  
  368.         test completes the number of seconds as defined by the
  369.         value of pingCtlFrequency MUST elapse before the
  370.         next ping test is started.
  371.  
  372.         A value of 0 for this object implies that the test
  373.         as defined by the corresponding entry will not be
  374.         repeated."
  375.     DEFVAL { 0 }
  376.     ::= { pingCtlEntry 10 }
  377.  
  378.  pingCtlMaxRows OBJECT-TYPE
  379.     SYNTAX      Unsigned32
  380.     UNITS       "rows"
  381.     MAX-ACCESS  read-create
  382.     STATUS      current
  383.     DESCRIPTION
  384.         "The maximum number of entries allowed in the
  385.         pingProbeHistoryTable.  An implementation of this
  386.         MIB will remove the oldest entry in the
  387.         pingProbeHistoryTable to allow the addition of an
  388.         new entry once the number of rows in the
  389.         pingProbeHistoryTable reaches this value.
  390.  
  391.         Old entries are not removed when a new test is
  392.         started.  Entries are added to the pingProbeHistoryTable
  393.         until pingCtlMaxRows is reached before entries begin to
  394.         be removed.
  395.  
  396.         A value of 0 for this object disables creation of
  397.         pingProbeHistoryTable entries."
  398.     DEFVAL      { 50 }
  399.     ::= { pingCtlEntry 11 }
  400.  
  401.  pingCtlStorageType OBJECT-TYPE
  402.     SYNTAX      StorageType
  403.     MAX-ACCESS  read-create
  404.     STATUS      current
  405.     DESCRIPTION
  406.         "The storage type for this conceptual row.
  407.         Conceptual rows having the value 'permanent' need not
  408.         allow write-access to any columnar objects in the row."
  409.     DEFVAL { nonVolatile }
  410.     ::= { pingCtlEntry 12 }
  411.  
  412.  pingCtlTrapGeneration OBJECT-TYPE
  413.     SYNTAX      BITS {
  414.                    probeFailure(0),
  415.                    testFailure(1),
  416.  
  417.                    testCompletion(2)
  418.                   }
  419.     MAX-ACCESS  read-create
  420.     STATUS      current
  421.     DESCRIPTION
  422.         "The value of this object determines when and if
  423.         to generate a notification for this entry:
  424.  
  425.         probeFailure(0)   - Generate a pingProbeFailed
  426.             notification subject to the value of
  427.             pingCtlTrapProbeFailureFilter.  The object
  428.             pingCtlTrapProbeFailureFilter can be used
  429.             to specify the number of successive probe failures
  430.             that are required before a pingProbeFailed
  431.             notification can be generated.
  432.         testFailure(1)    - Generate a pingTestFailed
  433.             notification. In this instance the object
  434.             pingCtlTrapTestFailureFilter can be used to
  435.             determine the number of probe failures that
  436.             signal when a test fails.
  437.         testCompletion(2) - Generate a pingTestCompleted
  438.             notification.
  439.  
  440.         The value of this object defaults to zero, indicating
  441.         that none of the above options have been selected."
  442.     ::= { pingCtlEntry 13 }
  443.  
  444.  pingCtlTrapProbeFailureFilter OBJECT-TYPE
  445.     SYNTAX      Unsigned32 (0..15)
  446.     MAX-ACCESS  read-create
  447.     STATUS      current
  448.     DESCRIPTION
  449.         "The value of this object is used to determine when
  450.         to generate a pingProbeFailed NOTIFICATION.
  451.  
  452.         Setting pingCtlTrapGeneration
  453.         to probeFailure(0) implies that a pingProbeFailed
  454.         NOTIFICATION is generated only when the number of
  455.         successive probe failures as indicated by the
  456.         value of pingCtlTrapPrbefailureFilter fail within
  457.         a given ping test."
  458.     DEFVAL { 1 }
  459.     ::= { pingCtlEntry 14 }
  460.  
  461.  pingCtlTrapTestFailureFilter OBJECT-TYPE
  462.     SYNTAX      Unsigned32 (0..15)
  463.     MAX-ACCESS  read-create
  464.     STATUS      current
  465.  
  466.     DESCRIPTION
  467.         "The value of this object is used to determine when
  468.         to generate a pingTestFailed NOTIFICATION.
  469.  
  470.         Setting pingCtlTrapGeneration to testFailure(1)
  471.         implies that a pingTestFailed NOTIFICATION is
  472.         generated only when the number of ping failures
  473.         within a test exceed the value of
  474.         pingCtlTrapTestFailureFilter."
  475.     DEFVAL { 1 }
  476.     ::= { pingCtlEntry 15 }
  477.  
  478.  pingCtlType OBJECT-TYPE
  479.     SYNTAX      OBJECT IDENTIFIER
  480.     MAX-ACCESS  read-create
  481.     STATUS      current
  482.     DESCRIPTION
  483.         "The value of this object is used to either report or
  484.         select the implementation method to be used for
  485.         calculating a ping response time.  The value of this
  486.         object MAY be selected from pingImplementationTypeDomains.
  487.  
  488.         Additional implementation types SHOULD be allocated as
  489.         required by implementers of the DISMAN-PING-MIB under
  490.         their enterprise specific registration point and not
  491.         beneath pingImplementationTypeDomains."
  492.     DEFVAL { pingIcmpEcho }
  493.     ::= { pingCtlEntry 16 }
  494.  
  495.  pingCtlDescr OBJECT-TYPE
  496.     SYNTAX      SnmpAdminString
  497.     MAX-ACCESS  read-create
  498.     STATUS      current
  499.     DESCRIPTION
  500.         "The purpose of this object is to provide a
  501.         descriptive name of the remote ping test."
  502.     DEFVAL { '00'H }
  503.     ::= { pingCtlEntry 17 }
  504.  
  505.  pingCtlSourceAddressType OBJECT-TYPE
  506.     SYNTAX      InetAddressType
  507.     MAX-ACCESS  read-create
  508.     STATUS      current
  509.     DESCRIPTION
  510.         "Specifies the type of the source address,
  511.         pingCtlSourceAddress, to be used at a remote host
  512.         when performing a ping operation."
  513.     DEFVAL { ipv4 }
  514.  
  515.     ::= { pingCtlEntry 18 }
  516.  
  517.   pingCtlSourceAddress OBJECT-TYPE
  518.     SYNTAX      InetAddress
  519.     MAX-ACCESS  read-create
  520.     STATUS      current
  521.     DESCRIPTION
  522.         "Use the specified IP address (which must be given
  523.         in numeric form, not as a hostname) as the source
  524.         address in outgoing probe packets.  On hosts with
  525.         more than one IP address, this option can be used
  526.         to force the source address to be something other
  527.         than the primary IP address of the interface the
  528.         probe packet is sent on.  If the IP address is not
  529.         one of this machine's interface addresses, an error
  530.         is returned and nothing is sent.  A zero length
  531.         octet string value for this object disables source
  532.         address specification.
  533.  
  534.         The address type (InetAddressType) that relates to
  535.         this object is specified by the corresponding value
  536.         of pingCtlSourceAddressType."
  537.     DEFVAL { ''H }
  538.     ::= { pingCtlEntry 19 }
  539.  
  540.  pingCtlIfIndex OBJECT-TYPE
  541.     SYNTAX      InterfaceIndexOrZero
  542.     MAX-ACCESS  read-create
  543.     STATUS      current
  544.     DESCRIPTION
  545.         "Setting this object to an interface's ifIndex prior
  546.         to starting a remote ping operation directs
  547.         the ping probes to be transmitted over the
  548.         specified interface.  A value of zero for this object
  549.         means that this option is not enabled."
  550.     DEFVAL { 0 }
  551.     ::= { pingCtlEntry 20 }
  552.  
  553.  pingCtlByPassRouteTable OBJECT-TYPE
  554.     SYNTAX TruthValue
  555.     MAX-ACCESS  read-create
  556.     STATUS      current
  557.     DESCRIPTION
  558.        "The purpose of this object is to optionally enable
  559.        bypassing the route table.  If enabled, the remote
  560.        host will bypass the normal routing tables and send
  561.        directly to a host on an attached network.  If the
  562.        host is not on a directly-attached network, an
  563.  
  564.        error is returned.  This option can be used to perform
  565.        the ping operation to a local host through an
  566.        interface that has no route defined (e.g., after the
  567.        interface was dropped by routed)."
  568.     DEFVAL { false }
  569.     ::= { pingCtlEntry 21 }
  570.  
  571.  pingCtlDSField OBJECT-TYPE
  572.     SYNTAX      Unsigned32 (0..255)
  573.     MAX-ACCESS  read-create
  574.     STATUS      current
  575.     DESCRIPTION
  576.         "Specifies the value to store in the Differentiated
  577.         Services (DS) Field in the IP packet used to
  578.         encapsulate the ping probe.  The DS Field is defined
  579.         as the Type of Service (TOS) octet in a IPv4 header
  580.         or as the Traffic Class octet in a IPv6 header.
  581.  
  582.         The value of this object must be a decimal integer
  583.         in the range from 0 to 255.  This option can be used
  584.         to determine what effect an explicit DS Field setting
  585.         has on a ping response.  Not all values are legal or
  586.         meaningful.  A value of 0 means that the function
  587.      represented by this option is not supported.  DS Field
  588.      usage is often not supported by IP implementations and
  589.      not all values are supported.  Refer to RFC 2474 for
  590.      guidance on usage of this field."
  591.     REFERENCE
  592.         "Refer to RFC 2474 for the definition of the
  593.         Differentiated Services Field and to RFC 1812
  594.         Section 5.3.2 for Type of Service (TOS)."
  595.     DEFVAL { 0 }
  596.     ::= { pingCtlEntry 22 }
  597.  
  598.  pingCtlRowStatus OBJECT-TYPE
  599.     SYNTAX      RowStatus
  600.     MAX-ACCESS  read-create
  601.     STATUS      current
  602.     DESCRIPTION
  603.         "This object allows entries to be created and deleted
  604.         in the pingCtlTable.  Deletion of an entry in this
  605.         table results in all corresponding (same
  606.         pingCtlOwnerIndex and pingCtlTestName index values)
  607.         pingResultsTable and pingProbeHistoryTable entries
  608.         being deleted.
  609.  
  610.         A value MUST be specified for pingCtlTargetAddress
  611.         prior to a transition to active(1) state being
  612.  
  613.         accepted.
  614.  
  615.         Activation of a remote ping operation is controlled
  616.         via pingCtlAdminStatus and not by changing
  617.         this object's value to active(1).
  618.  
  619.         Transitions in and out of active(1) state are not
  620.         allowed while an entry's pingResultsOperStatus is
  621.         active(1) with the exception that deletion of
  622.         an entry in this table by setting its RowStatus
  623.         object to destroy(6) will stop an active
  624.         ping operation.
  625.  
  626.         The operational state of a ping operation
  627.         can be determined by examination of its
  628.         pingResultsOperStatus object."
  629.     REFERENCE
  630.         "See definition of RowStatus in RFC 2579, 'Textual
  631.         Conventions for SMIv2.'"
  632.     ::= { pingCtlEntry 23 }
  633.  
  634. -- Ping Results Table
  635.  
  636.  pingResultsTable OBJECT-TYPE
  637.     SYNTAX      SEQUENCE OF PingResultsEntry
  638.     MAX-ACCESS  not-accessible
  639.     STATUS      current
  640.     DESCRIPTION
  641.         "Defines the Ping Results Table for providing
  642.         the capability of performing ping operations at
  643.         a remote host.  The results of these operations are
  644.         stored in the pingResultsTable and the pingPastProbeTable.
  645.  
  646.         An entry is added to the pingResultsTable when an
  647.         pingCtlEntry is started by successful transition
  648.         of its pingCtlAdminStatus object to enabled(1).
  649.         An entry is removed from the pingResultsTable when
  650.         its corresponding pingCtlEntry is deleted."
  651.    ::= { pingObjects 3 }
  652.  
  653.  pingResultsEntry OBJECT-TYPE
  654.     SYNTAX      PingResultsEntry
  655.     MAX-ACCESS  not-accessible
  656.     STATUS      current
  657.     DESCRIPTION
  658.         "Defines an entry in the pingResultsTable.  The
  659.         pingResultsTable has the same indexing as the
  660.         pingCtlTable in order for a pingResultsEntry to
  661.  
  662.         correspond to the pingCtlEntry that caused it to
  663.         be created."
  664.     INDEX {
  665.              pingCtlOwnerIndex,
  666.              pingCtlTestName
  667.           }
  668.     ::= { pingResultsTable 1 }
  669.  
  670.  PingResultsEntry ::=
  671.     SEQUENCE {
  672.         pingResultsOperStatus          INTEGER,
  673.         pingResultsIpTargetAddressType InetAddressType,
  674.         pingResultsIpTargetAddress     InetAddress,
  675.         pingResultsMinRtt              Unsigned32,
  676.         pingResultsMaxRtt              Unsigned32,
  677.         pingResultsAverageRtt          Unsigned32,
  678.         pingResultsProbeResponses      Unsigned32,
  679.         pingResultsSentProbes          Unsigned32,
  680.         pingResultsRttSumOfSquares     Unsigned32,
  681.         pingResultsLastGoodProbe       DateAndTime
  682.      }
  683.  
  684.  pingResultsOperStatus OBJECT-TYPE
  685.     SYNTAX      INTEGER {
  686.                           enabled(1),  -- test is in progress
  687.                           disabled(2)  -- test has stopped
  688.                         }
  689.     MAX-ACCESS  read-only
  690.     STATUS      current
  691.     DESCRIPTION
  692.         "Reflects the operational state of a pingCtlEntry:
  693.            enabled(1)   - Test is active.
  694.            disabled(2)  - Test has stopped."
  695.     ::= { pingResultsEntry 1 }
  696.  
  697.  pingResultsIpTargetAddressType OBJECT-TYPE
  698.     SYNTAX      InetAddressType
  699.     MAX-ACCESS  read-only
  700.     STATUS      current
  701.     DESCRIPTION
  702.         "This objects indicates the type of address stored
  703.         in the corresponding pingResultsIpTargetAddress
  704.         object."
  705.     DEFVAL { unknown }
  706.     ::= { pingResultsEntry 2 }
  707.  
  708.  pingResultsIpTargetAddress OBJECT-TYPE
  709.     SYNTAX      InetAddress
  710.  
  711.     MAX-ACCESS  read-only
  712.     STATUS      current
  713.     DESCRIPTION
  714.         "This objects reports the IP address associated
  715.         with a pingCtlTargetAddress value when the destination
  716.         address is specified as a DNS name.  The value of
  717.         this object should be a zero length octet string
  718.         when a DNS name is not specified or when a
  719.         specified DNS name fails to resolve."
  720.     DEFVAL { ''H }
  721.     ::= { pingResultsEntry 3 }
  722.  
  723.  pingResultsMinRtt OBJECT-TYPE
  724.     SYNTAX      Unsigned32
  725.     UNITS       "milliseconds"
  726.     MAX-ACCESS  read-only
  727.     STATUS      current
  728.     DESCRIPTION
  729.         "The minimum ping round-trip-time (RTT) received.  A value
  730.         of 0 for this object implies that no RTT has been received."
  731.     ::= { pingResultsEntry 4 }
  732.  
  733.  pingResultsMaxRtt OBJECT-TYPE
  734.     SYNTAX      Unsigned32
  735.     UNITS       "milliseconds"
  736.     MAX-ACCESS  read-only
  737.     STATUS      current
  738.     DESCRIPTION
  739.         "The maximum ping round-trip-time (RTT) received.  A value
  740.         of 0 for this object implies that no RTT has been received."
  741.     ::= { pingResultsEntry 5 }
  742.  
  743.   pingResultsAverageRtt OBJECT-TYPE
  744.     SYNTAX      Unsigned32
  745.     UNITS       "milliseconds"
  746.     MAX-ACCESS  read-only
  747.     STATUS      current
  748.     DESCRIPTION
  749.         "The current average ping round-trip-time (RTT)."
  750.     ::= { pingResultsEntry 6 }
  751.  
  752.   pingResultsProbeResponses OBJECT-TYPE
  753.     SYNTAX      Unsigned32
  754.     UNITS       "responses"
  755.     MAX-ACCESS  read-only
  756.     STATUS      current
  757.     DESCRIPTION
  758.         "Number of responses received for the corresponding
  759.  
  760.         pingCtlEntry and pingResultsEntry.  The value of this object
  761.         MUST be reported as 0 when no probe responses have been
  762.         received."
  763.     ::= { pingResultsEntry 7 }
  764.  
  765.   pingResultsSentProbes OBJECT-TYPE
  766.     SYNTAX      Unsigned32
  767.     UNITS       "probes"
  768.     MAX-ACCESS  read-only
  769.     STATUS      current
  770.     DESCRIPTION
  771.         "The value of this object reflects the number of probes sent
  772.         for the corresponding pingCtlEntry and pingResultsEntry.
  773.         The value of this object MUST be reported as 0 when no probes
  774.         have been sent."
  775.     ::= { pingResultsEntry 8 }
  776.  
  777.   pingResultsRttSumOfSquares OBJECT-TYPE
  778.     SYNTAX      Unsigned32
  779.     UNITS       "milliseconds"
  780.     MAX-ACCESS  read-only
  781.     STATUS      current
  782.     DESCRIPTION
  783.         "This object contains the sum of the squares for all ping
  784.         responses received.  Its purpose is to enable standard
  785.         deviation calculation.  The value of this object MUST
  786.         be reported as 0 when no ping responses have been
  787.         received."
  788.     ::= { pingResultsEntry 9 }
  789.  
  790.  pingResultsLastGoodProbe OBJECT-TYPE
  791.     SYNTAX      DateAndTime
  792.     MAX-ACCESS  read-only
  793.     STATUS      current
  794.     DESCRIPTION
  795.         "Date and time when the last response was received for
  796.         a probe."
  797.     ::= { pingResultsEntry 10 }
  798.  
  799.  -- Ping Probe History Table
  800.  
  801.  pingProbeHistoryTable OBJECT-TYPE
  802.     SYNTAX      SEQUENCE OF PingProbeHistoryEntry
  803.     MAX-ACCESS  not-accessible
  804.     STATUS      current
  805.     DESCRIPTION
  806.         "Defines a table for storing the results of a ping
  807.         operation.  Entries in this table are limited by
  808.  
  809.         the value of the corresponding pingCtlMaxRows
  810.         object.
  811.  
  812.         An entry in this table is created when the result of
  813.         a ping probe is determined.  The initial 2 instance
  814.         identifier index values identify the pingCtlEntry
  815.         that a probe result (pingProbeHistoryEntry) belongs
  816.         to.  An entry is removed from this table when
  817.         its corresponding pingCtlEntry is deleted.
  818.  
  819.         An implementation of this MIB will remove the oldest
  820.         entry in the pingProbeHistoryTable to allow the
  821.         addition of an new entry once the number of rows in
  822.         the pingProbeHistoryTable reaches the value specified
  823.         by pingCtlMaxRows."
  824.    ::= { pingObjects 4 }
  825.  
  826.  pingProbeHistoryEntry OBJECT-TYPE
  827.     SYNTAX      PingProbeHistoryEntry
  828.     MAX-ACCESS  not-accessible
  829.     STATUS      current
  830.     DESCRIPTION
  831.         "Defines an entry in the pingProbeHistoryTable.
  832.         The first two index elements identify the
  833.         pingCtlEntry that a pingProbeHistoryEntry belongs
  834.         to.  The third index element selects a single
  835.         probe result."
  836.     INDEX {
  837.              pingCtlOwnerIndex,
  838.              pingCtlTestName,
  839.              pingProbeHistoryIndex
  840.            }
  841.     ::= { pingProbeHistoryTable 1 }
  842.  
  843.  PingProbeHistoryEntry ::=
  844.     SEQUENCE {
  845.         pingProbeHistoryIndex         Unsigned32,
  846.         pingProbeHistoryResponse      Unsigned32,
  847.         pingProbeHistoryStatus        OperationResponseStatus,
  848.         pingProbeHistoryLastRC        Integer32,
  849.         pingProbeHistoryTime          DateAndTime
  850.     }
  851.  
  852.  pingProbeHistoryIndex OBJECT-TYPE
  853.     SYNTAX      Unsigned32 (1..'ffffffff'h)
  854.     MAX-ACCESS  not-accessible
  855.     STATUS      current
  856.     DESCRIPTION
  857.  
  858.         "An entry in this table is created when the result of
  859.         a ping probe is determined.  The initial 2 instance
  860.         identifier index values identify the pingCtlEntry
  861.         that a probe result (pingProbeHistoryEntry) belongs
  862.         to.
  863.  
  864.         An implementation MUST start assigning
  865.         pingProbeHistoryIndex values at 1 and wrap after
  866.         exceeding the maximum possible value as defined by
  867.         the limit of this object ('ffffffff'h)."
  868.     ::= { pingProbeHistoryEntry 1 }
  869.  
  870.  pingProbeHistoryResponse OBJECT-TYPE
  871.     SYNTAX      Unsigned32
  872.     UNITS       "milliseconds"
  873.     MAX-ACCESS  read-only
  874.     STATUS      current
  875.     DESCRIPTION
  876.         "The amount of time measured in milliseconds from when
  877.         a probe was sent to when its response was received or
  878.         when it timed out.  The value of this object is reported
  879.         as 0 when it is not possible to transmit a probe."
  880.     ::= { pingProbeHistoryEntry 2 }
  881.  
  882.  pingProbeHistoryStatus OBJECT-TYPE
  883.     SYNTAX      OperationResponseStatus
  884.     MAX-ACCESS  read-only
  885.     STATUS      current
  886.     DESCRIPTION
  887.         "The result of a particular probe done by a remote host."
  888.     ::= { pingProbeHistoryEntry 3 }
  889.  
  890.  pingProbeHistoryLastRC        OBJECT-TYPE
  891.     SYNTAX      Integer32
  892.     MAX-ACCESS  read-only
  893.     STATUS      current
  894.     DESCRIPTION
  895.         "The last implementation method specific reply code received.
  896.         If the ICMP Echo capability is being used then a successful
  897.         probe ends when an ICMP response is received that contains
  898.         the code ICMP_ECHOREPLY(0).  The ICMP responses are defined
  899.         normally in the ip_icmp include file."
  900.     ::= { pingProbeHistoryEntry 4 }
  901.  
  902.  pingProbeHistoryTime OBJECT-TYPE
  903.     SYNTAX      DateAndTime
  904.     MAX-ACCESS  read-only
  905.     STATUS      current
  906.  
  907.     DESCRIPTION
  908.         "Timestamp for when this probe result was determined."
  909.     ::= { pingProbeHistoryEntry 5 }
  910.  
  911.  -- Notification Definition section
  912.  
  913.  pingProbeFailed NOTIFICATION-TYPE
  914.       OBJECTS {
  915.         pingCtlTargetAddressType,
  916.         pingCtlTargetAddress,
  917.         pingResultsOperStatus,
  918.         pingResultsIpTargetAddressType,
  919.         pingResultsIpTargetAddress,
  920.         pingResultsMinRtt,
  921.         pingResultsMaxRtt,
  922.         pingResultsAverageRtt,
  923.         pingResultsProbeResponses,
  924.         pingResultsSentProbes,
  925.         pingResultsRttSumOfSquares,
  926.         pingResultsLastGoodProbe
  927.       }
  928.       STATUS  current
  929.       DESCRIPTION
  930.           "Generated when a probe failure is detected when the
  931.           corresponding pingCtlTrapGeneration object is set to
  932.           probeFailure(0) subject to the value of
  933.           pingCtlTrapProbeFailureFilter.  The object
  934.           pingCtlTrapProbeFailureFilter can be used to specify the
  935.           number of successive probe failures that are required
  936.           before this notification can be generated."
  937.       ::= { pingNotifications 1 }
  938.  
  939.  pingTestFailed NOTIFICATION-TYPE
  940.       OBJECTS {
  941.         pingCtlTargetAddressType,
  942.         pingCtlTargetAddress,
  943.         pingResultsOperStatus,
  944.         pingResultsIpTargetAddressType,
  945.         pingResultsIpTargetAddress,
  946.         pingResultsMinRtt,
  947.         pingResultsMaxRtt,
  948.         pingResultsAverageRtt,
  949.         pingResultsProbeResponses,
  950.         pingResultsSentProbes,
  951.         pingResultsRttSumOfSquares,
  952.         pingResultsLastGoodProbe
  953.       }
  954.  
  955.       STATUS  current
  956.       DESCRIPTION
  957.           "Generated when a ping test is determined to have failed
  958.           when the corresponding pingCtlTrapGeneration object is
  959.           set to testFailure(1).  In this instance
  960.           pingCtlTrapTestFailureFilter should specify the number of
  961.           probes in a test required to have failed in order to
  962.           consider the test as failed."
  963.       ::= { pingNotifications 2 }
  964.  
  965.  pingTestCompleted NOTIFICATION-TYPE
  966.       OBJECTS {
  967.         pingCtlTargetAddressType,
  968.         pingCtlTargetAddress,
  969.         pingResultsOperStatus,
  970.         pingResultsIpTargetAddressType,
  971.         pingResultsIpTargetAddress,
  972.         pingResultsMinRtt,
  973.         pingResultsMaxRtt,
  974.         pingResultsAverageRtt,
  975.         pingResultsProbeResponses,
  976.         pingResultsSentProbes,
  977.         pingResultsRttSumOfSquares,
  978.         pingResultsLastGoodProbe
  979.       }
  980.       STATUS  current
  981.       DESCRIPTION
  982.           "Generated at the completion of a ping test when the
  983.           corresponding pingCtlTrapGeneration object is set to
  984.           testCompletion(4)."
  985.       ::= { pingNotifications 3 }
  986.  
  987.  -- Conformance information
  988.  -- Compliance statements
  989.  
  990.  pingCompliances OBJECT IDENTIFIER ::= { pingConformance 1 }
  991.  pingGroups      OBJECT IDENTIFIER ::= { pingConformance 2 }
  992.  
  993.  -- Compliance statements
  994.  
  995.  pingCompliance MODULE-COMPLIANCE
  996.     STATUS  current
  997.     DESCRIPTION
  998.             "The compliance statement for the DISMAN-PING-MIB."
  999.     MODULE  -- this module
  1000.         MANDATORY-GROUPS {
  1001.                             pingGroup,
  1002.                             pingNotificationsGroup
  1003.  
  1004.                           }
  1005.         GROUP pingTimeStampGroup
  1006.         DESCRIPTION
  1007.             "This group is mandatory for implementations that have
  1008.             access to a system clock and are capable of setting
  1009.             the values for DateAndTime objects.  It is RECOMMENDED
  1010.             that when this group is not supported that the values
  1011.             for the objects in this group be reported as
  1012.             '0000000000000000'H."
  1013.  
  1014.         OBJECT pingMaxConcurrentRequests
  1015.         MIN-ACCESS  read-only
  1016.         DESCRIPTION
  1017.             "The agent is not required to support set
  1018.             operations to this object."
  1019.  
  1020.         OBJECT pingCtlStorageType
  1021.         MIN-ACCESS  read-only
  1022.         DESCRIPTION
  1023.             "Write access is not required.  It is also allowed
  1024.             for implementations to support only the volatile
  1025.             StorageType enumeration."
  1026.  
  1027.         OBJECT pingCtlType
  1028.         MIN-ACCESS  read-only
  1029.         DESCRIPTION
  1030.             "Write access is not required.  In addition, the only
  1031.             value that MUST be supported by an implementation is
  1032.             pingIcmpEcho."
  1033.  
  1034.         OBJECT pingCtlByPassRouteTable
  1035.         MIN-ACCESS  read-only
  1036.         DESCRIPTION
  1037.             "This object is not required by implementations that
  1038.             are not capable of its implementation.  The function
  1039.             represented by this object is implementable if the
  1040.             setsockopt SOL_SOCKET SO_DONTROUTE option is
  1041.             supported."
  1042.  
  1043.         OBJECT pingCtlSourceAddressType
  1044.         SYNTAX  InetAddressType { unknown(0), ipv4(1), ipv6(2) }
  1045.         MIN-ACCESS  read-only
  1046.         DESCRIPTION
  1047.             "This object is not required by implementations that
  1048.             are not capable of binding the send socket with a
  1049.             source address. An implementation is only required to
  1050.             support IPv4 and IPv6 addresses."
  1051.  
  1052.         OBJECT pingCtlSourceAddress
  1053.         SYNTAX  InetAddress (SIZE(0|4|16))
  1054.         MIN-ACCESS  read-only
  1055.         DESCRIPTION
  1056.             "This object is not required by implementations that
  1057.             are not capable of binding the send socket with a
  1058.             source address. An implementation is only required to
  1059.             support IPv4 and globally unique IPv6 addresses."
  1060.  
  1061.         OBJECT pingCtlIfIndex
  1062.         MIN-ACCESS  read-only
  1063.         DESCRIPTION
  1064.             "Write access is not required.   When write access is
  1065.             not supported return a 0 as the value of this object.
  1066.             A value of 0 means that the function represented by
  1067.             this option is not supported."
  1068.  
  1069.         OBJECT pingCtlDSField
  1070.         MIN-ACCESS  read-only
  1071.         DESCRIPTION
  1072.             "Write access is not required.   When write access is
  1073.             not supported return a 0 as the value of this object.
  1074.             A value of 0 means that the function represented by
  1075.             this option is not supported."
  1076.  
  1077.         OBJECT pingResultsIpTargetAddressType
  1078.         SYNTAX  InetAddressType { unknown(0), ipv4(1), ipv6(2) }
  1079.         DESCRIPTION
  1080.             "An implementation is only required to
  1081.             support IPv4 and IPv6 addresses."
  1082.  
  1083.         OBJECT pingResultsIpTargetAddress
  1084.         SYNTAX  InetAddress (SIZE(0|4|16))
  1085.         DESCRIPTION
  1086.             "An implementation is only required to
  1087.             support IPv4 and globally unique IPv6 addresses."
  1088.  
  1089.     ::= { pingCompliances 1 }
  1090.  
  1091.  -- MIB groupings
  1092.  
  1093.  pingGroup OBJECT-GROUP
  1094.    OBJECTS {
  1095.              pingMaxConcurrentRequests,
  1096.              pingCtlTargetAddressType,
  1097.              pingCtlTargetAddress,
  1098.              pingCtlDataSize,
  1099.              pingCtlTimeOut,
  1100.  
  1101.              pingCtlProbeCount,
  1102.              pingCtlAdminStatus,
  1103.              pingCtlDataFill,
  1104.              pingCtlFrequency,
  1105.              pingCtlMaxRows,
  1106.              pingCtlStorageType,
  1107.              pingCtlTrapGeneration,
  1108.              pingCtlTrapProbeFailureFilter,
  1109.              pingCtlTrapTestFailureFilter,
  1110.              pingCtlType,
  1111.              pingCtlDescr,
  1112.              pingCtlByPassRouteTable,
  1113.              pingCtlSourceAddressType,
  1114.              pingCtlSourceAddress,
  1115.              pingCtlIfIndex,
  1116.              pingCtlDSField,
  1117.              pingCtlRowStatus,
  1118.              pingResultsOperStatus,
  1119.              pingResultsIpTargetAddressType,
  1120.              pingResultsIpTargetAddress,
  1121.              pingResultsMinRtt,
  1122.              pingResultsMaxRtt,
  1123.              pingResultsAverageRtt,
  1124.              pingResultsProbeResponses,
  1125.              pingResultsSentProbes,
  1126.              pingResultsRttSumOfSquares,
  1127.              pingProbeHistoryResponse,
  1128.              pingProbeHistoryStatus,
  1129.              pingProbeHistoryLastRC
  1130.            }
  1131.    STATUS  current
  1132.    DESCRIPTION
  1133.        "The group of objects that comprise the remote ping
  1134.        capability."
  1135.     ::= { pingGroups 1 }
  1136.  
  1137.  pingTimeStampGroup OBJECT-GROUP
  1138.    OBJECTS {
  1139.              pingResultsLastGoodProbe,
  1140.              pingProbeHistoryTime
  1141.            }
  1142.    STATUS  current
  1143.    DESCRIPTION
  1144.        "The group of DateAndTime objects."
  1145.     ::= { pingGroups 2 }
  1146.  
  1147.  pingNotificationsGroup NOTIFICATION-GROUP
  1148.    NOTIFICATIONS {
  1149.  
  1150.              pingProbeFailed,
  1151.              pingTestFailed,
  1152.              pingTestCompleted
  1153.           }
  1154.    STATUS        current
  1155.    DESCRIPTION
  1156.        "The notification which are required to be supported by
  1157.        implementations of this MIB."
  1158.    ::= { pingGroups 3 }
  1159.  
  1160. END
  1161.  
  1162.