-- extracted from draft-ietf-agentx-mib-02.txt -- at Mon Nov 15 17:10:47 1999 AGENTX-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, experimental, Counter32, Gauge32, Unsigned32, TDomain, TAddress FROM SNMPv2-SMI MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF TEXTUAL-CONVENTION, TimeStamp, TruthValue FROM SNMPv2-TC; agentxMIB MODULE-IDENTITY LAST-UPDATED "9804141200Z" -- April 14, 1998 ORGANIZATION "IETF AgentX Working Group" CONTACT-INFO "WG-email: agentx@peer.com Subscribe: agentx-request@peer.com http://www.ietf.org/html.charters/agentx-charter.html Chair: Bob Natale ACE*COMM Corporation Email: bnatale@acec.com Editor: Smitha Gudur BMC Software, Inc. 965 Stewart Drive Sunnyvale, CA 94086 Phone: +1 408-616-3100 Email: sgudur@bmc.com " DESCRIPTION "This is the MIB module for the SNMP Agent Extensibility Protocol (AgentX). This MIB module will be implemented by the master agent." -- For testing purposes only. Need to get an experimental id ::= { experimental 2001 } agentxObjects OBJECT IDENTIFIER ::= { agentxMIB 1 } -- -- Define the four groups that serve to organize the -- objects in this MIB -- agentxGeneral OBJECT IDENTIFIER ::= { agentxObjects 1 } agentxConnection OBJECT IDENTIFIER ::= { agentxObjects 2 } agentxSession OBJECT IDENTIFIER ::= { agentxObjects 3 } agentxRegistration OBJECT IDENTIFIER ::= { agentxObjects 4 } agentxTCPDomain OBJECT IDENTIFIER ::= {agentxObjects 5} -- -- Textual Conventions -- Utf8String ::= TEXTUAL-CONVENTION DISPLAY-HINT "255a" STATUS current DESCRIPTION "To facilitate internationalization, this TC represents information taken from the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 character encoding scheme described in RFC 2044 [8]. For strings in 7-bit US-ASCII, there is no impact since the UTF-8 representation is identical to the US-ASCII encoding." SYNTAX OCTET STRING (SIZE (0..255)) AgentxTCPAddress ::= TEXTUAL-CONVENTION DISPLAY-HINT "1d.1d.1d.1d/2d" STATUS current DESCRIPTION "Represents a TCP Address." SYNTAX OCTET STRING (SIZE (6)) agentxDefaultTimeout OBJECT-TYPE SYNTAX INTEGER (0..255) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "The default length of time, in seconds, that the master agent should allow to elapse after dispatching a message to a subagent before it regards the subagent as not responding. This is a system-wide value that may be overridden by the values associated with a particular subagent (agentxSessionTimeout) or a particular registered MIB region (agentxRegTimeout)." DEFVAL { 5 } ::= { agentxGeneral 1 } agentxMasterAgentXVer OBJECT-TYPE SYNTAX INTEGER (1..255) MAX-ACCESS read-only STATUS current DESCRIPTION "The AgentX protocol version supported by this master agent. Current version is 1. Note that the master agent must allow registration of earlier version subagents." DEFVAL { 1 } ::= { agentxGeneral 2 } -- -- The Agentx Subagent Connection Group -- agentxConnTableLastChange OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime when the last row creation or deletion occurred in the agentxConnectionTable." ::= { agentxConnection 1 } agentxConnNumber OBJECT-TYPE SYNTAX Gauge32 MAX-ACCESS read-only STATUS current DESCRIPTION "The current number of entries in the agentxConnectionTable. Note that this may be smaller than the largest value of agentxConnIndex since index values are not reused when entries come and go from the agentxConnectionTable." ::= { agentxConnection 2 } agentxConnectionTable OBJECT-TYPE SYNTAX SEQUENCE OF AgentxConnectionEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The agentxConnectionTable tracks all current Agentx transport connections. There may be zero, one, or more agentx sessions on a given Agentx connection." ::= { agentxConnection 3 } AgentxConnectionEntry ::= SEQUENCE { agentxConnIndex Unsigned32, agentxConnOpenTime TimeStamp, agentxConnTransportDomain TDomain, agentxConnTransportAddress TAddress, agentxConnSessions Gauge32 } agentxConnectionEntry OBJECT-TYPE SYNTAX AgentxConnectionEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An agentxConnectionEntry contains information describing a single Agentx transport connection. A connection may be used to support zero or more Agentx sessions. Entries come into being when the transport connection is established, and are not deleted unless the transport connection has been terminated." INDEX { agentxConnIndex } ::= { agentxConnectionTable 1 } agentxConnIndex OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS not-accessible STATUS current DESCRIPTION "The value of agentxConnIndex uniquely identifies each 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." ::= { agentxConnectionEntry 1 } agentxConnOpenTime OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime when this connection was established and, therefore, its value when this entry was added to the table." ::= { agentxConnectionEntry 2 } agentxConnTransportDomain OBJECT-TYPE SYNTAX TDomain MAX-ACCESS read-only STATUS current DESCRIPTION "The transport protocol in use for this connection to the master agent." ::= { agentxConnectionEntry 3 } agentxConnTransportAddress OBJECT-TYPE SYNTAX TAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The transport address of the remote (subagent) end of this connection to the master agent." ::= { agentxConnectionEntry 4 } agentxConnSessions OBJECT-TYPE SYNTAX Gauge32 MAX-ACCESS read-only STATUS current DESCRIPTION "The current number of AgentX sessions being carried by this transport connection. For purposes of this MIB, an AgentX session begins when a valid agentx-Open-PDU is received, and ends when a corresponding agentx-Close-PDU has been sent or received by the master agent." ::= { agentxConnectionEntry 5 } -- -- The AgentX Subagent Session Group -- agentxSessionTableLastChange OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime when the last row creation or deletion occurred in the agentxSessionTable." ::= { agentxSession 1 } agentxSessionNumber OBJECT-TYPE SYNTAX Gauge32 MAX-ACCESS read-only STATUS current DESCRIPTION "The current number of entries in the agentxSessionTable. Note that this may be smaller than the largest value of agentxSessionIndex since index values are not reused when entries come and go from the agentxSessionTable." ::= { agentxSession 2 } -- -- The AgentX Subagent Session Table -- agentxSessionTable OBJECT-TYPE SYNTAX SEQUENCE OF AgentxSessionEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of AgentX subagents that have open sessions with the AgentX master agent." ::= { agentxSession 3 } agentxSessionEntry OBJECT-TYPE SYNTAX AgentxSessionEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Information about a single open session between the AgentX master agent and a subagent." INDEX { agentxConnIndex, agentxSessionIndex } ::= { agentxSessionTable 1 } AgentxSessionEntry ::= SEQUENCE { agentxSessionIndex Unsigned32, agentxSessionObjectID OBJECT IDENTIFIER, agentxSessionDescr Utf8String, agentxSessionAdminStatus INTEGER, agentxSessionOpenTime TimeStamp, agentxSessionAgentXVer INTEGER, agentxSessionTimeout INTEGER } agentxSessionIndex OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS not-accessible STATUS current DESCRIPTION "A unique index for the subagent session. Note that if a subagent's session with the master agent is closed for any reason its index should not be re-used, therefore, the values of agentxSessionIndex may not be contiguous and will generally not be the same for the same subagent across multiple sessions. Index values assigned for a given registration are constant for the lifetime of this table." ::= { agentxSessionEntry 1 } agentxSessionObjectID OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-only STATUS current DESCRIPTION "This is analogous to sysObjectID defined in MIB-2 [2] and is taken from the o.id field of the agentx-Open-PDU." ::= { agentxSessionEntry 2 } -- -- Issue: should we describe this more in terms of AGENT-CAPABILITIES -- or sysORTable? -- agentxSessionDescr OBJECT-TYPE SYNTAX Utf8String MAX-ACCESS read-only STATUS current DESCRIPTION "A textual description of the subagent. This is analogous to sysDescr defined in MIB-2 [2] and is taken from the o.descr field of the agentx-Open-PDU." ::= { agentxSessionEntry 3 } agentxSessionAdminStatus OBJECT-TYPE SYNTAX INTEGER { up(1), down(2) } MAX-ACCESS read-write STATUS current DESCRIPTION "The administrative (desired) status of the subagent. Setting the value to 'down(2)' closes the subagent session (with c.reason set to 'reasonByManager'). When read, the value returned is always 'up(1)'." DEFVAL { up } ::= { agentxSessionEntry 4 } agentxSessionOpenTime OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime when this session was opened and, therefore, its value when this entry was added to the table." ::= { agentxSessionEntry 5 } agentxSessionAgentXVer OBJECT-TYPE SYNTAX INTEGER (1..255) MAX-ACCESS read-only STATUS current DESCRIPTION "The version of the AgentX protocol supported by the subagent. This will be less than or equal to the value of agentxMasterAgentXVer." DEFVAL { 1 } ::= { agentxSessionEntry 6 } agentxSessionTimeout OBJECT-TYPE SYNTAX INTEGER (0..255) UNITS "seconds" MAX-ACCESS read-only STATUS current DESCRIPTION "The length of time, in seconds, that a master agent should allow to elapse after dispatching a message to this subagent 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 subagent-specific value that may be overridden by values associated with specific registered MIB regions (see agentxRegTimeout). The default value of '0' indicates that the master agent's default timeout value should be used (see agentxDefaultTimeout)." DEFVAL { 0 } ::= { agentxSessionEntry 7 } -- -- The AgentX Registration Information group -- -- The statistics in this group are maintained by the Master Agent. -- -- Other stats have been removed. Support trap generation based -- on certain situations for duplicate registration. -- agentxRegisterDuplicate OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of agentx-Response-PDU messages sent by this master agent where the res.error field was set to 'duplicateRegistration'." ::= { agentxRegistration 1 } -- -- The AgentX Registration Table -- agentxRegistrationTable OBJECT-TYPE SYNTAX SEQUENCE OF AgentxRegistrationEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of registered OBJECT IDENTIFIER regions. This is the table used to identify a registered region of a subagent. Note that a subagent registration may be broken up into multiple entries in this table, as described in the AgentX Protocol specification [5]." ::= { agentxRegistration 2 } agentxRegistrationEntry OBJECT-TYPE SYNTAX AgentxRegistrationEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A single registered region. Regions are added by the master agent when subagents register and are removed from the table when the subagents unregister the region or their sessions are closed. Note that the combination of agentxRegContext, agentxRegStart and agentxRegDispatchOrder will be unique and could have been used for indexing purposes, but would have potentially resulted in excessively long OBJECT IDENTIFIERs." INDEX { agentxConnIndex, agentxSessionIndex, agentxRegIndex } ::= { agentxRegistrationTable 1 } AgentxRegistrationEntry ::= SEQUENCE { agentxRegIndex Unsigned32, agentxRegContext OCTET STRING, agentxRegStart OBJECT IDENTIFIER, agentxRegEnd OBJECT IDENTIFIER, agentxRegPriority Unsigned32, agentxRegTimeout INTEGER, agentxRegInstance TruthValue } agentxRegIndex OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS not-accessible STATUS current DESCRIPTION "AgentxRegIndex is an integer that uniquely identifies a registration entry. Its value is constant for the lifetime of an entry." ::= { agentxRegistrationEntry 1 } agentxRegContext OBJECT-TYPE SYNTAX OCTET STRING MAX-ACCESS read-only STATUS current DESCRIPTION "The context in which the subagent supports the objects in this region. A zero-length context indicates the default context." ::= { agentxRegistrationEntry 2 } agentxRegStart OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-only STATUS current DESCRIPTION "The starting OBJECT IDENTIFIER of this registration entry. The subagent 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." ::= { agentxRegistrationEntry 3 } agentxRegEnd OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-only STATUS current DESCRIPTION "The ending OBJECT IDENTIFIER of this registration entry. The subagent identified by agentxSessionIndex implements objects up to but not including this value. Note that this value could identify an object type, an object instance, or a partial object instance." ::= { agentxRegistrationEntry 4 } -- -- To support other subagent types that can be visible -- to the manager. -- agentxRegPriority OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "The subagent's priority when exporting this OID range. Lower values have higher priority." DEFVAL { 255 } ::= { agentxRegistrationEntry 5 } agentxRegTimeout OBJECT-TYPE SYNTAX INTEGER (0..255) UNITS "seconds" MAX-ACCESS read-only STATUS current DESCRIPTION "The timeout value, in seconds, for subagent responses to requests associated with this OID range. The value '0' indicates that the default value (indicated by agentxSessionTimeout or agentxDefaultTimeout) is to be used. This value is taken from the r.timeout field of the agentx-Register-PDU." DEFVAL { 0 } ::= { agentxRegistrationEntry 7 } agentxRegInstance OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "The value of agentxRegInstance is `true' for registrations for which the INSTANCE_REGISTRATION was set, and is `false' for all other registrations." DEFVAL { false } ::= { agentxRegistrationEntry 8 } -- -- Conformance Statements for the AgentX MIB -- agentxConformance OBJECT IDENTIFIER ::= { agentxMIB 2 } agentxMIBGroups OBJECT IDENTIFIER ::= { agentxConformance 1 } agentxMIBCompliances OBJECT IDENTIFIER ::= { agentxConformance 2 } agentxMIBCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SNMP entities that implement the AgentX protocol. Note that a compliant agent can implement all objects in this MIB module as read-only." MODULE -- this module MANDATORY-GROUPS { agentxMIBGroup } OBJECT agentxDefaultTimeout MIN-ACCESS read-only DESCRIPTION "Write access is not required." OBJECT agentxSessionAdminStatus MIN-ACCESS read-only DESCRIPTION "Write access is not required." ::= { agentxMIBCompliances 1 } agentxMIBGroup OBJECT-GROUP OBJECTS { agentxDefaultTimeout, agentxMasterAgentXVer, agentxConnTableLastChange, agentxConnNumber, agentxConnOpenTime, agentxConnTransportDomain, agentxConnTransportAddress, agentxConnSessions, agentxSessionTableLastChange, agentxSessionNumber, agentxSessionTimeout, agentxSessionObjectID, agentxSessionDescr, agentxSessionAdminStatus, agentxSessionOpenTime, agentxSessionAgentXVer, agentxRegisterDuplicate, agentxRegContext, agentxRegStart, agentxRegEnd, agentxRegPriority, agentxRegTimeout, agentxRegInstance } STATUS current DESCRIPTION "All accessible objects in the AgentX MIB." ::= { agentxMIBGroups 1 } END -- -- Copyright (C) The Internet Society (1997). All Rights Reserved. -- -- This document and translations of it may be copied and furnished to -- others, and derivative works that comment on or otherwise explain it or -- assist in its implmentation may be prepared, copied, published and -- distributed, in whole or in part, without restriction of any kind, -- provided that the above copyright notice and this paragraph are included -- on all such copies and derivative works. However, this document itself -- may not be modified in any way, such as by removing the copyright notice -- or references to the Internet Society or other Internet organizations, -- except as needed for the purpose of developing Internet standards in -- which case the procedures for copyrights defined in the Internet -- Standards process must be followed, or as required to translate it into -- languages other than English. -- -- The limited permissions granted above are perpetual and will not be -- revoked by the Internet Society or its successors or assigns. -- -- This document and the information contained herein is provided on an "AS -- IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK -- FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT -- LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT -- INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR -- FITNESS FOR A PARTICULAR PURPOSE.