This is a summary of information regarding objects below the ifMIBObjects MIB object, which is defined within the IF-MIB MIB document as .1.3.6.1.2.1.31.1.
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. |
Name | Type | Access | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
1
ifName |
OCTETSTR
Legal Lengths: 0 .. 255 DisplayString | ReadOnly |
Note: this object is based on the DisplayString TEXTUAL-CONVENTION. The textual name of the interface. The value of this object should be the name of the interface as assigned by the local device and should be suitable for use in commands entered at the device's `console'. This might be a text name, such as `le0' or a simple port number, such as `1', depending on the interface naming syntax of the device. If several entries in the ifTable together represent a single interface as named by the device, then each will have the same value of ifName. Note that for an agent which responds to SNMP queries concerning an interface on some other (proxied) device, then the value of ifName for such an interface is the proxied device's local name for it. If there is no local name, or this object is otherwise not applicable, then this object contains a zero-length string. |
||||||
2
ifInMulticastPkts | COUNTER | ReadOnly |
The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a multicast address at this sub-layer. For a MAC layer protocol, this includes both Group and Functional addresses. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
3
ifInBroadcastPkts | COUNTER | ReadOnly |
The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a broadcast address at this sub-layer. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
4
ifOutMulticastPkts | COUNTER | ReadOnly |
The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast address at this sub-layer, including those that were discarded or not sent. For a MAC layer protocol, this includes both Group and Functional addresses. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
5
ifOutBroadcastPkts | COUNTER | ReadOnly |
The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
6
ifHCInOctets | COUNTER64 | ReadOnly |
The total number of octets received on the interface, including framing characters. This object is a 64-bit version of ifInOctets. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
7
ifHCInUcastPkts | COUNTER64 | ReadOnly |
The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were not addressed to a multicast or broadcast address at this sub-layer. This object is a 64-bit version of ifInUcastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
8
ifHCInMulticastPkts | COUNTER64 | ReadOnly |
The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a multicast address at this sub-layer. For a MAC layer protocol, this includes both Group and Functional addresses. This object is a 64-bit version of ifInMulticastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
9
ifHCInBroadcastPkts | COUNTER64 | ReadOnly |
The number of packets, delivered by this sub-layer to a higher (sub-)layer, which were addressed to a broadcast address at this sub-layer. This object is a 64-bit version of ifInBroadcastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
10
ifHCOutOctets | COUNTER64 | ReadOnly |
The total number of octets transmitted out of the interface, including framing characters. This object is a 64-bit version of ifOutOctets. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
11
ifHCOutUcastPkts | COUNTER64 | ReadOnly |
The total number of packets that higher-level protocols requested be transmitted, and which were not addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent. This object is a 64-bit version of ifOutUcastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
12
ifHCOutMulticastPkts | COUNTER64 | ReadOnly |
The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a multicast address at this sub-layer, including those that were discarded or not sent. For a MAC layer protocol, this includes both Group and Functional addresses. This object is a 64-bit version of ifOutMulticastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
13
ifHCOutBroadcastPkts | COUNTER64 | ReadOnly |
The total number of packets that higher-level protocols requested be transmitted, and which were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent. This object is a 64-bit version of ifOutBroadcastPkts. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
||||||
14
ifLinkUpDownTrapEnable |
INTEGER
| ReadWrite |
Indicates whether linkUp/linkDown traps should be generated for this interface. By default, this object should have the value enabled(1) for interfaces which do not operate on 'top' of any other interface (as defined in the ifStackTable), and disabled(2) otherwise. |
||||||
15
ifHighSpeed | GAUGE | ReadOnly |
An estimate of the interface's current bandwidth in units of 1,000,000 bits per second. If this object reports a value of `n' then the speed of the interface is somewhere in the range of `n-500,000' to `n+499,999'. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. For a sub-layer which has no concept of bandwidth, this object should be zero. |
||||||
16
ifPromiscuousMode |
INTEGER
TruthValue (ENUM list below) | ReadWrite |
Note: this object is based on the TruthValue TEXTUAL-CONVENTION. This object has a value of false(2) if this interface only accepts packets/frames that are addressed to this station. This object has a value of true(1) when the station accepts all packets/frames transmitted on the media. The value true(1) is only legal on certain types of media. If legal, setting this object to a value of true(1) may require the interface to be reset before becoming effective. The value of ifPromiscuousMode does not affect the reception of broadcast and multicast packets/frames by the interface. |
||||||
17
ifConnectorPresent |
INTEGER
TruthValue (ENUM list below) | ReadOnly |
Note: this object is based on the TruthValue TEXTUAL-CONVENTION. This object has the value 'true(1)' if the interface sublayer has a physical connector and the value 'false(2)' otherwise. |
||||||
18
ifAlias |
OCTETSTR
Legal Lengths: 0 .. 64 DisplayString | ReadWrite |
Note: this object is based on the DisplayString TEXTUAL-CONVENTION. This object is an 'alias' name for the interface as specified by a network manager, and provides a non-volatile 'handle' for the interface. On the first instantiation of an interface, the value of ifAlias associated with that interface is the zero-length string. As and when a value is written into an instance of ifAlias through a network management set operation, then the agent must retain the supplied value in the ifAlias instance associated with the same interface for as long as that interface remains instantiated, including across all re- initializations/reboots of the network management system, including those which result in a change of the interface's ifIndex value. An example of the value which a network manager might store in this object for a WAN interface is the (Telco's) circuit number/identifier of the interface. Some agents may support write-access only for interfaces having particular values of ifType. An agent which supports write access to this object is required to keep the value in non-volatile storage, but it may limit the length of new values depending on how much storage is already occupied by the current values for other interfaces. |
||||||
19
ifCounterDiscontinuityTime |
TICKS
TimeStamp | ReadOnly |
Note: this object is based on the TimeStamp TEXTUAL-CONVENTION. The value of sysUpTime on the most recent occasion at which any one or more of this interface's counters suffered a discontinuity. The relevant counters are the specific instances associated with this interface of any Counter32 or Counter64 object contained in the ifTable or ifXTable. If no such discontinuities have occurred since the last re- initialization of the local management subsystem, then this object contains a zero value. |
Name | Type | Access | Description |
---|---|---|---|
1
ifStackHigherLayer |
INTEGER32
Legal values: 0 .. 2147483647 InterfaceIndexOrZero | NoAccess |
Note: this object is based on the InterfaceIndexOrZero TEXTUAL-CONVENTION. The value of ifIndex corresponding to the higher sub-layer of the relationship, i.e., the sub-layer which runs on 'top' of the sub-layer identified by the corresponding instance of ifStackLowerLayer. If there is no higher sub-layer (below the internetwork layer), then this object has the value 0. |
2
ifStackLowerLayer |
INTEGER32
Legal values: 0 .. 2147483647 InterfaceIndexOrZero | NoAccess |
Note: this object is based on the InterfaceIndexOrZero TEXTUAL-CONVENTION. The value of ifIndex corresponding to the lower sub-layer of the relationship, i.e., the sub-layer which runs 'below' the sub-layer identified by the corresponding instance of ifStackHigherLayer. If there is no lower sub-layer, then this object has the value 0. |
Name | Type | Access | Description |
---|---|---|---|
3
ifStackStatus |
INTEGER
RowStatus (ENUM list below) | Create |
Note: this object is based on the RowStatus TEXTUAL-CONVENTION. The status of the relationship between two sub-layers. Changing the value of this object from 'active' to 'notInService' or 'destroy' will likely have consequences up and down the interface stack. Thus, write access to this object is likely to be inappropriate for some types of interfaces, and many implementations will choose not to support write-access for any type of interface. |
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. |
1
ifRcvAddressAddress |
OCTETSTR
PhysAddress | NoAccess |
Note: this object is based on the PhysAddress TEXTUAL-CONVENTION. An address for which the system will accept packets/frames on this entry's interface. |
Name | Type | Access | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
2
ifRcvAddressStatus |
INTEGER
RowStatus (ENUM list below) | Create |
Note: this object is based on the RowStatus TEXTUAL-CONVENTION. This object is used to create and delete rows in the ifRcvAddressTable. |
||||||||
3
ifRcvAddressType |
INTEGER
| Create |
This object has the value nonVolatile(3) for those entries in the table which are valid and will not be deleted by the next restart of the managed system. Entries having the value volatile(2) are valid and exist, but have not been saved, so that will not exist after the next restart of the managed system. Entries having the value other(1) are valid and exist but are not classified as to whether they will continue to exist after the next restart. |
SCALAR OBJECTS
TABLE OBJECTSTable ifTestTableifTestTable Indexes:
Other ifTestTable 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 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TestAndIncr | INTEGER | Represents integer-valued information used for atomic operations. When the management protocol is used to specify that an object instance having this syntax is to be modified, the new value supplied via the management protocol must precisely match the value presently held by the instance. If not, the management protocol set operation fails with an error of `inconsistentValue'. Otherwise, if the current value is the maximum value of 2^31-1 (2147483647 decimal), then the value held by the instance is wrapped to zero; otherwise, the value held by the instance is incremented by one. (Note that regardless of whether the management protocol set operation succeeds, the variable- binding in the request and response PDUs are identical.) The value of the ACCESS clause for objects having this syntax is either `read-write' or `read-create'. When an instance of a columnar object having this syntax is created, any value may be supplied via the management protocol. When the network management portion of the system is re- initialized, the value of every object instance having this syntax must either be incremented from its value prior to the re-initialization, or (if the value prior to the re- initialization is unknown) be set to a pseudo-randomly generated value. | ||||||||||||||
TimeStamp | TICKS | The value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. | ||||||||||||||
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. | ||||||||||||||
AutonomousType | OBJECTID | Represents an independently extensible type identification value. It may, for example, indicate a particular sub-tree with further MIB definitions, or define a particular type of protocol or hardware. | ||||||||||||||
DisplayString | OCTETSTR | Represents textual information taken from the NVT ASCII character set, as defined in pages 4, 10-11 of RFC 854. To summarize RFC 854, the NVT ASCII repertoire specifies: - the use of character codes 0-127 (decimal) - the graphics characters (32-126) are interpreted as US ASCII - NUL, LF, CR, BEL, BS, HT, VT and FF have the special meanings specified in RFC 854 - the other 25 codes have no standard interpretation - the sequence 'CR LF' means newline - the sequence 'CR NUL' means carriage-return - an 'LF' not preceded by a 'CR' means moving to the same column on the next line. - the sequence 'CR x' for any x other than LF or NUL is illegal. (Note that this also means that a string may end with either 'CR LF' or 'CR NUL', but not with CR.) Any object defined using this syntax may not exceed 255 characters in length. | ||||||||||||||
PhysAddress | OCTETSTR | Represents media- or physical-level addresses. | ||||||||||||||
OwnerString | OCTETSTR | This data type is used to model an administratively assigned name of the owner of a resource. This information is taken from the NVT ASCII character set. It is suggested that this name contain one or more of the following: ASCII form of the manager station's transport address, management station name (e.g., domain name), network management personnel's name, location, or phone number. In some cases the agent itself will be the owner of an entry. In these cases, this string shall be set to a string starting with 'agent'. | ||||||||||||||
TruthValue | INTEGER
| Represents a boolean value. | ||||||||||||||
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 | ||||||||||||||
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 IF-MIB::ifMIBObjects
+--ifMIBObjects(1) | +--ifXTable(1) | | | +--ifXEntry(1) | | | +-- -R-- String ifName(1) | | Textual Convention: DisplayString | | Size: 0..255 | +-- -R-- Counter ifInMulticastPkts(2) | +-- -R-- Counter ifInBroadcastPkts(3) | +-- -R-- Counter ifOutMulticastPkts(4) | +-- -R-- Counter ifOutBroadcastPkts(5) | +-- -R-- Counter64 ifHCInOctets(6) | +-- -R-- Counter64 ifHCInUcastPkts(7) | +-- -R-- Counter64 ifHCInMulticastPkts(8) | +-- -R-- Counter64 ifHCInBroadcastPkts(9) | +-- -R-- Counter64 ifHCOutOctets(10) | +-- -R-- Counter64 ifHCOutUcastPkts(11) | +-- -R-- Counter64 ifHCOutMulticastPkts(12) | +-- -R-- Counter64 ifHCOutBroadcastPkts(13) | +-- -RW- EnumVal ifLinkUpDownTrapEnable(14) | | Values: enabled(1), disabled(2) | +-- -R-- Gauge ifHighSpeed(15) | +-- -RW- EnumVal ifPromiscuousMode(16) | | Textual Convention: TruthValue | | Values: true(1), false(2) | +-- -R-- EnumVal ifConnectorPresent(17) | | Textual Convention: TruthValue | | Values: true(1), false(2) | +-- -RW- String ifAlias(18) | | Textual Convention: DisplayString | | Size: 0..64 | +-- -R-- TimeTicks ifCounterDiscontinuityTime(19) | Textual Convention: TimeStamp | +--ifStackTable(2) | | | +--ifStackEntry(1) | | Index: ifStackHigherLayer, ifStackLowerLayer | | | +-- ---- Integer32 ifStackHigherLayer(1) | | Textual Convention: InterfaceIndexOrZero | | Range: 0..2147483647 | +-- ---- Integer32 ifStackLowerLayer(2) | | Textual Convention: InterfaceIndexOrZero | | Range: 0..2147483647 | +-- CR-- EnumVal ifStackStatus(3) | Textual Convention: RowStatus | Values: active(1), notInService(2), notReady(3), createAndGo(4), createAndWait(5), destroy(6) | +--ifTestTable(3) | | | +--ifTestEntry(1) | | | +-- -RW- INTEGER ifTestId(1) | | Textual Convention: TestAndIncr | | Range: 0..2147483647 | +-- -RW- EnumVal ifTestStatus(2) | | Values: notInUse(1), inUse(2) | +-- -RW- ObjID ifTestType(3) | | Textual Convention: AutonomousType | +-- -R-- EnumVal ifTestResult(4) | | Values: none(1), success(2), inProgress(3), notSupported(4), unAbleToRun(5), aborted(6), failed(7) | +-- -R-- ObjID ifTestCode(5) | +-- -RW- String ifTestOwner(6) | Textual Convention: OwnerString | Size: 0..255 | +--ifRcvAddressTable(4) | | | +--ifRcvAddressEntry(1) | | Index: ifIndex, ifRcvAddressAddress | | | +-- ---- String ifRcvAddressAddress(1) | | Textual Convention: PhysAddress | +-- CR-- EnumVal ifRcvAddressStatus(2) | | Textual Convention: RowStatus | | Values: active(1), notInService(2), notReady(3), createAndGo(4), createAndWait(5), destroy(6) | +-- CR-- EnumVal ifRcvAddressType(3) | Values: other(1), volatile(2), nonVolatile(3) | +-- -R-- TimeTicks ifTableLastChange(5) +-- -R-- TimeTicks ifStackLastChange(6)
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.