This is a summary of information regarding objects below the agentxMIB MIB object, which is defined within the AGENTX-MIB MIB document as .1.3.6.1.2.1.74.
Name | Type | Access | OID | Description |
---|---|---|---|---|
1
agentxDefaultTimeout |
INTEGER
Legal values: 0 .. 255 | ReadOnly | .1.3.6.1.2.1.74.1.1.1 |
The default length of time, in seconds, that the master agent should allow to elapse after dispatching a message to a session before it regards the subagent as not responding. This is a system-wide value that may override the timeout value associated with a particular session (agentxSessionTimeout) or a particular registered MIB region (agentxRegTimeout). If the associated value of agentxSessionTimeout and agentxRegTimeout are zero, or impractical in accordance with implementation-specific procedure of the master agent, the value represented by this object will be the effective timeout value for the master agent to await a response to a dispatch from a given subagent. |
2
agentxMasterAgentXVer |
INTEGER
Legal values: 1 .. 255 | ReadOnly | .1.3.6.1.2.1.74.1.1.2 |
The AgentX protocol version supported by this master agent. The current protocol version is 1. Note that the master agent must also allow interaction with earlier version subagents. |
1
agentxConnTableLastChange |
TICKS
TimeStamp | ReadOnly | .1.3.6.1.2.1.74.1.2.1 |
Note: this object is based on the TimeStamp TEXTUAL-CONVENTION. The value of sysUpTime when the last row creation or deletion occurred in the agentxConnectionTable. |
1
agentxSessionTableLastChange |
TICKS
TimeStamp | ReadOnly | .1.3.6.1.2.1.74.1.3.1 |
Note: this object is based on the TimeStamp TEXTUAL-CONVENTION. The value of sysUpTime when the last row creation or deletion occurred in the agentxSessionTable. |
1
agentxRegistrationTableLastChange |
TICKS
TimeStamp | ReadOnly | .1.3.6.1.2.1.74.1.4.1 |
Note: this object is based on the TimeStamp TEXTUAL-CONVENTION. The value of sysUpTime when the last row creation or deletion occurred in the agentxRegistrationTable. |
Table Name | agentxConnectionTable |
In MIB | AGENTX-MIB |
Registered at OID | .1.3.6.1.2.1.74.1.2.2 |
Table Description |
The agentxConnectionTable tracks all current AgentX transport connections. There may be zero, one, or more AgentX sessions carried on a given AgentX connection. |
Row Description |
An agentxConnectionEntry contains information describing a single AgentX transport connection. A connection may be used to support zero or more AgentX sessions. An entry is created when a new transport connection is established, and is destroyed when the transport connection is terminated. |
Name | Type | Access | Description |
---|---|---|---|
1
agentxConnIndex |
UNSIGNED32
Legal values: 1 .. -1 | NoAccess |
agentxConnIndex contains the value that uniquely identifies an open transport connection used by this master agent to provide AgentX service. Values of this index should not be re-used. The value assigned to a given transport connection is constant for the lifetime of that connection. |
Name | Type | Access | Description |
---|---|---|---|
2
agentxConnOpenTime |
TICKS
TimeStamp | ReadOnly |
Note: this object is based on the TimeStamp TEXTUAL-CONVENTION. The value of sysUpTime when this connection was established and, therefore, its value when this entry was added to the table. |
3
agentxConnTransportDomain |
OBJECTID
TDomain | ReadOnly |
Note: this object is based on the TDomain TEXTUAL-CONVENTION. The transport protocol in use for this connection to the subagent. |
4
agentxConnTransportAddress |
OCTETSTR
Legal Lengths: 0 .. 255 AgentxTAddress | ReadOnly |
Note: this object is based on the AgentxTAddress TEXTUAL-CONVENTION. The transport address of the remote (subagent) end of this connection to the master agent. This object may be zero-length for unix-domain sockets (and possibly other types of transport addresses) since the subagent need not bind a filename to its local socket. |
Table Name | agentxSessionTable |
In MIB | AGENTX-MIB |
Registered at OID | .1.3.6.1.2.1.74.1.3.2 |
Table Description |
A table of AgentX subagent sessions currently in effect. |
Row Description |
Information about a single open session between the AgentX master agent and a subagent is contained in this entry. An entry is created when a new session is successfully established and is destroyed either when the subagent transport connection has terminated or when the subagent session is closed. |
Name | Type | Access | Description |
---|---|---|---|
1
agentxConnIndex |
UNSIGNED32
Legal values: 1 .. -1 | NoAccess |
agentxConnIndex contains the value that uniquely identifies an open transport connection used by this master agent to provide AgentX service. Values of this index should not be re-used. The value assigned to a given transport connection is constant for the lifetime of that connection. |
1
agentxSessionIndex |
UNSIGNED32
Legal values: 0 .. -1 | NoAccess |
A unique index for the subagent session. It is the same as h.sessionID defined in the agentx header. Note that if a subagent's session with the master agent is closed for any reason its index should not be re-used. A value of zero(0) is specifically allowed in order to be compatible with the definition of h.sessionId. |
Name | Type | Access | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
2
agentxSessionObjectID | OBJECTID | ReadOnly |
This is taken from the o.id field of the agentx-Open-PDU. This attribute will report a value of '0.0' for subagents not supporting the notion of an AgentX session object identifier. |
||||||
3
agentxSessionDescr |
OCTETSTR
Legal Lengths: 0 .. 255 SnmpAdminString | ReadOnly |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. A textual description of the session. This is analogous to sysDescr defined in the SNMPv2-MIB in RFC 1907 [19] and is taken from the o.descr field of the agentx-Open-PDU. This attribute will report a zero-length string value for subagents not supporting the notion of a session description. |
||||||
4
agentxSessionAdminStatus |
INTEGER
| ReadWrite |
The administrative (desired) status of the session. Setting the value to 'down(2)' closes the subagent session (with c.reason set to 'reasonByManager'). |
||||||
5
agentxSessionOpenTime |
TICKS
TimeStamp | ReadOnly |
Note: this object is based on the TimeStamp TEXTUAL-CONVENTION. The value of sysUpTime when this session was opened and, therefore, its value when this entry was added to the table. |
||||||
6
agentxSessionAgentXVer |
INTEGER
Legal values: 1 .. 255 | ReadOnly |
The version of the AgentX protocol supported by the session. This must be less than or equal to the value of agentxMasterAgentXVer. |
||||||
7
agentxSessionTimeout |
INTEGER
Legal values: 0 .. 255 | ReadOnly |
The length of time, in seconds, that a master agent should allow to elapse after dispatching a message to this session before it regards the subagent as not responding. This value is taken from the o.timeout field of the agentx-Open-PDU. This is a session-specific value that may be overridden by values associated with the specific registered MIB regions (see agentxRegTimeout). A value of zero(0) indicates that the master agent's default timeout value should be used (see agentxDefaultTimeout). |
Table Name | agentxRegistrationTable |
In MIB | AGENTX-MIB |
Registered at OID | .1.3.6.1.2.1.74.1.4.2 |
Table Description |
A table of registered regions. |
Row Description |
Contains information for a single registered region. An entry is created when a session successfully registers a region and is destroyed for any of three reasons: this region is unregistered by the session, the session is closed, or the subagent connection is closed. |
Name | Type | Access | Description |
---|---|---|---|
1
agentxConnIndex |
UNSIGNED32
Legal values: 1 .. -1 | NoAccess |
agentxConnIndex contains the value that uniquely identifies an open transport connection used by this master agent to provide AgentX service. Values of this index should not be re-used. The value assigned to a given transport connection is constant for the lifetime of that connection. |
1
agentxSessionIndex |
UNSIGNED32
Legal values: 0 .. -1 | NoAccess |
A unique index for the subagent session. It is the same as h.sessionID defined in the agentx header. Note that if a subagent's session with the master agent is closed for any reason its index should not be re-used. A value of zero(0) is specifically allowed in order to be compatible with the definition of h.sessionId. |
1
agentxRegIndex |
UNSIGNED32
Legal values: 1 .. -1 | NoAccess |
agentxRegIndex uniquely identifies a registration entry. This value is constant for the lifetime of an entry. |
Name | Type | Access | Description |
---|---|---|---|
2
agentxRegContext | OCTETSTR | ReadOnly |
The context in which the session supports the objects in this region. A zero-length context indicates the default context. |
3
agentxRegStart | OBJECTID | ReadOnly |
The starting OBJECT IDENTIFIER of this registration entry. The session identified by agentxSessionIndex implements objects starting at this value (inclusive). Note that this value could identify an object type, an object instance, or a partial object instance. |
4
agentxRegRangeSubId | UNSIGNED32 | ReadOnly |
agentxRegRangeSubId is used to specify the range. This is taken from r.region_subid in the registration PDU. If the value of this object is zero, no range is specified. If it is non-zero, it identifies the `nth' sub-identifier in r.region for which this entry's agentxRegUpperBound value is substituted in the OID for purposes of defining the region's upper bound. |
5
agentxRegUpperBound | UNSIGNED32 | ReadOnly |
agentxRegUpperBound represents the upper-bound sub-identifier in a registration. This is taken from the r.upper_bound in the registration PDU. If agentxRegRangeSubid (r.region_subid) is zero, this value is also zero and is not used to define an upper bound for this registration. |
6
agentxRegPriority | UNSIGNED32 | ReadOnly |
The registration priority. Lower values have higher priority. This value is taken from r.priority in the register PDU. Sessions should use the value of 127 for r.priority if a default value is desired. |
7
agentxRegTimeout |
INTEGER
Legal values: 0 .. 255 | ReadOnly |
The timeout value, in seconds, for responses to requests associated with this registered MIB region. A value of zero(0) indicates the default value (indicated by by agentxSessionTimeout or agentxDefaultTimeout) is to be used. This value is taken from the r.timeout field of the agentx-Register-PDU. |
8
agentxRegInstance |
INTEGER
TruthValue (ENUM list below) | ReadOnly |
Note: this object is based on the TruthValue TEXTUAL-CONVENTION. The value of agentxRegInstance is `true' for registrations for which the INSTANCE_REGISTRATION was set, and is `false' for all other registrations. |
SCALAR OBJECTS
TABLE OBJECTS |
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 | ||||||
---|---|---|---|---|---|---|---|---|
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. | ||||||
TruthValue | INTEGER
| Represents a boolean value. | ||||||
TDomain | OBJECTID | Denotes a kind of transport service. Some possible values, such as snmpUDPDomain, are defined in the SNMPv2-TM MIB module. Other possible values are defined in other MIB modules. | ||||||
AgentxTAddress | OCTETSTR | Denotes a transport service address. This is identical to the TAddress textual convention (SNMPv2-SMI) except that zero-length values are permitted. | ||||||
SnmpAdminString | OCTETSTR | An octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. |
Tree view generated by running: snmptranslate -Tp AGENTX-MIB::agentxMIB
+--agentxMIB(74) | +--agentxObjects(1) | | | +--agentxGeneral(1) | | | | | +-- -R-- INTEGER agentxDefaultTimeout(1) | | | Range: 0..255 | | +-- -R-- INTEGER agentxMasterAgentXVer(2) | | Range: 1..255 | | | +--agentxConnection(2) | | | | | +-- -R-- TimeTicks agentxConnTableLastChange(1) | | | Textual Convention: TimeStamp | | | | | +--agentxConnectionTable(2) | | | | | +--agentxConnectionEntry(1) | | | Index: agentxConnIndex | | | | | +-- ---- Unsigned agentxConnIndex(1) | | | Range: 1..4294967295 | | +-- -R-- TimeTicks agentxConnOpenTime(2) | | | Textual Convention: TimeStamp | | +-- -R-- ObjID agentxConnTransportDomain(3) | | | Textual Convention: TDomain | | +-- -R-- String agentxConnTransportAddress(4) | | Textual Convention: AgentxTAddress | | Size: 0..255 | | | +--agentxSession(3) | | | | | +-- -R-- TimeTicks agentxSessionTableLastChange(1) | | | Textual Convention: TimeStamp | | | | | +--agentxSessionTable(2) | | | | | +--agentxSessionEntry(1) | | | Index: agentxConnIndex, agentxSessionIndex | | | | | +-- ---- Unsigned agentxSessionIndex(1) | | | Range: 0..4294967295 | | +-- -R-- ObjID agentxSessionObjectID(2) | | +-- -R-- String agentxSessionDescr(3) | | | Textual Convention: SnmpAdminString | | | Size: 0..255 | | +-- -RW- EnumVal agentxSessionAdminStatus(4) | | | Values: up(1), down(2) | | +-- -R-- TimeTicks agentxSessionOpenTime(5) | | | Textual Convention: TimeStamp | | +-- -R-- INTEGER agentxSessionAgentXVer(6) | | | Range: 1..255 | | +-- -R-- INTEGER agentxSessionTimeout(7) | | Range: 0..255 | | | +--agentxRegistration(4) | | | +-- -R-- TimeTicks agentxRegistrationTableLastChange(1) | | Textual Convention: TimeStamp | | | +--agentxRegistrationTable(2) | | | +--agentxRegistrationEntry(1) | | Index: agentxConnIndex, agentxSessionIndex, agentxRegIndex | | | +-- ---- Unsigned agentxRegIndex(1) | | Range: 1..4294967295 | +-- -R-- String agentxRegContext(2) | +-- -R-- ObjID agentxRegStart(3) | +-- -R-- Unsigned agentxRegRangeSubId(4) | +-- -R-- Unsigned agentxRegUpperBound(5) | +-- -R-- Unsigned agentxRegPriority(6) | +-- -R-- INTEGER agentxRegTimeout(7) | | Range: 0..255 | +-- -R-- EnumVal agentxRegInstance(8) | Textual Convention: TruthValue | Values: true(1), false(2) | +--agentxConformance(2) | +--agentxMIBGroups(1) | | | +--agentxMIBGroup(1) | +--agentxMIBCompliances(2) | +--agentxMIBCompliance(1)
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.