SCALAR OBJECTS

Name	Type	Access	OID	Description

TABLE OBJECTS

Table tunnelIfTable

Table Name	tunnelIfTable
In MIB	TUNNEL-MIB
Registered at OID	.1.3.6.1.2.1.10.131.1.1.1
Table Description	The (conceptual) table containing information on configured tunnels.
Row Description	An entry (conceptual row) containing the information on a particular configured tunnel.

tunnelIfTable Indexes:

Name	Type	Access	Description
1 ifIndex	INTEGER32 Legal values: 1 .. 2147483647 InterfaceIndex	ReadOnly	Note: this object is based on the InterfaceIndex TEXTUAL-CONVENTION. A unique value, greater than zero, for each interface. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re- initialization.

Other tunnelIfTable Columns:

Name	Type	Access	Description
1 tunnelIfLocalAddress	DEPRECATED IPADDR	ReadOnly	The address of the local endpoint of the tunnel (i.e., the source address used in the outer IP header), or 0.0.0.0 if unknown or if the tunnel is over IPv6. Since this object does not support IPv6, it is deprecated in favor of tunnelIfLocalInetAddress.
2 tunnelIfRemoteAddress	DEPRECATED IPADDR	ReadOnly	The address of the remote endpoint of the tunnel (i.e., the destination address used in the outer IP header), or 0.0.0.0 if unknown, or an IPv6 address, or the tunnel is not a point-to-point link (e.g., if it is a 6to4 tunnel). Since this object does not support IPv6, it is deprecated in favor of tunnelIfRemoteInetAddress.
3 tunnelIfEncapsMethod	INTEGER IANAtunnelType (ENUM list below)	ReadOnly	Note: this object is based on the IANAtunnelType TEXTUAL-CONVENTION. The encapsulation method used by the tunnel.
4 tunnelIfHopLimit	INTEGER32 Legal values: 0 , 1 .. 255	ReadWrite	The IPv4 TTL or IPv6 Hop Limit to use in the outer IP header. A value of 0 indicates that the value is copied from the payload's header.
5 tunnelIfSecurity	INTEGER Value Label/Meaning 1 none 2 ipsec 3 other	ReadOnly	The method used by the tunnel to secure the outer IP header. The value ipsec indicates that IPsec is used between the tunnel endpoints for authentication or encryption or both. More specific security-related information may be available in a MIB module for the security protocol in use.
6 tunnelIfTOS	INTEGER32 Legal values: -2 .. 63	ReadWrite	The method used to set the high 6 bits (the differentiated services codepoint) of the IPv4 TOS or IPv6 Traffic Class in the outer IP header. A value of -1 indicates that the bits are copied from the payload's header. A value of -2 indicates that a traffic conditioner is invoked and more information may be available in a traffic conditioner MIB module. A value between 0 and 63 inclusive indicates that the bit field is set to the indicated value. Note: instead of the name tunnelIfTOS, a better name would have been tunnelIfDSCPMethod, but the existing name appeared in RFC 2667 and existing objects cannot be renamed.
7 tunnelIfFlowLabel	INTEGER32 Legal values: -1 , 0 .. 1048575 IPv6FlowLabelOrAny	ReadWrite	Note: this object is based on the IPv6FlowLabelOrAny TEXTUAL-CONVENTION. The method used to set the IPv6 Flow Label value. This object need not be present in rows where tunnelIfAddressType indicates the tunnel is not over IPv6. A value of -1 indicates that a traffic conditioner is invoked and more information may be available in a traffic conditioner MIB. Any other value indicates that the Flow Label field is set to the indicated value.
8 tunnelIfAddressType	INTEGER InetAddressType (ENUM list below)	ReadWrite	Note: this object is based on the InetAddressType TEXTUAL-CONVENTION. The type of address in the corresponding tunnelIfLocalInetAddress and tunnelIfRemoteInetAddress objects.
9 tunnelIfLocalInetAddress	OCTETSTR Legal Lengths: 0 .. 255 InetAddress	ReadWrite	Note: this object is based on the InetAddress TEXTUAL-CONVENTION. The address of the local endpoint of the tunnel (i.e., the source address used in the outer IP header). If the address is unknown, the value is 0.0.0.0 for IPv4 or :: for IPv6. The type of this object is given by tunnelIfAddressType.
10 tunnelIfRemoteInetAddress	OCTETSTR Legal Lengths: 0 .. 255 InetAddress	ReadWrite	Note: this object is based on the InetAddress TEXTUAL-CONVENTION. The address of the remote endpoint of the tunnel (i.e., the destination address used in the outer IP header). If the address is unknown or the tunnel is not a point-to-point link (e.g., if it is a 6to4 tunnel), the value is 0.0.0.0 for tunnels over IPv4 or :: for tunnels over IPv6. The type of this object is given by tunnelIfAddressType.
11 tunnelIfEncapsLimit	INTEGER32 Legal values: -1 , 0 .. 255	ReadWrite	The maximum number of additional encapsulations permitted for packets undergoing encapsulation at this node. A value of -1 indicates that no limit is present (except as a result of the packet size). Also see Reference: RFC 2473, section 4.1.1

Table tunnelInetConfigTable

Table Name	tunnelInetConfigTable
In MIB	TUNNEL-MIB
Registered at OID	.1.3.6.1.2.1.10.131.1.1.3
Table Description	The (conceptual) table containing information on configured tunnels. This table can be used to map a set of tunnel endpoints to the associated ifIndex value. It can also be used for row creation. Note that every row in the tunnelIfTable with a fixed destination address should have a corresponding row in the tunnelInetConfigTable, regardless of whether it was created via SNMP.
Row Description	An entry (conceptual row) containing the information on a particular configured tunnel. Note that there is a 128 subid maximum for object OIDs. Implementers need to be aware that if the total number of octets in tunnelInetConfigLocalAddress and tunnelInetConfigRemoteAddress exceeds 110 then OIDs of column instances in this table will have more than 128 sub-identifiers and cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3. In practice this is not expected to be a problem since IPv4 and IPv6 addresses will not cause the limit to be reached, but if other types are supported by an agent, care must be taken to ensure that the sum of the lengths do not cause the limit to be exceeded.

tunnelInetConfigTable Indexes:

Name	Type	Access	Description
1 tunnelInetConfigAddressType	INTEGER InetAddressType (ENUM list below)	NoAccess	Note: this object is based on the InetAddressType TEXTUAL-CONVENTION. The address type over which the tunnel encapsulates packets.
2 tunnelInetConfigLocalAddress	OCTETSTR Legal Lengths: 0 .. 255 InetAddress	NoAccess	Note: this object is based on the InetAddress TEXTUAL-CONVENTION. The address of the local endpoint of the tunnel, or 0.0.0.0 (for IPv4) or :: (for IPv6) if the device is free to choose any of its addresses at tunnel establishment time.
3 tunnelInetConfigRemoteAddress	OCTETSTR Legal Lengths: 0 .. 255 InetAddress	NoAccess	Note: this object is based on the InetAddress TEXTUAL-CONVENTION. The address of the remote endpoint of the tunnel.
4 tunnelInetConfigEncapsMethod	INTEGER IANAtunnelType (ENUM list below)	NoAccess	Note: this object is based on the IANAtunnelType TEXTUAL-CONVENTION. The encapsulation method used by the tunnel.
5 tunnelInetConfigID	INTEGER32 Legal values: 1 .. 2147483647	NoAccess	An identifier used to distinguish between multiple tunnels of the same encapsulation method, with the same endpoints. If the encapsulation protocol only allows one tunnel per set of endpoint addresses (such as for GRE or IP-in-IP), the value of this object is 1. For encapsulation methods (such as L2F) which allow multiple parallel tunnels, the manager is responsible for choosing any ID which does not conflict with an existing row, such as choosing a random number.

Other tunnelInetConfigTable Columns:

Name	Type	Access	Description
6 tunnelInetConfigIfIndex	INTEGER32 Legal values: 0 .. 2147483647 InterfaceIndexOrZero	ReadOnly	Note: this object is based on the InterfaceIndexOrZero TEXTUAL-CONVENTION. If the value of tunnelInetConfigStatus for this row is active, then this object contains the value of ifIndex corresponding to the tunnel interface. A value of 0 is not legal in the active state, and means that the interface index has not yet been assigned.
7 tunnelInetConfigStatus	INTEGER RowStatus (ENUM list below)	Create	Note: this object is based on the RowStatus TEXTUAL-CONVENTION. The status of this row, by which new entries may be created, or old entries deleted from this table. The agent need not support setting this object to createAndWait or notInService since there are no other writable objects in this table, and writable objects in rows of corresponding tables such as the tunnelIfTable may be modified while this row is active. To create a row in this table for an encapsulation method which does not support multiple parallel tunnels with the same endpoints, the management station should simply use a tunnelInetConfigID of 1, and set tunnelInetConfigStatus to createAndGo. For encapsulation methods such as L2F which allow multiple parallel tunnels, the management station may select a pseudo-random number to use as the tunnelInetConfigID and set tunnelInetConfigStatus to createAndGo. In the event that this ID is already in use and an inconsistentValue is returned in response to the set operation, the management station should simply select a new pseudo-random number and retry the operation. Creating a row in this table will cause an interface index to be assigned by the agent in an implementation-dependent manner, and corresponding rows will be instantiated in the ifTable and the tunnelIfTable. The status of this row will become active as soon as the agent assigns the interface index, regardless of whether the interface is operationally up. Deleting a row in this table will likewise delete the corresponding row in the ifTable and in the tunnelIfTable.
8 tunnelInetConfigStorageType	INTEGER StorageType (ENUM list below)	Create	Note: this object is based on the StorageType TEXTUAL-CONVENTION. The storage type of this row. If the row is permanent(4), no objects in the row need be writable.

DEPRECATED OR OBSOLETE OR HISTORIC OBJECTS

NOTIFICATIONS

TEXTUAL CONVENTIONS

These TEXTUAL-CONVENTIONS are used in other parts of the document above. They are SNMP's way of defining a datatype that is used repeatedly by other MIB objects. Any implementation implementing objects that use one of these definitions must follow its DESCRIPTION clause as well as the DESCRIPTION clause of the object itself.

Name	Type	Description
IPv6FlowLabelOrAny	INTEGER32	The flow identifier or Flow Label in an IPv6 packet header that may be used to discriminate traffic flows. The value of -1 is used to indicate a wildcard, i.e. any value.
InterfaceIndex	INTEGER32	A unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re-initialization.
StorageType	INTEGER Value Label/Meaning 1 other 2 volatile 3 nonVolatile 4 permanent 5 readOnly	Describes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted. If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.) Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable.
InetAddress	OCTETSTR	Denotes a generic Internet address. An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row. The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error. When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate.
InetAddressType	INTEGER Value Label/Meaning 0 unknown 1 ipv4 2 ipv6 3 ipv4z 4 ipv6z 16 dns	A value that represents a type of Internet address. unknown(0) An unknown address type. This value MUST be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below. ipv4(1) An IPv4 address as defined by the InetAddressIPv4 textual convention. ipv6(2) An IPv6 address as defined by the InetAddressIPv6 textual convention. ipv4z(3) A non-global IPv4 address including a zone index as defined by the InetAddressIPv4z textual convention. ipv6z(4) A non-global IPv6 address including a zone index as defined by the InetAddressIPv6z textual convention. dns(16) A DNS domain name as defined by the InetAddressDNS textual convention. Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType. To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation. Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)).
RowStatus	INTEGER Value Label/Meaning 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy	The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status
IANAtunnelType	INTEGER Value Label/Meaning 1 other 2 direct 3 gre 4 minimal 5 l2tp 6 pptp 7 l2f 8 udp 9 atmp 10 msdp 11 sixToFour 12 sixOverFour 13 isatap 14 teredo 15 ipHttps	The encapsulation method used by a tunnel. The value direct indicates that a packet is encapsulated directly within a normal IP header, with no intermediate header, and unicast to the remote tunnel endpoint (e.g., an RFC 2003 IP-in-IP tunnel, or an RFC 1933 IPv6-in-IPv4 tunnel). The value minimal indicates that a Minimal Forwarding Header (RFC 2004) is inserted between the outer header and the payload packet. The value UDP indicates that the payload packet is encapsulated within a normal UDP packet (e.g., RFC 1234). The values sixToFour, sixOverFour, and isatap indicates that an IPv6 packet is encapsulated directly within an IPv4 header, with no intermediate header, and unicast to the destination determined by the 6to4, 6over4, or ISATAP protocol. The remaining protocol-specific values indicate that a header of the protocol of that name is inserted between the outer header and the payload header. The assignment policy for IANAtunnelType values is identical to the policy for assigning IANAifType values.
InterfaceIndexOrZero	INTEGER32	This textual convention is an extension of the InterfaceIndex convention. The latter defines a greater than zero value used to identify an interface or interface sub-layer in the managed system. This extension permits the additional value of zero. the value zero is object-specific and must therefore be defined as part of the description of any object which uses this syntax. Examples of the usage of zero might include situations where interface was unknown, or when none or all interfaces need to be referenced.

TREE VIEW

Tree view generated by running: snmptranslate -Tp TUNNEL-MIB::tunnelMIB