Blame mibs/TUNNEL-MIB.txt

Packit fcad23
TUNNEL-MIB DEFINITIONS ::= BEGIN
Packit fcad23
Packit fcad23
IMPORTS
Packit fcad23
    MODULE-IDENTITY, OBJECT-TYPE, transmission,
Packit fcad23
    Integer32, IpAddress    FROM SNMPv2-SMI          -- [RFC2578]
Packit fcad23
Packit fcad23
    RowStatus, StorageType  FROM SNMPv2-TC           -- [RFC2579]
Packit fcad23
Packit fcad23
    MODULE-COMPLIANCE,
Packit fcad23
    OBJECT-GROUP            FROM SNMPv2-CONF         -- [RFC2580]
Packit fcad23
Packit fcad23
    InetAddressType,
Packit fcad23
    InetAddress             FROM INET-ADDRESS-MIB    -- [RFC4001]
Packit fcad23
Packit fcad23
    IPv6FlowLabelOrAny      FROM IPV6-FLOW-LABEL-MIB -- [RFC3595]
Packit fcad23
Packit fcad23
    ifIndex,
Packit fcad23
    InterfaceIndexOrZero    FROM IF-MIB              -- [RFC2863]
Packit fcad23
Packit fcad23
    IANAtunnelType          FROM IANAifType-MIB;     -- [IFTYPE]
Packit fcad23
Packit fcad23
tunnelMIB MODULE-IDENTITY
Packit fcad23
    LAST-UPDATED "200505160000Z" -- May 16, 2005
Packit fcad23
    ORGANIZATION "IETF IP Version 6 (IPv6) Working Group"
Packit fcad23
    CONTACT-INFO
Packit fcad23
            " Dave Thaler
Packit fcad23
              Microsoft Corporation
Packit fcad23
              One Microsoft Way
Packit fcad23
              Redmond, WA  98052-6399
Packit fcad23
              EMail: dthaler@microsoft.com"
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The MIB module for management of IP Tunnels,
Packit fcad23
            independent of the specific encapsulation scheme in
Packit fcad23
            use.
Packit fcad23
Packit fcad23
            Copyright (C) The Internet Society (2005).  This
Packit fcad23
            version of this MIB module is part of RFC 4087;  see
Packit fcad23
            the RFC itself for full legal notices."
Packit fcad23
Packit fcad23
    REVISION     "200505160000Z" -- May 16, 2005
Packit fcad23
    DESCRIPTION
Packit fcad23
            "IPv4-specific objects were deprecated, including
Packit fcad23
            tunnelIfLocalAddress, tunnelIfRemoteAddress, the
Packit fcad23
            tunnelConfigTable, and the tunnelMIBBasicGroup.
Packit fcad23
Packit fcad23
            Added IP version-agnostic objects that should be used
Packit fcad23
            instead, including tunnelIfAddressType,
Packit fcad23
            tunnelIfLocalInetAddress, tunnelIfRemoteInetAddress,
Packit fcad23
            the tunnelInetConfigTable, and the
Packit fcad23
            tunnelIMIBInetGroup.
Packit fcad23
Packit fcad23
            The new tunnelIfLocalInetAddress and
Packit fcad23
            tunnelIfRemoteInetAddress objects are read-write,
Packit fcad23
            rather than read-only.
Packit fcad23
Packit fcad23
            Updated DESCRIPTION clauses of existing version-
Packit fcad23
            agnostic objects (e.g., tunnelIfTOS) that contained
Packit fcad23
            IPv4-specific text to cover IPv6 as well.
Packit fcad23
Packit fcad23
            Added tunnelIfFlowLabel for tunnels over IPv6.
Packit fcad23
Packit fcad23
            The encapsulation method was previously an INTEGER
Packit fcad23
            type, and is now an IANA-maintained textual
Packit fcad23
            convention.
Packit fcad23
Packit fcad23
            Published as RFC 4087."
Packit fcad23
    REVISION     "199908241200Z" -- August 24, 1999
Packit fcad23
    DESCRIPTION
Packit fcad23
            "Initial version, published as RFC 2667."
Packit fcad23
    ::= { transmission 131 }
Packit fcad23
Packit fcad23
tunnelMIBObjects OBJECT IDENTIFIER ::= { tunnelMIB 1 }
Packit fcad23
Packit fcad23
tunnel      OBJECT IDENTIFIER ::= { tunnelMIBObjects 1 }
Packit fcad23
Packit fcad23
-- the IP Tunnel MIB-Group
Packit fcad23
--
Packit fcad23
-- a collection of objects providing information about
Packit fcad23
-- IP Tunnels
Packit fcad23
Packit fcad23
tunnelIfTable OBJECT-TYPE
Packit fcad23
    SYNTAX     SEQUENCE OF TunnelIfEntry
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The (conceptual) table containing information on
Packit fcad23
            configured tunnels."
Packit fcad23
    ::= { tunnel 1 }
Packit fcad23
Packit fcad23
tunnelIfEntry OBJECT-TYPE
Packit fcad23
    SYNTAX     TunnelIfEntry
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "An entry (conceptual row) containing the information
Packit fcad23
            on a particular configured tunnel."
Packit fcad23
    INDEX      { ifIndex }
Packit fcad23
    ::= { tunnelIfTable 1 }
Packit fcad23
Packit fcad23
TunnelIfEntry ::= SEQUENCE {
Packit fcad23
    tunnelIfLocalAddress            IpAddress,   -- deprecated
Packit fcad23
    tunnelIfRemoteAddress           IpAddress,   -- deprecated
Packit fcad23
    tunnelIfEncapsMethod            IANAtunnelType,
Packit fcad23
    tunnelIfHopLimit                Integer32,
Packit fcad23
    tunnelIfSecurity                INTEGER,
Packit fcad23
    tunnelIfTOS                     Integer32,
Packit fcad23
    tunnelIfFlowLabel               IPv6FlowLabelOrAny,
Packit fcad23
    tunnelIfAddressType             InetAddressType,
Packit fcad23
    tunnelIfLocalInetAddress        InetAddress,
Packit fcad23
    tunnelIfRemoteInetAddress       InetAddress,
Packit fcad23
    tunnelIfEncapsLimit             Integer32
Packit fcad23
}
Packit fcad23
Packit fcad23
tunnelIfLocalAddress OBJECT-TYPE
Packit fcad23
    SYNTAX     IpAddress
Packit fcad23
    MAX-ACCESS read-only
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The address of the local endpoint of the tunnel
Packit fcad23
            (i.e., the source address used in the outer IP
Packit fcad23
            header), or 0.0.0.0 if unknown or if the tunnel is
Packit fcad23
            over IPv6.
Packit fcad23
Packit fcad23
            Since this object does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelIfLocalInetAddress."
Packit fcad23
    ::= { tunnelIfEntry 1 }
Packit fcad23
Packit fcad23
tunnelIfRemoteAddress OBJECT-TYPE
Packit fcad23
    SYNTAX     IpAddress
Packit fcad23
    MAX-ACCESS read-only
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The address of the remote endpoint of the tunnel
Packit fcad23
            (i.e., the destination address used in the outer IP
Packit fcad23
            header), or 0.0.0.0 if unknown, or an IPv6 address, or
Packit fcad23
Packit fcad23
            the tunnel is not a point-to-point link (e.g., if it
Packit fcad23
            is a 6to4 tunnel).
Packit fcad23
Packit fcad23
            Since this object does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelIfRemoteInetAddress."
Packit fcad23
    ::= { tunnelIfEntry 2 }
Packit fcad23
Packit fcad23
tunnelIfEncapsMethod OBJECT-TYPE
Packit fcad23
    SYNTAX     IANAtunnelType
Packit fcad23
    MAX-ACCESS read-only
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The encapsulation method used by the tunnel."
Packit fcad23
    ::= { tunnelIfEntry 3 }
Packit fcad23
Packit fcad23
tunnelIfHopLimit OBJECT-TYPE
Packit fcad23
    SYNTAX     Integer32 (0 | 1..255)
Packit fcad23
    MAX-ACCESS read-write
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The IPv4 TTL or IPv6 Hop Limit to use in the outer IP
Packit fcad23
            header.  A value of 0 indicates that the value is
Packit fcad23
            copied from the payload's header."
Packit fcad23
    ::= { tunnelIfEntry 4 }
Packit fcad23
Packit fcad23
tunnelIfSecurity OBJECT-TYPE
Packit fcad23
    SYNTAX     INTEGER {
Packit fcad23
                   none(1),   -- no security
Packit fcad23
                   ipsec(2),  -- IPsec security
Packit fcad23
                   other(3)
Packit fcad23
               }
Packit fcad23
    MAX-ACCESS read-only
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The method used by the tunnel to secure the outer IP
Packit fcad23
            header.  The value ipsec indicates that IPsec is used
Packit fcad23
            between the tunnel endpoints for authentication or
Packit fcad23
            encryption or both.  More specific security-related
Packit fcad23
            information may be available in a MIB module for the
Packit fcad23
            security protocol in use."
Packit fcad23
    ::= { tunnelIfEntry 5 }
Packit fcad23
Packit fcad23
tunnelIfTOS OBJECT-TYPE
Packit fcad23
    SYNTAX     Integer32 (-2..63)
Packit fcad23
    MAX-ACCESS read-write
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The method used to set the high 6 bits (the
Packit fcad23
Packit fcad23
            differentiated services codepoint) of the IPv4 TOS or
Packit fcad23
            IPv6 Traffic Class in the outer IP header.  A value of
Packit fcad23
            -1 indicates that the bits are copied from the
Packit fcad23
            payload's header.  A value of -2 indicates that a
Packit fcad23
            traffic conditioner is invoked and more information
Packit fcad23
            may be available in a traffic conditioner MIB module.
Packit fcad23
            A value between 0 and 63 inclusive indicates that the
Packit fcad23
            bit field is set to the indicated value.
Packit fcad23
Packit fcad23
            Note: instead of the name tunnelIfTOS, a better name
Packit fcad23
            would have been tunnelIfDSCPMethod, but the existing
Packit fcad23
            name appeared in RFC 2667 and existing objects cannot
Packit fcad23
            be renamed."
Packit fcad23
    ::= { tunnelIfEntry 6 }
Packit fcad23
Packit fcad23
tunnelIfFlowLabel OBJECT-TYPE
Packit fcad23
    SYNTAX     IPv6FlowLabelOrAny
Packit fcad23
    MAX-ACCESS read-write
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The method used to set the IPv6 Flow Label value.
Packit fcad23
            This object need not be present in rows where
Packit fcad23
            tunnelIfAddressType indicates the tunnel is not over
Packit fcad23
            IPv6.  A value of -1 indicates that a traffic
Packit fcad23
            conditioner is invoked and more information may be
Packit fcad23
            available in a traffic conditioner MIB.  Any other
Packit fcad23
            value indicates that the Flow Label field is set to
Packit fcad23
            the indicated value."
Packit fcad23
    ::= { tunnelIfEntry 7 }
Packit fcad23
Packit fcad23
tunnelIfAddressType OBJECT-TYPE
Packit fcad23
    SYNTAX     InetAddressType
Packit fcad23
    MAX-ACCESS read-write
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The type of address in the corresponding
Packit fcad23
            tunnelIfLocalInetAddress and tunnelIfRemoteInetAddress
Packit fcad23
            objects."
Packit fcad23
    ::= { tunnelIfEntry 8 }
Packit fcad23
Packit fcad23
tunnelIfLocalInetAddress OBJECT-TYPE
Packit fcad23
    SYNTAX     InetAddress
Packit fcad23
    MAX-ACCESS read-write
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The address of the local endpoint of the tunnel
Packit fcad23
            (i.e., the source address used in the outer IP
Packit fcad23
            header).  If the address is unknown, the value is
Packit fcad23
Packit fcad23
            0.0.0.0 for IPv4 or :: for IPv6.  The type of this
Packit fcad23
            object is given by tunnelIfAddressType."
Packit fcad23
    ::= { tunnelIfEntry 9 }
Packit fcad23
Packit fcad23
tunnelIfRemoteInetAddress OBJECT-TYPE
Packit fcad23
    SYNTAX     InetAddress
Packit fcad23
    MAX-ACCESS read-write
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The address of the remote endpoint of the tunnel
Packit fcad23
            (i.e., the destination address used in the outer IP
Packit fcad23
            header).  If the address is unknown or the tunnel is
Packit fcad23
            not a point-to-point link (e.g., if it is a 6to4
Packit fcad23
            tunnel), the value is 0.0.0.0 for tunnels over IPv4 or
Packit fcad23
            :: for tunnels over IPv6.  The type of this object is
Packit fcad23
            given by tunnelIfAddressType."
Packit fcad23
    ::= { tunnelIfEntry 10 }
Packit fcad23
Packit fcad23
tunnelIfEncapsLimit OBJECT-TYPE
Packit fcad23
    SYNTAX     Integer32 (-1 | 0..255)
Packit fcad23
    MAX-ACCESS read-write
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The maximum number of additional encapsulations
Packit fcad23
            permitted for packets undergoing encapsulation at this
Packit fcad23
            node.  A value of -1 indicates that no limit is
Packit fcad23
            present (except as a result of the packet size)."
Packit fcad23
    REFERENCE  "RFC 2473, section 4.1.1"
Packit fcad23
    ::= { tunnelIfEntry 11 }
Packit fcad23
Packit fcad23
tunnelConfigTable OBJECT-TYPE
Packit fcad23
    SYNTAX     SEQUENCE OF TunnelConfigEntry
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The (conceptual) table containing information on
Packit fcad23
            configured tunnels.  This table can be used to map a
Packit fcad23
            set of tunnel endpoints to the associated ifIndex
Packit fcad23
            value.  It can also be used for row creation.  Note
Packit fcad23
            that every row in the tunnelIfTable with a fixed IPv4
Packit fcad23
            destination address should have a corresponding row in
Packit fcad23
            the tunnelConfigTable, regardless of whether it was
Packit fcad23
            created via SNMP.
Packit fcad23
Packit fcad23
            Since this table does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelInetConfigTable."
Packit fcad23
    ::= { tunnel 2 }
Packit fcad23
Packit fcad23
tunnelConfigEntry OBJECT-TYPE
Packit fcad23
    SYNTAX     TunnelConfigEntry
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "An entry (conceptual row) containing the information
Packit fcad23
            on a particular configured tunnel.
Packit fcad23
Packit fcad23
            Since this entry does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelInetConfigEntry."
Packit fcad23
    INDEX      { tunnelConfigLocalAddress,
Packit fcad23
                 tunnelConfigRemoteAddress,
Packit fcad23
                 tunnelConfigEncapsMethod,
Packit fcad23
                 tunnelConfigID }
Packit fcad23
    ::= { tunnelConfigTable 1 }
Packit fcad23
Packit fcad23
TunnelConfigEntry ::= SEQUENCE {
Packit fcad23
    tunnelConfigLocalAddress            IpAddress,
Packit fcad23
    tunnelConfigRemoteAddress           IpAddress,
Packit fcad23
    tunnelConfigEncapsMethod            IANAtunnelType,
Packit fcad23
    tunnelConfigID                      Integer32,
Packit fcad23
    tunnelConfigIfIndex                 InterfaceIndexOrZero,
Packit fcad23
    tunnelConfigStatus                  RowStatus
Packit fcad23
}
Packit fcad23
Packit fcad23
tunnelConfigLocalAddress OBJECT-TYPE
Packit fcad23
    SYNTAX     IpAddress
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The address of the local endpoint of the tunnel, or
Packit fcad23
            0.0.0.0 if the device is free to choose any of its
Packit fcad23
            addresses at tunnel establishment time.
Packit fcad23
Packit fcad23
            Since this object does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelInetConfigLocalAddress."
Packit fcad23
    ::= { tunnelConfigEntry 1 }
Packit fcad23
Packit fcad23
tunnelConfigRemoteAddress OBJECT-TYPE
Packit fcad23
    SYNTAX     IpAddress
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The address of the remote endpoint of the tunnel.
Packit fcad23
Packit fcad23
            Since this object does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelInetConfigRemoteAddress."
Packit fcad23
    ::= { tunnelConfigEntry 2 }
Packit fcad23
Packit fcad23
tunnelConfigEncapsMethod OBJECT-TYPE
Packit fcad23
    SYNTAX     IANAtunnelType
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The encapsulation method used by the tunnel.
Packit fcad23
Packit fcad23
            Since this object does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelInetConfigEncapsMethod."
Packit fcad23
    ::= { tunnelConfigEntry 3 }
Packit fcad23
Packit fcad23
tunnelConfigID OBJECT-TYPE
Packit fcad23
    SYNTAX     Integer32 (1..2147483647)
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "An identifier used to distinguish between multiple
Packit fcad23
            tunnels of the same encapsulation method, with the
Packit fcad23
            same endpoints.  If the encapsulation protocol only
Packit fcad23
            allows one tunnel per set of endpoint addresses (such
Packit fcad23
            as for GRE or IP-in-IP), the value of this object is
Packit fcad23
            1.  For encapsulation methods (such as L2F) which
Packit fcad23
            allow multiple parallel tunnels, the manager is
Packit fcad23
            responsible for choosing any ID which does not
Packit fcad23
            conflict with an existing row, such as choosing a
Packit fcad23
            random number.
Packit fcad23
Packit fcad23
            Since this object does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelInetConfigID."
Packit fcad23
    ::= { tunnelConfigEntry 4 }
Packit fcad23
Packit fcad23
tunnelConfigIfIndex OBJECT-TYPE
Packit fcad23
    SYNTAX     InterfaceIndexOrZero
Packit fcad23
    MAX-ACCESS read-only
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "If the value of tunnelConfigStatus for this row is
Packit fcad23
            active, then this object contains the value of ifIndex
Packit fcad23
            corresponding to the tunnel interface.  A value of 0
Packit fcad23
            is not legal in the active state, and means that the
Packit fcad23
            interface index has not yet been assigned.
Packit fcad23
Packit fcad23
            Since this object does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelInetConfigIfIndex."
Packit fcad23
    ::= { tunnelConfigEntry 5 }
Packit fcad23
Packit fcad23
tunnelConfigStatus OBJECT-TYPE
Packit fcad23
    SYNTAX     RowStatus
Packit fcad23
    MAX-ACCESS read-create
Packit fcad23
    STATUS     deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The status of this row, by which new entries may be
Packit fcad23
            created, or old entries deleted from this table.  The
Packit fcad23
            agent need not support setting this object to
Packit fcad23
            createAndWait or notInService since there are no other
Packit fcad23
            writable objects in this table, and writable objects
Packit fcad23
            in rows of corresponding tables such as the
Packit fcad23
            tunnelIfTable may be modified while this row is
Packit fcad23
            active.
Packit fcad23
Packit fcad23
            To create a row in this table for an encapsulation
Packit fcad23
            method which does not support multiple parallel
Packit fcad23
            tunnels with the same endpoints, the management
Packit fcad23
            station should simply use a tunnelConfigID of 1, and
Packit fcad23
            set tunnelConfigStatus to createAndGo.  For
Packit fcad23
            encapsulation methods such as L2F which allow multiple
Packit fcad23
            parallel tunnels, the management station may select a
Packit fcad23
            pseudo-random number to use as the tunnelConfigID and
Packit fcad23
            set tunnelConfigStatus to createAndGo.  In the event
Packit fcad23
            that this ID is already in use and an
Packit fcad23
            inconsistentValue is returned in response to the set
Packit fcad23
            operation, the management station should simply select
Packit fcad23
            a new pseudo-random number and retry the operation.
Packit fcad23
Packit fcad23
            Creating a row in this table will cause an interface
Packit fcad23
            index to be assigned by the agent in an
Packit fcad23
            implementation-dependent manner, and corresponding
Packit fcad23
            rows will be instantiated in the ifTable and the
Packit fcad23
            tunnelIfTable.  The status of this row will become
Packit fcad23
            active as soon as the agent assigns the interface
Packit fcad23
            index, regardless of whether the interface is
Packit fcad23
            operationally up.
Packit fcad23
Packit fcad23
            Deleting a row in this table will likewise delete the
Packit fcad23
            corresponding row in the ifTable and in the
Packit fcad23
            tunnelIfTable.
Packit fcad23
Packit fcad23
            Since this object does not support IPv6, it is
Packit fcad23
            deprecated in favor of tunnelInetConfigStatus."
Packit fcad23
    ::= { tunnelConfigEntry 6 }
Packit fcad23
Packit fcad23
tunnelInetConfigTable OBJECT-TYPE
Packit fcad23
    SYNTAX     SEQUENCE OF TunnelInetConfigEntry
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The (conceptual) table containing information on
Packit fcad23
            configured tunnels.  This table can be used to map a
Packit fcad23
            set of tunnel endpoints to the associated ifIndex
Packit fcad23
            value.  It can also be used for row creation.  Note
Packit fcad23
            that every row in the tunnelIfTable with a fixed
Packit fcad23
            destination address should have a corresponding row in
Packit fcad23
            the tunnelInetConfigTable, regardless of whether it
Packit fcad23
            was created via SNMP."
Packit fcad23
    ::= { tunnel 3 }
Packit fcad23
Packit fcad23
tunnelInetConfigEntry OBJECT-TYPE
Packit fcad23
    SYNTAX     TunnelInetConfigEntry
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "An entry (conceptual row) containing the information
Packit fcad23
            on a particular configured tunnel.  Note that there is
Packit fcad23
            a 128 subid maximum for object OIDs.  Implementers
Packit fcad23
            need to be aware that if the total number of octets in
Packit fcad23
            tunnelInetConfigLocalAddress and
Packit fcad23
            tunnelInetConfigRemoteAddress exceeds 110 then OIDs of
Packit fcad23
            column instances in this table will have more than 128
Packit fcad23
            sub-identifiers and cannot be accessed using SNMPv1,
Packit fcad23
            SNMPv2c, or SNMPv3.  In practice this is not expected
Packit fcad23
            to be a problem since IPv4 and IPv6 addresses will not
Packit fcad23
            cause the limit to be reached, but if other types are
Packit fcad23
            supported by an agent, care must be taken to ensure
Packit fcad23
            that the sum of the lengths do not cause the limit to
Packit fcad23
            be exceeded."
Packit fcad23
    INDEX      { tunnelInetConfigAddressType,
Packit fcad23
                 tunnelInetConfigLocalAddress,
Packit fcad23
                 tunnelInetConfigRemoteAddress,
Packit fcad23
                 tunnelInetConfigEncapsMethod,
Packit fcad23
                 tunnelInetConfigID }
Packit fcad23
    ::= { tunnelInetConfigTable 1 }
Packit fcad23
Packit fcad23
TunnelInetConfigEntry ::= SEQUENCE {
Packit fcad23
    tunnelInetConfigAddressType         InetAddressType,
Packit fcad23
    tunnelInetConfigLocalAddress        InetAddress,
Packit fcad23
    tunnelInetConfigRemoteAddress       InetAddress,
Packit fcad23
    tunnelInetConfigEncapsMethod        IANAtunnelType,
Packit fcad23
    tunnelInetConfigID                  Integer32,
Packit fcad23
    tunnelInetConfigIfIndex             InterfaceIndexOrZero,
Packit fcad23
    tunnelInetConfigStatus              RowStatus,
Packit fcad23
    tunnelInetConfigStorageType         StorageType
Packit fcad23
}
Packit fcad23
Packit fcad23
tunnelInetConfigAddressType OBJECT-TYPE
Packit fcad23
    SYNTAX     InetAddressType
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The address type over which the tunnel encapsulates
Packit fcad23
            packets."
Packit fcad23
    ::= { tunnelInetConfigEntry 1 }
Packit fcad23
Packit fcad23
tunnelInetConfigLocalAddress OBJECT-TYPE
Packit fcad23
    SYNTAX     InetAddress
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The address of the local endpoint of the tunnel, or
Packit fcad23
            0.0.0.0 (for IPv4) or :: (for IPv6) if the device is
Packit fcad23
            free to choose any of its addresses at tunnel
Packit fcad23
            establishment time."
Packit fcad23
    ::= { tunnelInetConfigEntry 2 }
Packit fcad23
Packit fcad23
tunnelInetConfigRemoteAddress OBJECT-TYPE
Packit fcad23
    SYNTAX     InetAddress
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The address of the remote endpoint of the tunnel."
Packit fcad23
    ::= { tunnelInetConfigEntry 3 }
Packit fcad23
Packit fcad23
tunnelInetConfigEncapsMethod OBJECT-TYPE
Packit fcad23
    SYNTAX     IANAtunnelType
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The encapsulation method used by the tunnel."
Packit fcad23
    ::= { tunnelInetConfigEntry 4 }
Packit fcad23
Packit fcad23
tunnelInetConfigID OBJECT-TYPE
Packit fcad23
    SYNTAX     Integer32 (1..2147483647)
Packit fcad23
    MAX-ACCESS not-accessible
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "An identifier used to distinguish between multiple
Packit fcad23
            tunnels of the same encapsulation method, with the
Packit fcad23
            same endpoints.  If the encapsulation protocol only
Packit fcad23
            allows one tunnel per set of endpoint addresses (such
Packit fcad23
            as for GRE or IP-in-IP), the value of this object is
Packit fcad23
            1.  For encapsulation methods (such as L2F) which
Packit fcad23
            allow multiple parallel tunnels, the manager is
Packit fcad23
            responsible for choosing any ID which does not
Packit fcad23
Packit fcad23
            conflict with an existing row, such as choosing a
Packit fcad23
            random number."
Packit fcad23
    ::= { tunnelInetConfigEntry 5 }
Packit fcad23
Packit fcad23
tunnelInetConfigIfIndex OBJECT-TYPE
Packit fcad23
    SYNTAX     InterfaceIndexOrZero
Packit fcad23
    MAX-ACCESS read-only
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "If the value of tunnelInetConfigStatus for this row
Packit fcad23
            is active, then this object contains the value of
Packit fcad23
            ifIndex corresponding to the tunnel interface.  A
Packit fcad23
            value of 0 is not legal in the active state, and means
Packit fcad23
            that the interface index has not yet been assigned."
Packit fcad23
    ::= { tunnelInetConfigEntry 6 }
Packit fcad23
Packit fcad23
tunnelInetConfigStatus OBJECT-TYPE
Packit fcad23
    SYNTAX     RowStatus
Packit fcad23
    MAX-ACCESS read-create
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The status of this row, by which new entries may be
Packit fcad23
            created, or old entries deleted from this table.  The
Packit fcad23
            agent need not support setting this object to
Packit fcad23
            createAndWait or notInService since there are no other
Packit fcad23
            writable objects in this table, and writable objects
Packit fcad23
            in rows of corresponding tables such as the
Packit fcad23
            tunnelIfTable may be modified while this row is
Packit fcad23
            active.
Packit fcad23
Packit fcad23
            To create a row in this table for an encapsulation
Packit fcad23
            method which does not support multiple parallel
Packit fcad23
            tunnels with the same endpoints, the management
Packit fcad23
            station should simply use a tunnelInetConfigID of 1,
Packit fcad23
            and set tunnelInetConfigStatus to createAndGo.  For
Packit fcad23
            encapsulation methods such as L2F which allow multiple
Packit fcad23
            parallel tunnels, the management station may select a
Packit fcad23
            pseudo-random number to use as the tunnelInetConfigID
Packit fcad23
            and set tunnelInetConfigStatus to createAndGo.  In the
Packit fcad23
            event that this ID is already in use and an
Packit fcad23
            inconsistentValue is returned in response to the set
Packit fcad23
            operation, the management station should simply select
Packit fcad23
            a new pseudo-random number and retry the operation.
Packit fcad23
Packit fcad23
            Creating a row in this table will cause an interface
Packit fcad23
            index to be assigned by the agent in an
Packit fcad23
            implementation-dependent manner, and corresponding
Packit fcad23
            rows will be instantiated in the ifTable and the
Packit fcad23
Packit fcad23
            tunnelIfTable.  The status of this row will become
Packit fcad23
            active as soon as the agent assigns the interface
Packit fcad23
            index, regardless of whether the interface is
Packit fcad23
            operationally up.
Packit fcad23
Packit fcad23
            Deleting a row in this table will likewise delete the
Packit fcad23
            corresponding row in the ifTable and in the
Packit fcad23
            tunnelIfTable."
Packit fcad23
    ::= { tunnelInetConfigEntry 7 }
Packit fcad23
Packit fcad23
tunnelInetConfigStorageType OBJECT-TYPE
Packit fcad23
    SYNTAX     StorageType
Packit fcad23
    MAX-ACCESS read-create
Packit fcad23
    STATUS     current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The storage type of this row.  If the row is
Packit fcad23
            permanent(4), no objects in the row need be writable."
Packit fcad23
    ::= { tunnelInetConfigEntry 8 }
Packit fcad23
Packit fcad23
-- conformance information
Packit fcad23
Packit fcad23
tunnelMIBConformance
Packit fcad23
                  OBJECT IDENTIFIER ::= { tunnelMIB 2 }
Packit fcad23
tunnelMIBCompliances
Packit fcad23
                  OBJECT IDENTIFIER ::= { tunnelMIBConformance 1 }
Packit fcad23
tunnelMIBGroups  OBJECT IDENTIFIER ::= { tunnelMIBConformance 2 }
Packit fcad23
Packit fcad23
-- compliance statements
Packit fcad23
Packit fcad23
tunnelMIBCompliance MODULE-COMPLIANCE
Packit fcad23
    STATUS  deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The (deprecated) IPv4-only compliance statement for
Packit fcad23
            the IP Tunnel MIB.
Packit fcad23
Packit fcad23
            This is deprecated in favor of
Packit fcad23
            tunnelMIBInetFullCompliance and
Packit fcad23
            tunnelMIBInetReadOnlyCompliance."
Packit fcad23
    MODULE  -- this module
Packit fcad23
    MANDATORY-GROUPS { tunnelMIBBasicGroup }
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfHopLimit
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfTOS
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
Packit fcad23
        OBJECT      tunnelConfigStatus
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
   ::= { tunnelMIBCompliances 1 }
Packit fcad23
Packit fcad23
tunnelMIBInetFullCompliance MODULE-COMPLIANCE
Packit fcad23
    STATUS  current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The full compliance statement for the IP Tunnel MIB."
Packit fcad23
    MODULE  -- this module
Packit fcad23
    MANDATORY-GROUPS { tunnelMIBInetGroup }
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfAddressType
Packit fcad23
        SYNTAX      InetAddressType { ipv4(1), ipv6(2),
Packit fcad23
                                      ipv4z(3), ipv6z(4) }
Packit fcad23
        DESCRIPTION
Packit fcad23
            "An implementation is only required to support IPv4
Packit fcad23
            and/or IPv6 addresses.  An implementation only needs to
Packit fcad23
            support the addresses it actually supports on the
Packit fcad23
            device."
Packit fcad23
   ::= { tunnelMIBCompliances 2 }
Packit fcad23
Packit fcad23
tunnelMIBInetReadOnlyCompliance MODULE-COMPLIANCE
Packit fcad23
    STATUS  current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "The read-only compliance statement for the IP Tunnel
Packit fcad23
            MIB."
Packit fcad23
    MODULE  -- this module
Packit fcad23
    MANDATORY-GROUPS { tunnelMIBInetGroup }
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfHopLimit
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfTOS
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfFlowLabel
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfAddressType
Packit fcad23
        SYNTAX      InetAddressType { ipv4(1), ipv6(2),
Packit fcad23
                                      ipv4z(3), ipv6z(4) }
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required.
Packit fcad23
Packit fcad23
            An implementation is only required to support IPv4
Packit fcad23
            and/or IPv6 addresses.  An implementation only needs to
Packit fcad23
            support the addresses it actually supports on the
Packit fcad23
            device."
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfLocalInetAddress
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfRemoteInetAddress
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
Packit fcad23
        OBJECT      tunnelIfEncapsLimit
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
Packit fcad23
        OBJECT      tunnelInetConfigStatus
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required, and active is the only
Packit fcad23
            status that needs to be supported."
Packit fcad23
Packit fcad23
        OBJECT      tunnelInetConfigStorageType
Packit fcad23
        MIN-ACCESS  read-only
Packit fcad23
        DESCRIPTION
Packit fcad23
            "Write access is not required."
Packit fcad23
   ::= { tunnelMIBCompliances 3 }
Packit fcad23
Packit fcad23
-- units of conformance
Packit fcad23
Packit fcad23
tunnelMIBBasicGroup OBJECT-GROUP
Packit fcad23
    OBJECTS { tunnelIfLocalAddress, tunnelIfRemoteAddress,
Packit fcad23
       tunnelIfEncapsMethod, tunnelIfHopLimit, tunnelIfTOS,
Packit fcad23
       tunnelIfSecurity, tunnelConfigIfIndex, tunnelConfigStatus }
Packit fcad23
    STATUS  deprecated
Packit fcad23
    DESCRIPTION
Packit fcad23
            "A collection of objects to support basic management
Packit fcad23
Packit fcad23
            of IPv4 Tunnels.  Since this group cannot support
Packit fcad23
            IPv6, it is deprecated in favor of
Packit fcad23
            tunnelMIBInetGroup."
Packit fcad23
    ::= { tunnelMIBGroups 1 }
Packit fcad23
Packit fcad23
tunnelMIBInetGroup OBJECT-GROUP
Packit fcad23
    OBJECTS { tunnelIfAddressType, tunnelIfLocalInetAddress,
Packit fcad23
       tunnelIfRemoteInetAddress, tunnelIfEncapsMethod,
Packit fcad23
       tunnelIfEncapsLimit,
Packit fcad23
       tunnelIfHopLimit, tunnelIfTOS, tunnelIfFlowLabel,
Packit fcad23
       tunnelIfSecurity, tunnelInetConfigIfIndex,
Packit fcad23
       tunnelInetConfigStatus, tunnelInetConfigStorageType }
Packit fcad23
    STATUS  current
Packit fcad23
    DESCRIPTION
Packit fcad23
            "A collection of objects to support basic management
Packit fcad23
            of IPv4 and IPv6 Tunnels."
Packit fcad23
    ::= { tunnelMIBGroups 2 }
Packit fcad23
Packit fcad23
END