module CISCO-IP-TAP-MIB {

    yang-version 1;

    namespace
      "urn:ietf:params:xml:ns:yang:smiv2:CISCO-IP-TAP-MIB";

    prefix CISCO-IP-TAP-MIB;

    import CISCO-TAP2-MIB {
      prefix cisco-tap2;
    }
    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
    Customer Service
    
    Postal:170 W. Tasman Drive
    San Jose, CA  95134
    USA
    
    Tel:+1 800 553-NETS
    
    E-mail:cs-li@cisco.com";

    description
      "This module manages Cisco's intercept feature for IP.
    
    This MIB is used along with CISCO-TAP2-MIB to
    intercept IP traffic. CISCO-TAP2-MIB along with
    specific filter MIBs like this MIB replace 
    CISCO-TAP-MIB.
    
    To create an IP intercept, an entry citapStreamEntry 
    is created which contains the filter details. An entry
    cTap2StreamEntry of CISCO-TAP2-MIB is created, which is
    the common stream information for all kinds of 
    intercepts and type of the specific stream is set to
    ip in this entry.";

    revision "2004-03-11" {
      description
        "Initial version of this MIB module.";
    }

    smiv2:alias "ciscoIpTapMIB" {
      smiv2:oid "1.3.6.1.4.1.9.9.394";
    }
    smiv2:alias "ciscoIpTapMIBNotifs" {
      smiv2:oid "1.3.6.1.4.1.9.9.394.0";
    }
    smiv2:alias "ciscoIpTapMIBObjects" {
      smiv2:oid "1.3.6.1.4.1.9.9.394.1";
    }
    smiv2:alias "citapStreamEncodePacket" {
      smiv2:oid "1.3.6.1.4.1.9.9.394.1.1";
    }
    smiv2:alias "ciscoIpTapMIBConform" {
      smiv2:oid "1.3.6.1.4.1.9.9.394.2";
    }
    smiv2:alias "ciscoIpTapMIBCompliances" {
      smiv2:oid "1.3.6.1.4.1.9.9.394.2.1";
    }
    smiv2:alias "ciscoIpTapMIBGroups" {
      smiv2:oid "1.3.6.1.4.1.9.9.394.2.2";
    }

    container CISCO-IP-TAP-MIB {
      config false;
      container citapStreamEncodePacket {
        smiv2:oid "1.3.6.1.4.1.9.9.394.1.1";
        leaf citapStreamCapabilities {
          smiv2:max-access "read-only";
          smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.1";
          type bits {
            bit tapEnable {
              position 0;
            }
            bit interface {
              position 1;
            }
            bit ipV4 {
              position 2;
            }
            bit ipV6 {
              position 3;
            }
            bit l4Port {
              position 4;
            }
            bit dscp {
              position 5;
            }
            bit voip {
              position 6;
            }
          }
          description
            "This object displays what types of intercept streams can be
          configured on this type of device. This may be dependent on
          hardware capabilities, software capabilities. The following
          fields may be supported:
              tapEnable:   set if table entries with
                           cTap2StreamInterceptEnable set to 'false'
                           are used to pre-screen packets for intercept;
                           otherwise these entries are ignored.
              interface:   SNMP ifIndex Value may be used to select
                           interception of all data crossing an
                           interface or set of interfaces.
              ipV4:        IPv4 Address or prefix may be used to select
                           traffic to be intercepted.
              ipV6:        IPv6 Address or prefix may be used to select
                           traffic to be intercepted.
              l4Port:      TCP/UDP Ports may be used to select traffic
                           to be intercepted.
              dscp:        DSCP (Differentiated Services Code Point) may
                           be used to select traffic to be intercepted.
              voip:        packets belonging to a voice session may
                           be intercepted using source IPv4 address and
                           source UDP port.";
        }
      }  // container citapStreamEncodePacket

      container citapStreamTable {
        smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2";
        description
          "The Intercept Stream IP Table lists the IPv4 and IPv6 streams
        to be intercepted.  The same data stream may be required by
        multiple taps, and one might assume that often the intercepted
        stream is a small subset of the traffic that could be
        intercepted.
        
        
        This essentially provides options for packet selection, only
        some of which might be used. For example, if all traffic to or
        from a given interface is to be intercepted, one would
        configure an entry which lists the interface, and wild-card
        everything else.  If all traffic to or from a given IP Address
        is to be intercepted, one would configure two such entries
        listing the IP Address as source and destination respectively,
        and wild-card everything else.  If a particular voice on a
        teleconference is to be intercepted, on the other hand, one
        would extract the multicast (destination) IP address, the
        source IP Address, the protocol (UDP), and the source and
        destination ports from the call control exchange and list all
        necessary information.
        
        
        The first index indicates which Mediation Device the
        intercepted traffic will be diverted to. The second index
        permits multiple classifiers to be used together, such as
        having an IP address as source or destination. The value of the
        second index is that of the stream's counter entry in the 
        cTap2StreamTable.
        
        Entries are added to this table via citapStreamStatus in 
        accordance with the RowStatus convention.";
        list citapStreamEntry {
          smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1";
          key "cTap2MediationContentId cTap2StreamIndex";
          description
            "A stream entry indicates a single data stream to be
          intercepted to a Mediation Device. Many selected data
          streams may go to the same application interface, and many
          application interfaces are supported.";
          leaf cTap2MediationContentId {
            type leafref {
              path "/cisco-tap2:CISCO-TAP2-MIB/cisco-tap2:cTap2MediationTable/cisco-tap2:cTap2MediationEntry/cisco-tap2:cTap2MediationContentId";
            }
          }

          leaf cTap2StreamIndex {
            type leafref {
              path "/cisco-tap2:CISCO-TAP2-MIB/cisco-tap2:cTap2StreamTable/cisco-tap2:cTap2StreamEntry/cisco-tap2:cTap2StreamIndex";
            }
          }

          leaf citapStreamInterface {
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.1";
            type int32 {
              range "-2..2147483647";
            }
            description
              "The ifIndex value of the interface over which traffic to be
            intercepted is received or transmitted. The interface may be
            physical or virtual. If this is the only parameter specified,
            and it is other than -2, -1 or 0, all traffic on the selected
            interface will be chosen.
            
            
            If the value is zero, matching traffic may be received or
            transmitted on any interface.  Additional selection parameters
            must be selected to limit the scope of traffic intercepted.
            This is most useful on non-routing platforms or on intercepts
            placed elsewhere than a subscriber interface.
            
            
            If the value is -1, one or both of
            citapStreamDestinationAddress and citapStreamSourceAddress
            must be specified with prefix length greater than zero.
            Matching traffic on the interface pointed to by ipRouteIfIndex
            or ipCidrRouteIfIndex values associated with those values is
            intercepted, whichever is specified to be more focused than a
            default route.  If routing changes, either by operator action
            or by routing protocol events, the interface will change with
            it. This is primarily intended for use on subscriber interfaces
            and other places where routing is guaranteed to be
            symmetrical.
            
            
            In both of these cases, it is possible to have the same packet
            selected for intersection on both its ingress and egress
            interface.  Nonetheless, only one instance of the packet is
            sent to the Mediation Device.
            
            
            If the value is -2, packets belonging to a Voice over IP (VoIP)
            session identified by citapStreamSourceAddress, 
            citapStreamSourceLen and citapStreamSourceL4PortMin may be 
            intercepted, as a specific voice session can be identified 
            with source IP address and udp port number. Other selection 
            parameters may be not considered, even if they are set by 
            the Mediation Device.
            
            
            This value must be set when creating a stream entry, either to
            select an interface, to select all interfaces, or to select the
            interface that routing chooses. Some platforms may not
            implement the entire range of options.";
            reference
              "RFC 1213, RFC 2096";

          }

          leaf citapStreamAddrType {
            smiv2:defval "ipv4";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.2";
            type inet-address:InetAddressType;
            description
              "The type of address, used in packet selection.";
          }

          leaf citapStreamDestinationAddress {
            smiv2:defval "'00000000'H";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.3";
            type inet-address:InetAddress;
            description
              "The Destination address or prefix used in packet selection.
            This address will be of the type specified in
            citapStreamAddrType.";
          }

          leaf citapStreamDestinationLength {
            smiv2:defval "0";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.4";
            type inet-address:InetAddressPrefixLength;
            description
              "The length of the Destination Prefix. A value of zero causes
            all addresses to match.  This prefix length will be consistent
            with the type specified in citapStreamAddrType.";
          }

          leaf citapStreamSourceAddress {
            smiv2:defval "'00000000'H";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.5";
            type inet-address:InetAddress;
            description
              "The Source Address used in packet selection. This address will
            be of the type specified in citapStreamAddrType.";
          }

          leaf citapStreamSourceLength {
            smiv2:defval "0";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.6";
            type inet-address:InetAddressPrefixLength;
            description
              "The length of the Source Prefix. A value of zero causes all
            addresses to match. This prefix length will be consistent with
            the type specified in citapStreamAddrType.";
          }

          leaf citapStreamTosByte {
            smiv2:defval "0";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.7";
            type int32 {
              range "0..255";
            }
            description
              "The value of the TOS byte, when masked with
            citapStreamTosByteMask, of traffic to be intercepted.  If
            citapStreamTosByte&(~citapStreamTosByteMask)!=0,
            configuration is rejected.";
          }

          leaf citapStreamTosByteMask {
            smiv2:defval "0";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.8";
            type int32 {
              range "0..255";
            }
            description
              "The value of the TOS byte in an IPv4 or IPv6 header is ANDed
            with citapStreamTosByteMask and compared with
            citapStreamTosByte.  If the values are equal, the comparison
            is equal. If the mask is zero and the TosByte value is zero,
            the result is to always accept.";
          }

          leaf citapStreamFlowId {
            smiv2:defval "-1";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.9";
            type int32 {
              range "-1..1048575";
            }
            description
              "The flow identifier in an IPv6 header. -1 indicates that the
            Flow Id is unused.";
          }

          leaf citapStreamProtocol {
            smiv2:defval "-1";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.10";
            type int32 {
              range "-1..255";
            }
            description
              "The IP protocol to match against the IPv4 protocol number or
            the IPv6 Next- Header number in the packet. -1 means 'any IP
            protocol'.";
          }

          leaf citapStreamDestL4PortMin {
            smiv2:defval "0";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.11";
            type inet:port-number;
            description
              "The minimum value that the layer-4 destination port number in
            the packet must have in order to match.  This value must be
            equal to or less than the value specified for this entry in
            citapStreamDestL4PortMax.
            
            
            If both citapStreamDestL4PortMin and citapStreamDestL4PortMax
            are at their default values, the port number is effectively
            unused.";
          }

          leaf citapStreamDestL4PortMax {
            smiv2:defval "65535";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.12";
            type inet:port-number;
            description
              "The maximum value that the layer-4 destination port number in
            the packet must have in order to match this classifier entry.
            This value must be equal to or greater than the value specified
            for this entry in citapStreamDestL4PortMin.
            
            
            If both citapStreamDestL4PortMin and citapStreamDestL4PortMax
            are at their default values, the port number is effectively
            unused.";
          }

          leaf citapStreamSourceL4PortMin {
            smiv2:defval "0";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.13";
            type inet:port-number;
            description
              "The minimum value that the layer-4 destination port number in
            the packet must have in order to match.  This value must be
            equal to or less than the value specified for this entry in
            citapStreamSourceL4PortMax.
            
            
            If both citapStreamSourceL4PortMin and
            citapStreamSourceL4PortMax are at their default values, the
            port number is effectively unused.";
          }

          leaf citapStreamSourceL4PortMax {
            smiv2:defval "65535";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.14";
            type inet:port-number;
            description
              "The maximum value that the layer-4 destination port number in
            the packet must have in order to match this classifier entry.
            This value must be equal to or greater than the value specified
            for this entry in citapStreamSourceL4PortMin.
            
            
            If both citapStreamSourceL4PortMin and
            citapStreamSourceL4PortMax are at their default values, the
            port number is effectively unused.";
          }

          leaf citapStreamVRF {
            smiv2:defval "";
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.15";
            type snmp-framework:SnmpAdminString;
            description
              "An ASCII string, which is the name of a Virtual Routing
            and Forwarding (VRF) table comprising the routing context
            of a Virtual Private Network. The interface or set of 
            interfaces on which the packet might be found should be 
            selected from the set of interfaces in the VRF table. 
            A string length of zero implies that global routing table
            be used for selection of interfaces on which the packet
            might be found.";
          }

          leaf citapStreamStatus {
            smiv2:max-access "read-write";
            smiv2:oid "1.3.6.1.4.1.9.9.394.1.1.2.1.16";
            type snmpv2-tc:RowStatus;
            description
              "The status of this conceptual row. This object manages
            creation, modification, and deletion of rows in this table.
            When any rows must be changed, citapStreamStatus must be first 
            set to 'notInService'.";
          }
        }  // list citapStreamEntry
      }  // container citapStreamTable
    }  // container CISCO-IP-TAP-MIB
  }  // module CISCO-IP-TAP-MIB