This is a summary of information regarding objects below the ipForward MIB object, which is defined within the IP-FORWARD-MIB MIB document as .1.3.6.1.2.1.4.24.
Name | Type | Access | Description |
---|---|---|---|
1
inetCidrRouteDestType |
INTEGER
InetAddressType (ENUM list below) | NoAccess |
Note: this object is based on the InetAddressType TEXTUAL-CONVENTION. The type of the inetCidrRouteDest address, as defined in the InetAddress MIB. Only those address types that may appear in an actual routing table are allowed as values of this object. Also see Reference:
|
2
inetCidrRouteDest |
OCTETSTR
Legal Lengths: 0 .. 255 InetAddress | NoAccess |
Note: this object is based on the InetAddress TEXTUAL-CONVENTION. The destination IP address of this route. The type of this address is determined by the value of the inetCidrRouteDestType object. The values for the index objects inetCidrRouteDest and inetCidrRoutePfxLen must be consistent. When the value of inetCidrRouteDest (excluding the zone index, if one is present) is x, then the bitwise logical-AND of x with the value of the mask formed from the corresponding index object inetCidrRoutePfxLen MUST be equal to x. If not, then the index pair is not consistent and an inconsistentName error must be returned on SET or CREATE requests. |
3
inetCidrRoutePfxLen |
UNSIGNED32
Legal values: 0 .. 2040 InetAddressPrefixLength | NoAccess |
Note: this object is based on the InetAddressPrefixLength TEXTUAL-CONVENTION. Indicates the number of leading one bits that form the mask to be logical-ANDed with the destination address before being compared to the value in the inetCidrRouteDest field. The values for the index objects inetCidrRouteDest and inetCidrRoutePfxLen must be consistent. When the value of inetCidrRouteDest (excluding the zone index, if one is present) is x, then the bitwise logical-AND of x with the value of the mask formed from the corresponding index object inetCidrRoutePfxLen MUST be equal to x. If not, then the index pair is not consistent and an inconsistentName error must be returned on SET or CREATE requests. |
4
inetCidrRoutePolicy | OBJECTID | NoAccess |
This object is an opaque object without any defined semantics. Its purpose is to serve as an additional index that may delineate between multiple entries to the same destination. The value { 0 0 } shall be used as the default value for this object. |
5
inetCidrRouteNextHopType |
INTEGER
InetAddressType (ENUM list below) | NoAccess |
Note: this object is based on the InetAddressType TEXTUAL-CONVENTION. The type of the inetCidrRouteNextHop address, as defined in the InetAddress MIB. Value should be set to unknown(0) for non-remote routes. Only those address types that may appear in an actual routing table are allowed as values of this object. Also see Reference:
|
6
inetCidrRouteNextHop |
OCTETSTR
Legal Lengths: 0 .. 255 InetAddress | NoAccess |
Note: this object is based on the InetAddress TEXTUAL-CONVENTION. On remote routes, the address of the next system en route. For non-remote routes, a zero length string. The type of this address is determined by the value of the inetCidrRouteNextHopType object. |
Name | Type | Access | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
7
inetCidrRouteIfIndex |
INTEGER32
Legal values: 0 .. 2147483647 InterfaceIndexOrZero | Create |
Note: this object is based on the InterfaceIndexOrZero TEXTUAL-CONVENTION. The ifIndex value that identifies the local interface through which the next hop of this route should be reached. A value of 0 is valid and represents the scenario where no interface is specified. |
||||||||||||
8
inetCidrRouteType |
INTEGER
| Create |
The type of route. Note that local(3) refers to a route for which the next hop is the final destination; remote(4) refers to a route for which the next hop is not the final destination. Routes that do not result in traffic forwarding or rejection should not be displayed, even if the implementation keeps them stored internally. reject(2) refers to a route that, if matched, discards the message as unreachable and returns a notification (e.g., ICMP error) to the message sender. This is used in some protocols as a means of correctly aggregating routes. blackhole(5) refers to a route that, if matched, discards the message silently. |
||||||||||||
9
inetCidrRouteProto |
INTEGER
IANAipRouteProtocol (ENUM list below) | ReadOnly |
Note: this object is based on the IANAipRouteProtocol TEXTUAL-CONVENTION. The routing mechanism via which this route was learned. Inclusion of values for gateway routing protocols is not intended to imply that hosts should support those protocols. |
||||||||||||
10
inetCidrRouteAge | GAUGE | ReadOnly |
The number of seconds since this route was last updated or otherwise determined to be correct. Note that no semantics of 'too old' can be implied, except through knowledge of the routing protocol by which the route was learned. |
||||||||||||
11
inetCidrRouteNextHopAS |
UNSIGNED32
InetAutonomousSystemNumber | Create |
Note: this object is based on the InetAutonomousSystemNumber TEXTUAL-CONVENTION. The Autonomous System Number of the Next Hop. The semantics of this object are determined by the routing- protocol specified in the route's inetCidrRouteProto value. When this object is unknown or not relevant, its value should be set to zero. |
||||||||||||
12
inetCidrRouteMetric1 | INTEGER32 | Create |
The primary routing metric for this route. The semantics of this metric are determined by the routing- protocol specified in the route's inetCidrRouteProto value. If this metric is not used, its value should be set to -1. |
||||||||||||
13
inetCidrRouteMetric2 | INTEGER32 | Create |
An alternate routing metric for this route. The semantics of this metric are determined by the routing- protocol specified in the route's inetCidrRouteProto value. If this metric is not used, its value should be set to -1. |
||||||||||||
14
inetCidrRouteMetric3 | INTEGER32 | Create |
An alternate routing metric for this route. The semantics of this metric are determined by the routing- protocol specified in the route's inetCidrRouteProto value. If this metric is not used, its value should be set to -1. |
||||||||||||
15
inetCidrRouteMetric4 | INTEGER32 | Create |
An alternate routing metric for this route. The semantics of this metric are determined by the routing- protocol specified in the route's inetCidrRouteProto value. If this metric is not used, its value should be set to -1. |
||||||||||||
16
inetCidrRouteMetric5 | INTEGER32 | Create |
An alternate routing metric for this route. The semantics of this metric are determined by the routing- protocol specified in the route's inetCidrRouteProto value. If this metric is not used, its value should be set to -1. |
||||||||||||
17
inetCidrRouteStatus |
INTEGER
RowStatus (ENUM list below) | Create |
Note: this object is based on the RowStatus TEXTUAL-CONVENTION. The row status variable, used according to row installation and removal conventions. A row entry cannot be modified when the status is marked as active(1). |
SCALAR OBJECTSTABLE OBJECTSTable ipForwardTableipForwardTable Indexes:Other ipForwardTable Columns:
Table ipCidrRouteTable
ipCidrRouteTable Indexes:
Other ipCidrRouteTable Columns:
|
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 | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
InetAddressPrefixLength | UNSIGNED32 | Denotes the length of a generic Internet network address prefix. A value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB), with all other bits set to 0. An InetAddressPrefixLength value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddressPrefixLength 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 InetAddressPrefixLength textual convention, if they appear in the same logical row. InetAddressPrefixLength values larger than the maximum length of an IP address for a specific InetAddressType are treated as the maximum significant value applicable for the InetAddressType. The maximum significant value is 32 for the InetAddressType 'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType 'ipv6(2)' and 'ipv6z(4)'. The maximum significant value for the InetAddressType 'dns(16)' is 0. The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where the Internet network address prefix is unknown or does not apply. The upper bound of the prefix length has been chosen to be consistent with the maximum size of an InetAddress. | ||||||||||||||||||||||||||||||||||||||||
IANAipRouteProtocol | INTEGER
| A mechanism for learning routes. Inclusion of values for routing protocols is not intended to imply that those protocols need be supported. | ||||||||||||||||||||||||||||||||||||||||
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
| 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
| 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 | ||||||||||||||||||||||||||||||||||||||||
InetAutonomousSystemNumber | UNSIGNED32 | Represents an autonomous system number that identifies an Autonomous System (AS). An AS is a set of routers under a single technical administration, using an interior gateway protocol and common metrics to route packets within the AS, and using an exterior gateway protocol to route packets to other ASes'. IANA maintains the AS number space and has delegated large parts to the regional registries. Autonomous system numbers are currently limited to 16 bits (0..65535). There is, however, work in progress to enlarge the autonomous system number space to 32 bits. Therefore, this textual convention uses an Unsigned32 value without a range restriction in order to support a larger autonomous system number space. | ||||||||||||||||||||||||||||||||||||||||
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 generated by running: snmptranslate -Tp IP-FORWARD-MIB::ipForward
+--ipForward(24) +-- -R-- Gauge ipForwardNumber(1) | +--ipForwardTable(2) | | | +--ipForwardEntry(1) | | Index: ipForwardDest, ipForwardProto, ipForwardPolicy, ipForwardNextHop | | | +-- -R-- IpAddr ipForwardDest(1) | +-- CR-- IpAddr ipForwardMask(2) | +-- -R-- Integer32 ipForwardPolicy(3) | | Range: 0..2147483647 | +-- -R-- IpAddr ipForwardNextHop(4) | +-- CR-- Integer32 ipForwardIfIndex(5) | +-- CR-- EnumVal ipForwardType(6) | | Values: other(1), invalid(2), local(3), remote(4) | +-- -R-- EnumVal ipForwardProto(7) | | Values: other(1), local(2), netmgmt(3), icmp(4), egp(5), ggp(6), hello(7), rip(8), is-is(9), es-is(10), ciscoIgrp(11), bbnSpfIgp(12), ospf(13), bgp(14), idpr(15) | +-- -R-- Integer32 ipForwardAge(8) | +-- CR-- ObjID ipForwardInfo(9) | +-- CR-- Integer32 ipForwardNextHopAS(10) | +-- CR-- Integer32 ipForwardMetric1(11) | +-- CR-- Integer32 ipForwardMetric2(12) | +-- CR-- Integer32 ipForwardMetric3(13) | +-- CR-- Integer32 ipForwardMetric4(14) | +-- CR-- Integer32 ipForwardMetric5(15) | +-- -R-- Gauge ipCidrRouteNumber(3) | +--ipCidrRouteTable(4) | | | +--ipCidrRouteEntry(1) | | Index: ipCidrRouteDest, ipCidrRouteMask, ipCidrRouteTos, ipCidrRouteNextHop | | | +-- -R-- IpAddr ipCidrRouteDest(1) | +-- -R-- IpAddr ipCidrRouteMask(2) | +-- -R-- Integer32 ipCidrRouteTos(3) | | Range: 0..2147483647 | +-- -R-- IpAddr ipCidrRouteNextHop(4) | +-- CR-- Integer32 ipCidrRouteIfIndex(5) | +-- CR-- EnumVal ipCidrRouteType(6) | | Values: other(1), reject(2), local(3), remote(4) | +-- -R-- EnumVal ipCidrRouteProto(7) | | Values: other(1), local(2), netmgmt(3), icmp(4), egp(5), ggp(6), hello(7), rip(8), isIs(9), esIs(10), ciscoIgrp(11), bbnSpfIgp(12), ospf(13), bgp(14), idpr(15), ciscoEigrp(16) | +-- -R-- Integer32 ipCidrRouteAge(8) | +-- CR-- ObjID ipCidrRouteInfo(9) | +-- CR-- Integer32 ipCidrRouteNextHopAS(10) | +-- CR-- Integer32 ipCidrRouteMetric1(11) | +-- CR-- Integer32 ipCidrRouteMetric2(12) | +-- CR-- Integer32 ipCidrRouteMetric3(13) | +-- CR-- Integer32 ipCidrRouteMetric4(14) | +-- CR-- Integer32 ipCidrRouteMetric5(15) | +-- CR-- EnumVal ipCidrRouteStatus(16) | Textual Convention: RowStatus | Values: active(1), notInService(2), notReady(3), createAndGo(4), createAndWait(5), destroy(6) | +--ipForwardConformance(5) | | | +--ipForwardGroups(1) | | | | | +--ipForwardMultiPathGroup(2) | | +--ipForwardCidrRouteGroup(3) | | +--inetForwardCidrRouteGroup(4) | | | +--ipForwardCompliances(2) | | | +--ipForwardCompliance(1) | +--ipForwardOldCompliance(2) | +--ipForwardFullCompliance(3) | +--ipForwardReadOnlyCompliance(4) | +-- -R-- Gauge inetCidrRouteNumber(6) | +--inetCidrRouteTable(7) | | | +--inetCidrRouteEntry(1) | | Index: inetCidrRouteDestType, inetCidrRouteDest, inetCidrRoutePfxLen, inetCidrRoutePolicy, inetCidrRouteNextHopType, inetCidrRouteNextHop | | | +-- ---- EnumVal inetCidrRouteDestType(1) | | Textual Convention: InetAddressType | | Values: unknown(0), ipv4(1), ipv6(2), ipv4z(3), ipv6z(4), dns(16) | +-- ---- String inetCidrRouteDest(2) | | Textual Convention: InetAddress | | Size: 0..255 | +-- ---- Unsigned inetCidrRoutePfxLen(3) | | Textual Convention: InetAddressPrefixLength | | Range: 0..2040 | +-- ---- ObjID inetCidrRoutePolicy(4) | +-- ---- EnumVal inetCidrRouteNextHopType(5) | | Textual Convention: InetAddressType | | Values: unknown(0), ipv4(1), ipv6(2), ipv4z(3), ipv6z(4), dns(16) | +-- ---- String inetCidrRouteNextHop(6) | | Textual Convention: InetAddress | | Size: 0..255 | +-- CR-- Integer32 inetCidrRouteIfIndex(7) | | Textual Convention: InterfaceIndexOrZero | | Range: 0..2147483647 | +-- CR-- EnumVal inetCidrRouteType(8) | | Values: other(1), reject(2), local(3), remote(4), blackhole(5) | +-- -R-- EnumVal inetCidrRouteProto(9) | | Textual Convention: IANAipRouteProtocol | | Values: other(1), local(2), netmgmt(3), icmp(4), egp(5), ggp(6), hello(7), rip(8), isIs(9), esIs(10), ciscoIgrp(11), bbnSpfIgp(12), ospf(13), bgp(14), idpr(15), ciscoEigrp(16), dvmrp(17), rpl(18), dhcp(19) | +-- -R-- Gauge inetCidrRouteAge(10) | +-- CR-- Unsigned inetCidrRouteNextHopAS(11) | | Textual Convention: InetAutonomousSystemNumber | +-- CR-- Integer32 inetCidrRouteMetric1(12) | +-- CR-- Integer32 inetCidrRouteMetric2(13) | +-- CR-- Integer32 inetCidrRouteMetric3(14) | +-- CR-- Integer32 inetCidrRouteMetric4(15) | +-- CR-- Integer32 inetCidrRouteMetric5(16) | +-- CR-- EnumVal inetCidrRouteStatus(17) | Textual Convention: RowStatus | Values: active(1), notInService(2), notReady(3), createAndGo(4), createAndWait(5), destroy(6) | +-- -R-- Counter inetCidrRouteDiscards(8)
Last modified: Wednesday, 01-Aug-2018 04:41:28 UTC
For questions regarding web content and site functionality, please write to the net-snmp-users mail list.