CISCO-IPSLA-ECHO-MIB

This MIB module defines the templates for IP SLA operations of ICMP echo, UDP echo and TCP connect. The ICMP echo operation mea...

  • Version: 2007-08-16

    CISCO-IPSLA-ECHO-MIB@2007-08-16


    
      module CISCO-IPSLA-ECHO-MIB {
    
        yang-version 1;
    
        namespace
          "urn:ietf:params:xml:ns:yang:smiv2:CISCO-IPSLA-ECHO-MIB";
    
        prefix CISCO-IPSLA-ECHO-MIB;
    
        import INET-ADDRESS-MIB {
          prefix inet-address;
        }
        import SNMP-FRAMEWORK-MIB {
          prefix snmp-framework;
        }
        import SNMPv2-TC {
          prefix snmpv2-tc;
        }
        import ietf-inet-types {
          prefix inet;
        }
        import ietf-yang-smiv2 {
          prefix smiv2;
        }
    
        organization "Cisco Systems, Inc.";
    
        contact
          "Cisco Systems, Inc.
        Customer Service
        
        Postal: 170 W Tasman Drive
        San Jose, CA 95134
        
        Tel: +1 800 553 NETS
        Email: cs-ipsla@cisco.com";
    
        description
          "This MIB module defines the templates for IP SLA operations of
        ICMP echo, UDP echo and TCP connect.
        
        The ICMP echo operation measures end-to-end response time between 
        a Cisco router and any IP enabled device by computing the time
        taken between sending an ICMP echo request message to the 
        destination and receiving an ICMP echo reply.
        
        
        The UDP echo operation measures end-to-end response time between 
        a Cisco router and any IP enabled device by computing the time
        taken between sending an UDP echo request message to the 
        destination and receiving an UDP echo reply.
        
        The TCP connect operation measures end-to-end response time between 
        a Cisco router and any IP enabled device by computing the time
        taken to perform a TCP connect operation.";
    
        revision "2007-08-16" {
          description
            "Initial version of this MIB module.";
        }
    
        smiv2:alias "ciscoIpSlaEchoMIB" {
          smiv2:oid "1.3.6.1.4.1.9.9.636";
        }
        smiv2:alias "ciscoIpSlaEchoMIBNotifs" {
          smiv2:oid "1.3.6.1.4.1.9.9.636.0";
        }
        smiv2:alias "ciscoIpSlaEchoMIBObjects" {
          smiv2:oid "1.3.6.1.4.1.9.9.636.1";
        }
        smiv2:alias "ciscoIpSlaEchoMIBConform" {
          smiv2:oid "1.3.6.1.4.1.9.9.636.2";
        }
        smiv2:alias "ciscoIpSlaEchoMIBCompliances" {
          smiv2:oid "1.3.6.1.4.1.9.9.636.2.1";
        }
        smiv2:alias "ciscoIpSlaEchoMIBGroups" {
          smiv2:oid "1.3.6.1.4.1.9.9.636.2.2";
        }
    
        container CISCO-IPSLA-ECHO-MIB {
          config false;
          container cipslaIcmpEchoTmplTable {
            smiv2:oid "1.3.6.1.4.1.9.9.636.1.1";
            description
              "A table that contains ICMP echo template definitions.";
            list cipslaIcmpEchoTmplEntry {
              smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1";
              key "cipslaIcmpEchoTmplName";
              description
                "A row entry representing an IPSLA ICMP echo template.";
              leaf cipslaIcmpEchoTmplName {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.1";
                type snmp-framework:SnmpAdminString {
                  length "1..64";
                }
                description
                  "This field is used to specify the ICMP echo template name.";
              }
    
              leaf cipslaIcmpEchoTmplDescription {
                smiv2:defval "";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.2";
                type snmp-framework:SnmpAdminString {
                  length "0..128";
                }
                description
                  "This field is used to provide description for the ICMP echo
                template.";
              }
    
              leaf cipslaIcmpEchoTmplSrcAddrType {
                smiv2:defval "ipv4";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.3";
                type inet-address:InetAddressType;
                description
                  "An enumerated value which specifies the IP address type
                of the source. It must be used along with the
                cipslaIcmpEchoTmplSrcAddr object.";
              }
    
              leaf cipslaIcmpEchoTmplSrcAddr {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.4";
                type inet-address:InetAddress;
                description
                  "A string which specifies the IP address of the source.";
              }
    
              leaf cipslaIcmpEchoTmplTimeOut {
                smiv2:defval "5000";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.5";
                type uint32 {
                  range "0..604800000";
                }
                units "milliseconds";
                description
                  "Specifies the duration to wait for a IP SLA operation
                completion. 
                
                For connection oriented protocols, this may cause the
                connection to be closed by the operation.  Once closed, it
                will be assumed that the connection reestablishment
                will be performed.  To prevent unwanted closure of
                connections, be sure to set this value to a realistic
                connection timeout.";
              }
    
              leaf cipslaIcmpEchoTmplVerifyData {
                smiv2:defval "false";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.6";
                type boolean;
                description
                  "When set to true, the resulting data in each IP SLA
                operation is compared with the expected data.  This
                includes checking header information (if possible) and
                exact packet size.";
              }
    
              leaf cipslaIcmpEchoTmplReqDataSize {
                smiv2:defval "28";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.7";
                type uint32 {
                  range "0..16384";
                }
                units "octets";
                description
                  "This object represents the number of octets to be
                placed into the ARR Data portion of the request
                message, when using SNA protocols.
                
                For non-ARR protocols' IP SLA request/responses,
                this value represents the native payload size.
                
                REMEMBER:  The ARR Header overhead is not included
                           in this value.";
              }
    
              leaf cipslaIcmpEchoTmplTOS {
                smiv2:defval "0";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.8";
                type uint32 {
                  range "0..255";
                }
                description
                  "This object represents the type of service octet in an
                IP header.";
                reference
                  "Refer to the following documents for TOS definition.
                   RFC791/1349  for IPv4, IPv6, draft-ietf-diffserv-header-02.txt";
    
              }
    
              leaf cipslaIcmpEchoTmplVrfName {
                smiv2:defval "";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.9";
                type snmp-framework:SnmpAdminString {
                  length "0..32";
                }
                description
                  "This field is used to specify the VRF name with
                which the IP SLA operation will be used. For regular IP SLA
                operation this field should not be configured. The agent
                will use this field to identify the VRF routing table for
                this operation.";
              }
    
              leaf cipslaIcmpEchoTmplThreshold {
                smiv2:defval "5000";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.10";
                type uint32 {
                  range "0..2147483647";
                }
                units "milliseconds";
                description
                  "This object defines an administrative threshold limit.
                If the IP SLA operation time exceeds this limit and if the
                condition specified in cipslaIcmpEchoTmplHistFilter is
                satisfied, one threshold crossing occurrence will be counted.";
              }
    
              leaf cipslaIcmpEchoTmplHistLives {
                smiv2:defval "0";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.11";
                type uint32 {
                  range "0..2";
                }
                description
                  "The maximum number of history lives to record.  A life
                is defined by the countdown (or transition) to zero 
                by the cipslaAutoGroupScheduleLife object.  A new life is
                created when the same conceptual control row is
                restarted via the transition of the 
                cipslaAutoGroupScheduleLife object and its subsequent 
                countdown.
                
                The value of zero will shut off all data collection.";
              }
    
              leaf cipslaIcmpEchoTmplHistBuckets {
                smiv2:defval "15";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.12";
                type uint32 {
                  range "1..60";
                }
                description
                  "The maximum number of history buckets to record.
                This value is set to the number of operations 
                to keep per lifetime.
                
                After cipslaIcmpEchoTmplHistBuckets are filled, the 
                oldest entries are deleted and the most recent
                cipslaIcmpEchoTmplHistBuckets buckets are retained.";
              }
    
              leaf cipslaIcmpEchoTmplHistFilter {
                smiv2:defval "none";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.13";
                type enumeration {
                  enum "none" {
                    value 1;
                  }
                  enum "all" {
                    value 2;
                  }
                  enum "overThreshold" {
                    value 3;
                  }
                  enum "failures" {
                    value 4;
                  }
                }
                description
                  "Defines a filter for adding RTT results to the history
                buffer:
                
                none(1)          - no history is recorded
                all(2)           - the results of all completion times 
                                   and failed completions are recorded
                overThreshold(3) - the results of completion times
                                   over cipslaIcmpEchoTmplThreshold are 
                                   recorded.
                failures(4)      - the results of failed operations (only) 
                                   are recorded.";
              }
    
              leaf cipslaIcmpEchoTmplStatsHours {
                smiv2:defval "2";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.14";
                type uint32 {
                  range "0..25";
                }
                units "hours";
                description
                  "The maximum number of hours for which statistics are
                maintained. Specifically this is the number of hourly 
                groups to keep before rolling over.
                
                The value of one is not advisable because the hourly
                group will close and immediately be deleted before
                the network management station will have the
                opportunity to retrieve the statistics.
                
                The value of zero will shut off data collection.";
              }
    
              leaf cipslaIcmpEchoTmplDistBuckets {
                smiv2:defval "1";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.15";
                type uint32 {
                  range "1..20";
                }
                description
                  "The maximum number of statistical distribution
                buckets to accumulate.
                
                Since this index does not rollover, only the first
                cipslaIcmpEchoTmplStatsNumDistBuckets will be kept.
                
                The last cipslaIcmpEchoTmplStatsNumDistBucket will
                contain all entries from its distribution interval
                start point to infinity.";
              }
    
              leaf cipslaIcmpEchoTmplDistInterval {
                smiv2:defval "20";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.16";
                type uint32 {
                  range "1..100";
                }
                units "milliseconds";
                description
                  "The statistical distribution buckets interval.
                
                Distribution Bucket Example:
                
                cipslaIcmpEchoTmplDistBuckets = 5 buckets
                cipslaIcmpEchoTmplDistInterval = 10 milliseconds
                
                | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5  |
                |  0-9 ms  | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |
                
                Odd Example:
                
                cipslaIcmpEchoTmplDistBuckets = 1 buckets
                cipslaIcmpEchoTmplDistInterval = 10 milliseconds
                
                | Bucket 1  |
                |  0-Inf ms |
                
                Thus, this odd example shows that the value of
                cipslaIcmpEchoTmplDistInterval does not apply when
                cipslaIcmpEchoTmplDistBuckets is one.";
              }
    
              leaf cipslaIcmpEchoTmplStorageType {
                smiv2:defval "nonVolatile";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.17";
                type snmpv2-tc:StorageType;
                description
                  "The storage type of this conceptual row.";
              }
    
              leaf cipslaIcmpEchoTmplRowStatus {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.1.1.18";
                type snmpv2-tc:RowStatus;
                description
                  "The status of the conceptual ICMP echo template control row.
                When the status is active, all the read-create objects in that 
                row can be modified.";
              }
            }  // list cipslaIcmpEchoTmplEntry
          }  // container cipslaIcmpEchoTmplTable
    
          container cipslaUdpEchoTmplTable {
            smiv2:oid "1.3.6.1.4.1.9.9.636.1.2";
            description
              "A table that contains UDP echo template specific definitions.";
            list cipslaUdpEchoTmplEntry {
              smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1";
              key "cipslaUdpEchoTmplName";
              description
                "A row entry representing an IPSLA UDP echo template.";
              leaf cipslaUdpEchoTmplName {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.1";
                type snmp-framework:SnmpAdminString {
                  length "1..64";
                }
                description
                  "A string which specifies the UDP echo template name.";
              }
    
              leaf cipslaUdpEchoTmplDescription {
                smiv2:defval "";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.2";
                type snmp-framework:SnmpAdminString {
                  length "0..128";
                }
                description
                  "A string which provides description to the UDP echo template.";
              }
    
              leaf cipslaUdpEchoTmplControlEnable {
                smiv2:defval "true";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.3";
                type boolean;
                description
                  "If this object is enabled, then the IP SLA application
                will send control messages to a responder, residing on the
                target router to respond to the data request packets being
                sent by the source router.";
              }
    
              leaf cipslaUdpEchoTmplSrcAddrType {
                smiv2:defval "ipv4";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.4";
                type inet-address:InetAddressType;
                description
                  "An enumerated value which specifies the IP address type
                of the source. It must be used along with the
                cipslaUdpEchoTmplSrcAddr object.";
              }
    
              leaf cipslaUdpEchoTmplSrcAddr {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.5";
                type inet-address:InetAddress;
                description
                  "A string which specifies the IP address of the source.";
              }
    
              leaf cipslaUdpEchoTmplSrcPort {
                smiv2:defval "0";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.6";
                type inet:port-number;
                description
                  "This object represents the source's port number. If this
                object is not specified, the application will get a
                port allocated by the system.";
              }
    
              leaf cipslaUdpEchoTmplTimeOut {
                smiv2:defval "5000";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.7";
                type uint32 {
                  range "0..604800000";
                }
                units "milliseconds";
                description
                  "Specifies the duration to wait for an IP SLA operation
                completion.
                
                For connection oriented protocols, this may cause the
                connection to be closed by the operation.  Once closed, it
                will be assumed that the connection reestablishment
                will be performed.  To prevent unwanted closure of
                connections, be sure to set this value to a realistic
                connection timeout.";
              }
    
              leaf cipslaUdpEchoTmplVerifyData {
                smiv2:defval "false";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.8";
                type boolean;
                description
                  "When set to true, the resulting data in each IP SLA
                operation is compared with the expected data.  This
                includes checking header information (if possible) and
                exact packet size.";
              }
    
              leaf cipslaUdpEchoTmplReqDataSize {
                smiv2:defval "16";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.9";
                type uint32 {
                  range "4..1500";
                }
                units "octets";
                description
                  "This object represents the number of octets to be
                placed into the ARR Data portion of the request
                message, when using SNA protocols.
                
                For non-ARR protocols' RTT request/responses,
                this value represents the native payload size.
                
                REMEMBER:  The ARR Header overhead is not included
                           in this value.";
              }
    
              leaf cipslaUdpEchoTmplTOS {
                smiv2:defval "0";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.10";
                type uint32 {
                  range "0..255";
                }
                description
                  "This object represents the type of service octet in an
                IP header.";
                reference
                  "Refer to the following documents for TOS definition.
                   RFC791/1349  for IPv4, IPv6, draft-ietf-diffserv-header-02.txt";
    
              }
    
              leaf cipslaUdpEchoTmplVrfName {
                smiv2:defval "";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.11";
                type snmp-framework:SnmpAdminString {
                  length "0..32";
                }
                description
                  "This field is used to specify the VRF name with
                which the IP SLA operation will be used. For regular IP SLA
                operation this field should not be configured. The agent
                will use this field to identify the VRF routing Table for
                this operation.";
              }
    
              leaf cipslaUdpEchoTmplThreshold {
                smiv2:defval "5000";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.12";
                type uint32 {
                  range "0..2147483647";
                }
                units "milliseconds";
                description
                  "This object defines an administrative threshold limit.
                If the IP SLA operation time exceeds this limit and if the
                condition specified in cipslaUdpEchoTmplHistFilter is 
                satisfied, one threshold crossing occurrence will be counted.";
              }
    
              leaf cipslaUdpEchoTmplHistLives {
                smiv2:defval "0";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.13";
                type uint32 {
                  range "0..2";
                }
                description
                  "The maximum number of history lives to record.  A life
                is defined by the countdown (or transition) to zero 
                by the cipslaAutoGroupScheduleLife object.  A new life is
                created when the same conceptual control row is
                restarted via the transition of the 
                cipslaAutoGroupScheduleLife object and its subsequent 
                countdown.
                
                The value of zero will shut off all data collection.";
              }
    
              leaf cipslaUdpEchoTmplHistBuckets {
                smiv2:defval "15";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.14";
                type uint32 {
                  range "1..60";
                }
                description
                  "The maximum number of history buckets to record.
                This value should be set to the number of operations 
                to keep per lifetime.
                
                After cipslaUdpEchoTmplHistBuckets are filled, the 
                oldest entries are deleted and the most recent
                cipslaUdpEchoTmplHistBuckets buckets are retained.";
              }
    
              leaf cipslaUdpEchoTmplHistFilter {
                smiv2:defval "none";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.15";
                type enumeration {
                  enum "none" {
                    value 1;
                  }
                  enum "all" {
                    value 2;
                  }
                  enum "overThreshold" {
                    value 3;
                  }
                  enum "failures" {
                    value 4;
                  }
                }
                description
                  "Defines a filter for adding RTT results to the history
                buffer:
                
                none(1)          - no history is recorded
                all(2)           - the results of all completion times 
                                   and failed completions are recorded
                overThreshold(3) - the results of completion times
                                   over cipslaUdpEchoTmplThreshold are 
                                   recorded.
                failures(4)      - the results of failed operations (only) 
                                   are recorded.";
              }
    
              leaf cipslaUdpEchoTmplStatsHours {
                smiv2:defval "2";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.16";
                type uint32 {
                  range "0..25";
                }
                units "hours";
                description
                  "The maximum number of hours for which statistics are
                maintained. Specifically this is the number of hourly 
                groups to keep before rolling over.
                
                The value of one is not advisable because the hourly
                group will close and immediately be deleted before
                the network management station will have the
                opportunity to retrieve the statistics.
                
                The value of zero will shut off data collection.";
              }
    
              leaf cipslaUdpEchoTmplDistBuckets {
                smiv2:defval "1";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.17";
                type uint32 {
                  range "1..20";
                }
                description
                  "The maximum number of statistical distribution
                buckets to accumulate.
                
                Since this index does not rollover, only the first
                cipslaUdpEchoTmplStatsNumDistBuckets will be kept.
                
                The last cipslaUdpEchoTmplStatsNumDistBuckets will
                contain all entries from its distribution interval
                start point to infinity.";
              }
    
              leaf cipslaUdpEchoTmplDistInterval {
                smiv2:defval "20";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.18";
                type uint32 {
                  range "1..100";
                }
                units "milliseconds";
                description
                  "The statistical distribution buckets interval.
                
                Distribution Bucket Example:
                
                cipslaUdpEchoTmplDistBuckets = 5 buckets
                cipslaUdpEchoTmplDistInterval = 10 milliseconds
                
                | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5  |
                |  0-9 ms  | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |
                
                Odd Example:
                
                cipslaUdpEchoTmplDistBuckets = 1 buckets
                cipslaUdpEchoTmplDistInterval = 10 milliseconds
                
                | Bucket 1  |
                |  0-Inf ms |
                
                Thus, this odd example shows that the value of
                cipslaUdpEchoTmplDistInterval does not apply when
                cipslaUdpEchoTmplDistBuckets is one.";
              }
    
              leaf cipslaUdpEchoTmplStorageType {
                smiv2:defval "nonVolatile";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.19";
                type snmpv2-tc:StorageType;
                description
                  "The storage type of this conceptual row.";
              }
    
              leaf cipslaUdpEchoTmplRowStatus {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.2.1.20";
                type snmpv2-tc:RowStatus;
                description
                  "The status of the conceptual UDP echo template control row.
                When the status is active, all the read-create objects in 
                that row can be modified.";
              }
            }  // list cipslaUdpEchoTmplEntry
          }  // container cipslaUdpEchoTmplTable
    
          container cipslaTcpConnTmplTable {
            smiv2:oid "1.3.6.1.4.1.9.9.636.1.3";
            description
              "A table that contains TCP connect template specific definitions.";
            list cipslaTcpConnTmplEntry {
              smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1";
              key "cipslaTcpConnTmplName";
              description
                "A row entry representing an IPSLA TCP connect template.";
              leaf cipslaTcpConnTmplName {
                smiv2:max-access "not-accessible";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.1";
                type snmp-framework:SnmpAdminString {
                  length "1..64";
                }
                description
                  "A string which specifies the TCP connect template name.";
              }
    
              leaf cipslaTcpConnTmplDescription {
                smiv2:defval "";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.2";
                type snmp-framework:SnmpAdminString {
                  length "0..128";
                }
                description
                  "A string which provides description for the TCP connect template.";
              }
    
              leaf cipslaTcpConnTmplControlEnable {
                smiv2:defval "true";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.3";
                type boolean;
                description
                  "If this object is enabled, then the IP SLA application
                will send control messages to a responder, residing on the
                target router to respond to the data request packets being
                sent by the source router.";
              }
    
              leaf cipslaTcpConnTmplSrcAddrType {
                smiv2:defval "ipv4";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.4";
                type inet-address:InetAddressType;
                description
                  "An enumerated value which specifies the IP address type
                of the source. It must be used along with the
                cipslaTcpConnTmplSrcAddr object.";
              }
    
              leaf cipslaTcpConnTmplSrcAddr {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.5";
                type inet-address:InetAddress;
                description
                  "A string which specifies the IP address of the source.";
              }
    
              leaf cipslaTcpConnTmplSrcPort {
                smiv2:defval "0";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.6";
                type inet:port-number;
                description
                  "This object represents the source's port number. If this
                object is not specified, the application will get a
                port allocated by the system.";
              }
    
              leaf cipslaTcpConnTmplTimeOut {
                smiv2:defval "5000";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.7";
                type uint32 {
                  range "0..604800000";
                }
                units "milliseconds";
                description
                  "Specifies the duration to wait for an IP SLA operation
                completion.
                
                For connection oriented protocols, this may cause the
                connection to be closed by the operation.  Once closed, it
                will be assumed that the connection reestablishment
                will be performed.  To prevent unwanted closure of
                connections, be sure to set this value to a realistic
                connection timeout.";
              }
    
              leaf cipslaTcpConnTmplVerifyData {
                smiv2:defval "false";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.8";
                type boolean;
                description
                  "When set to true, the resulting data in each IP SLA
                operation is compared with the expected data.  This
                includes checking header information (if possible) and
                exact packet size.";
              }
    
              leaf cipslaTcpConnTmplTOS {
                smiv2:defval "0";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.9";
                type uint32 {
                  range "0..255";
                }
                description
                  "This object represents the type of service octet in an
                IP header.";
                reference
                  "Refer to the following documents for TOS definition.
                   RFC791/1349  for IPv4, IPv6, draft-ietf-diffserv-header-02.txt";
    
              }
    
              leaf cipslaTcpConnTmplThreshold {
                smiv2:defval "5000";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.10";
                type uint32 {
                  range "0..2147483647";
                }
                units "milliseconds";
                description
                  "This object defines an administrative threshold limit.
                If the IP SLA operation time exceeds this limit and if the
                condition specified in cipslaTcpConnTmplHistFilter is 
                satisfied, one threshold crossing occurrence will be counted.";
              }
    
              leaf cipslaTcpConnTmplHistLives {
                smiv2:defval "0";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.11";
                type uint32 {
                  range "0..2";
                }
                description
                  "The maximum number of history lives to record.  A life
                is defined by the countdown (or transition) to zero 
                by the cipslaAutoGroupScheduleLife object.  A new life is
                created when the same conceptual control row is
                restarted via the transition of the 
                cipslaAutoGroupScheduleLife object and its subsequent 
                countdown.
                
                The value of zero will shut off all data collection.";
              }
    
              leaf cipslaTcpConnTmplHistBuckets {
                smiv2:defval "15";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.12";
                type uint32 {
                  range "1..60";
                }
                description
                  "The maximum number of history buckets to record.
                This value should be set to the number of operations 
                to keep per lifetime.
                
                After cipslaTcpConnTmplHistBuckets are filled, the 
                oldest entries are deleted and the most recent
                cipslaTcpConnTmplHistBuckets buckets are retained.";
              }
    
              leaf cipslaTcpConnTmplHistFilter {
                smiv2:defval "none";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.13";
                type enumeration {
                  enum "none" {
                    value 1;
                  }
                  enum "all" {
                    value 2;
                  }
                  enum "overThreshold" {
                    value 3;
                  }
                  enum "failures" {
                    value 4;
                  }
                }
                description
                  "Defines a filter for adding RTT results to the history
                buffer:
                
                none(1)          - no history is recorded
                all(2)           - the results of all completion times 
                                   and failed completions are recorded
                overThreshold(3) - the results of completion times
                                   over cipslaTcpConnTmplThreshold are 
                                   recorded.
                failures(4)      - the results of failed operations (only) 
                                   are recorded.";
              }
    
              leaf cipslaTcpConnTmplStatsHours {
                smiv2:defval "2";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.14";
                type uint32 {
                  range "0..25";
                }
                units "hours";
                description
                  "The maximum number of hours for which statistics are
                maintained. Specifically this is the number of hourly 
                groups to keep before rolling over.
                
                The value of one is not advisable because the hourly
                group will close and immediately be deleted before
                the network management station will have the
                opportunity to retrieve the statistics.
                
                The value of zero will shut off data collection.";
              }
    
              leaf cipslaTcpConnTmplDistBuckets {
                smiv2:defval "1";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.15";
                type uint32 {
                  range "1..20";
                }
                description
                  "The maximum number of statistical distribution
                buckets to accumulate.
                
                Since this index does not rollover, only the first
                cipslaTcpConnTmplDistBuckets will be kept.
                
                The last cipslaTcpConnTmplDistBuckets will
                contain all entries from its distribution interval
                start point to infinity.";
              }
    
              leaf cipslaTcpConnTmplDistInterval {
                smiv2:defval "20";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.16";
                type uint32 {
                  range "1..100";
                }
                units "milliseconds";
                description
                  "The statistical distribution buckets interval.
                
                Distribution Bucket Example:
                
                cipslaTcpConnTmplDistBuckets = 5 buckets
                cipslaTcpConnTmplDistInterval = 10 milliseconds
                
                | Bucket 1 | Bucket 2 | Bucket 3 | Bucket 4 | Bucket 5  |
                |  0-9 ms  | 10-19 ms | 20-29 ms | 30-39 ms | 40-Inf ms |
                
                Odd Example:
                
                cipslaTcpConnTmplDistBuckets = 1 buckets
                cipslaTcpConnTmplDistInterval = 10 milliseconds
                
                | Bucket 1  |
                |  0-Inf ms |
                
                Thus, this odd example shows that the value of
                cipslaTcpConnTmplDistInterval does not apply when
                cipslaTcpConnTmplDistBuckets is one.";
              }
    
              leaf cipslaTcpConnTmplStorageType {
                smiv2:defval "nonVolatile";
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.17";
                type snmpv2-tc:StorageType;
                description
                  "The storage type of this conceptual row.";
              }
    
              leaf cipslaTcpConnTmplRowStatus {
                smiv2:max-access "read-write";
                smiv2:oid "1.3.6.1.4.1.9.9.636.1.3.1.18";
                type snmpv2-tc:RowStatus;
                description
                  "The status of the conceptual tcp connect control row.
                When the status is active, all the read-create objects 
                in that row can be modified.";
              }
            }  // list cipslaTcpConnTmplEntry
          }  // container cipslaTcpConnTmplTable
        }  // container CISCO-IPSLA-ECHO-MIB
      }  // module CISCO-IPSLA-ECHO-MIB
    

© 2023 YumaWorks, Inc. All rights reserved.