TUNNEL-MIB
File:
TUNNEL-MIB.mib (30007 bytes)
Imported modules
Imported symbols
Defined Types
TunnelIfEntry |
|
SEQUENCE |
|
|
|
|
tunnelIfLocalAddress |
IpAddress |
|
|
tunnelIfRemoteAddress |
IpAddress |
|
|
tunnelIfEncapsMethod |
IANAtunnelType |
|
|
tunnelIfHopLimit |
Integer32 |
|
|
tunnelIfSecurity |
INTEGER |
|
|
tunnelIfTOS |
Integer32 |
|
|
tunnelIfFlowLabel |
Integer32 |
|
|
tunnelIfAddressType |
InetAddressType |
|
|
tunnelIfLocalInetAddress |
InetAddress |
|
|
tunnelIfRemoteInetAddress |
InetAddress |
|
|
tunnelIfEncapsLimit |
Integer32 |
|
TunnelConfigEntry |
|
SEQUENCE |
|
|
|
|
tunnelConfigLocalAddress |
IpAddress |
|
|
tunnelConfigRemoteAddress |
IpAddress |
|
|
tunnelConfigEncapsMethod |
IANAtunnelType |
|
|
tunnelConfigID |
Integer32 |
|
|
tunnelConfigIfIndex |
InterfaceIndexOrZero |
|
|
tunnelConfigStatus |
RowStatus |
|
TunnelInetConfigEntry |
|
SEQUENCE |
|
|
|
|
tunnelInetConfigAddressType |
InetAddressType |
|
|
tunnelInetConfigLocalAddress |
InetAddress |
|
|
tunnelInetConfigRemoteAddress |
InetAddress |
|
|
tunnelInetConfigEncapsMethod |
IANAtunnelType |
|
|
tunnelInetConfigID |
Integer32 |
|
|
tunnelInetConfigIfIndex |
InterfaceIndexOrZero |
|
|
tunnelInetConfigStatus |
RowStatus |
|
|
tunnelInetConfigStorageType |
StorageType |
|
Defined Values
tunnelMIB |
1.3.6.1.2.1.10.131 |
The MIB module for management of IP Tunnels,
independent of the specific encapsulation scheme in
use.
Copyright (C) The Internet Society (2005). This
version of this MIB module is part of RFC 4087; see
the RFC itself for full legal notices. |
MODULE-IDENTITY |
|
|
|
tunnel |
1.3.6.1.2.1.10.131.1.1 |
OBJECT IDENTIFIER |
|
|
|
tunnelIfTable |
1.3.6.1.2.1.10.131.1.1.1 |
The (conceptual) table containing information on
configured tunnels. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
TunnelIfEntry |
|
tunnelIfEntry |
1.3.6.1.2.1.10.131.1.1.1.1 |
An entry (conceptual row) containing the information
on a particular configured tunnel. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
TunnelIfEntry |
|
|
tunnelIfLocalAddress |
1.3.6.1.2.1.10.131.1.1.1.1.1 |
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. |
Status: deprecated |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
IpAddress |
|
|
tunnelIfRemoteAddress |
1.3.6.1.2.1.10.131.1.1.1.1.2 |
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. |
Status: deprecated |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
IpAddress |
|
|
tunnelIfHopLimit |
1.3.6.1.2.1.10.131.1.1.1.1.4 |
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. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
Integer32 |
0 | 1..255 |
|
tunnelIfSecurity |
1.3.6.1.2.1.10.131.1.1.1.1.5 |
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. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
none(1), ipsec(2), other(3) |
|
tunnelIfTOS |
1.3.6.1.2.1.10.131.1.1.1.1.6 |
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. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
Integer32 |
-2..63 |
|
tunnelIfFlowLabel |
1.3.6.1.2.1.10.131.1.1.1.1.7 |
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. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
Integer32 |
-1..100 |
|
tunnelIfAddressType |
1.3.6.1.2.1.10.131.1.1.1.1.8 |
The type of address in the corresponding
tunnelIfLocalInetAddress and tunnelIfRemoteInetAddress
objects. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
InetAddressType |
|
|
tunnelIfLocalInetAddress |
1.3.6.1.2.1.10.131.1.1.1.1.9 |
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. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
InetAddress |
|
|
tunnelIfRemoteInetAddress |
1.3.6.1.2.1.10.131.1.1.1.1.10 |
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. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
InetAddress |
|
|
tunnelIfEncapsLimit |
1.3.6.1.2.1.10.131.1.1.1.1.11 |
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). |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
Integer32 |
-1 | 0..255 |
|
tunnelConfigTable |
1.3.6.1.2.1.10.131.1.1.2 |
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 IPv4
destination address should have a corresponding row in
the tunnelConfigTable, regardless of whether it was
created via SNMP.
Since this table does not support IPv6, it is
deprecated in favor of tunnelInetConfigTable. |
Status: deprecated |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
TunnelConfigEntry |
|
tunnelConfigEntry |
1.3.6.1.2.1.10.131.1.1.2.1 |
An entry (conceptual row) containing the information
on a particular configured tunnel.
Since this entry does not support IPv6, it is
deprecated in favor of tunnelInetConfigEntry. |
Status: deprecated |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
TunnelConfigEntry |
|
|
tunnelConfigLocalAddress |
1.3.6.1.2.1.10.131.1.1.2.1.1 |
The address of the local endpoint of the tunnel, or
0.0.0.0 if the device is free to choose any of its
addresses at tunnel establishment time.
Since this object does not support IPv6, it is
deprecated in favor of tunnelInetConfigLocalAddress. |
Status: deprecated |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
IpAddress |
|
|
tunnelConfigRemoteAddress |
1.3.6.1.2.1.10.131.1.1.2.1.2 |
The address of the remote endpoint of the tunnel.
Since this object does not support IPv6, it is
deprecated in favor of tunnelInetConfigRemoteAddress. |
Status: deprecated |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
IpAddress |
|
|
tunnelConfigEncapsMethod |
1.3.6.1.2.1.10.131.1.1.2.1.3 |
The encapsulation method used by the tunnel.
Since this object does not support IPv6, it is
deprecated in favor of tunnelInetConfigEncapsMethod. |
Status: deprecated |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
IANAtunnelType |
|
|
tunnelConfigID |
1.3.6.1.2.1.10.131.1.1.2.1.4 |
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.
Since this object does not support IPv6, it is
deprecated in favor of tunnelInetConfigID. |
Status: deprecated |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
Integer32 |
1..2147483647 |
|
tunnelConfigIfIndex |
1.3.6.1.2.1.10.131.1.1.2.1.5 |
If the value of tunnelConfigStatus 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.
Since this object does not support IPv6, it is
deprecated in favor of tunnelInetConfigIfIndex. |
Status: deprecated |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
InterfaceIndexOrZero |
|
|
tunnelConfigStatus |
1.3.6.1.2.1.10.131.1.1.2.1.6 |
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 tunnelConfigID of 1, and
set tunnelConfigStatus 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 tunnelConfigID and
set tunnelConfigStatus 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.
Since this object does not support IPv6, it is
deprecated in favor of tunnelInetConfigStatus. |
Status: deprecated |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
RowStatus |
|
|
tunnelInetConfigTable |
1.3.6.1.2.1.10.131.1.1.3 |
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. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
TunnelInetConfigEntry |
|
tunnelInetConfigEntry |
1.3.6.1.2.1.10.131.1.1.3.1 |
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. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
TunnelInetConfigEntry |
|
|
tunnelInetConfigLocalAddress |
1.3.6.1.2.1.10.131.1.1.3.1.2 |
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. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
InetAddress |
|
|
tunnelInetConfigID |
1.3.6.1.2.1.10.131.1.1.3.1.5 |
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. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
Integer32 |
1..2147483647 |
|
tunnelInetConfigIfIndex |
1.3.6.1.2.1.10.131.1.1.3.1.6 |
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. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
InterfaceIndexOrZero |
|
|
tunnelInetConfigStatus |
1.3.6.1.2.1.10.131.1.1.3.1.7 |
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. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
RowStatus |
|
|
tunnelInetConfigStorageType |
1.3.6.1.2.1.10.131.1.1.3.1.8 |
The storage type of this row. If the row is
permanent(4), no objects in the row need be writable. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
StorageType |
|
|
tunnelMIBCompliance |
1.3.6.1.2.1.10.131.2.1.1 |
The (deprecated) IPv4-only compliance statement for
the IP Tunnel MIB.
This is deprecated in favor of
tunnelMIBInetFullCompliance and
tunnelMIBInetReadOnlyCompliance. |
Status: deprecated |
Access: read-only |
MODULE-COMPLIANCE |
|
|
|
tunnelMIBInetFullCompliance |
1.3.6.1.2.1.10.131.2.1.2 |
The full compliance statement for the IP Tunnel MIB. |
Status: current |
Access: read-only |
MODULE-COMPLIANCE |
|
|
|
tunnelMIBInetReadOnlyCompliance |
1.3.6.1.2.1.10.131.2.1.3 |
The read-only compliance statement for the IP Tunnel
MIB. |
Status: current |
Access: read-only |
MODULE-COMPLIANCE |
|
|
|
tunnelMIBBasicGroup |
1.3.6.1.2.1.10.131.2.2.1 |
A collection of objects to support basic management
of IPv4 Tunnels. Since this group cannot support
IPv6, it is deprecated in favor of
tunnelMIBInetGroup. |
Status: deprecated |
Access: read-only |
OBJECT-GROUP |
|
|
|
tunnelMIBInetGroup |
1.3.6.1.2.1.10.131.2.2.2 |
A collection of objects to support basic management
of IPv4 and IPv6 Tunnels. |
Status: current |
Access: read-only |
OBJECT-GROUP |
|
|
|