1
AGENTX-MIB DEFINITIONS ::= BEGIN
4
MODULE-IDENTITY, OBJECT-TYPE, Unsigned32, mib-2
7
FROM SNMP-FRAMEWORK-MIB
8
MODULE-COMPLIANCE, OBJECT-GROUP
10
TEXTUAL-CONVENTION, TimeStamp, TruthValue, TDomain
12
agentxMIB MODULE-IDENTITY
13
LAST-UPDATED "200001100000Z" -- Midnight 10 January 2000
14
ORGANIZATION "AgentX Working Group"
15
CONTACT-INFO "WG-email: agentx@dorothy.bmc.com
16
Subscribe: agentx-request@dorothy.bmc.com
17
WG-email Archive: ftp://ftp.peer.com/pub/agentx/archives
18
FTP repository: ftp://ftp.peer.com/pub/agentx
19
http://www.ietf.org/html.charters/agentx-charter.html
23
Email: bnatale@acecomm.com
25
WG editor: Mark Ellison
26
Ellison Software Consulting, Inc.
27
Email: ellison@world.std.com
29
Co-author: Lauren Heintz
31
EMail: lheintz@cisco.com
33
Co-author: Smitha Gudur
34
Independent Consultant
35
Email: sgudur@hotmail.com
37
DESCRIPTION "This is the MIB module for the SNMP Agent Extensibility
38
Protocol (AgentX). This MIB module will be implemented by
42
REVISION "200001100000Z" -- Midnight 10 January 2000
44
"Initial version published as RFC 2742."
47
-- Textual Conventions
49
AgentxTAddress ::= TEXTUAL-CONVENTION
52
"Denotes a transport service address. This is identical to
53
the TAddress textual convention (SNMPv2-SMI) except that
54
zero-length values are permitted.
56
SYNTAX OCTET STRING (SIZE (0..255))
58
-- Administrative assignments
60
agentxObjects OBJECT IDENTIFIER ::= { agentxMIB 1 }
61
agentxGeneral OBJECT IDENTIFIER ::= { agentxObjects 1 }
62
agentxConnection OBJECT IDENTIFIER ::= { agentxObjects 2 }
63
agentxSession OBJECT IDENTIFIER ::= { agentxObjects 3 }
64
agentxRegistration OBJECT IDENTIFIER ::= { agentxObjects 4 }
66
agentxDefaultTimeout OBJECT-TYPE
67
SYNTAX INTEGER (0..255)
72
"The default length of time, in seconds, that the master
73
agent should allow to elapse after dispatching a message
74
to a session before it regards the subagent as not
75
responding. This is a system-wide value that may
76
override the timeout value associated with a particular
77
session (agentxSessionTimeout) or a particular registered
78
MIB region (agentxRegTimeout). If the associated value of
79
agentxSessionTimeout and agentxRegTimeout are zero, or
80
impractical in accordance with implementation-specific
81
procedure of the master agent, the value represented by
82
this object will be the effective timeout value for the
84
master agent to await a response to a dispatch from a
88
::= { agentxGeneral 1 }
90
agentxMasterAgentXVer OBJECT-TYPE
91
SYNTAX INTEGER (1..255)
95
"The AgentX protocol version supported by this master agent.
96
The current protocol version is 1. Note that the master agent
97
must also allow interaction with earlier version subagents.
99
::= { agentxGeneral 2 }
101
-- The AgentX Subagent Connection Group
103
agentxConnTableLastChange OBJECT-TYPE
108
"The value of sysUpTime when the last row creation or deletion
109
occurred in the agentxConnectionTable.
111
::= { agentxConnection 1 }
113
agentxConnectionTable OBJECT-TYPE
114
SYNTAX SEQUENCE OF AgentxConnectionEntry
115
MAX-ACCESS not-accessible
118
"The agentxConnectionTable tracks all current AgentX transport
119
connections. There may be zero, one, or more AgentX sessions
120
carried on a given AgentX connection.
122
::= { agentxConnection 2 }
124
agentxConnectionEntry OBJECT-TYPE
125
SYNTAX AgentxConnectionEntry
126
MAX-ACCESS not-accessible
129
"An agentxConnectionEntry contains information describing a
130
single AgentX transport connection. A connection may be
132
used to support zero or more AgentX sessions. An entry is
133
created when a new transport connection is established,
134
and is destroyed when the transport connection is terminated.
136
INDEX { agentxConnIndex }
137
::= { agentxConnectionTable 1 }
139
AgentxConnectionEntry ::= SEQUENCE {
140
agentxConnIndex Unsigned32,
141
agentxConnOpenTime TimeStamp,
142
agentxConnTransportDomain TDomain,
143
agentxConnTransportAddress AgentxTAddress }
145
agentxConnIndex OBJECT-TYPE
146
SYNTAX Unsigned32 (1..4294967295)
147
MAX-ACCESS not-accessible
150
"agentxConnIndex contains the value that uniquely identifies
151
an open transport connection used by this master agent
152
to provide AgentX service. Values of this index should
153
not be re-used. The value assigned to a given transport
154
connection is constant for the lifetime of that connection.
156
::= { agentxConnectionEntry 1 }
158
agentxConnOpenTime OBJECT-TYPE
163
"The value of sysUpTime when this connection was established
164
and, therefore, its value when this entry was added to the table.
166
::= { agentxConnectionEntry 2 }
168
agentxConnTransportDomain OBJECT-TYPE
173
"The transport protocol in use for this connection to the
176
::= { agentxConnectionEntry 3 }
178
agentxConnTransportAddress OBJECT-TYPE
179
SYNTAX AgentxTAddress
183
"The transport address of the remote (subagent) end of this
184
connection to the master agent. This object may be zero-length
185
for unix-domain sockets (and possibly other types of transport
186
addresses) since the subagent need not bind a filename to its
189
::= { agentxConnectionEntry 4 }
191
-- The AgentX Subagent Session Group
193
agentxSessionTableLastChange OBJECT-TYPE
198
"The value of sysUpTime when the last row creation or deletion
199
occurred in the agentxSessionTable.
201
::= { agentxSession 1 }
203
agentxSessionTable OBJECT-TYPE
204
SYNTAX SEQUENCE OF AgentxSessionEntry
205
MAX-ACCESS not-accessible
208
"A table of AgentX subagent sessions currently in effect.
210
::= { agentxSession 2 }
212
agentxSessionEntry OBJECT-TYPE
213
SYNTAX AgentxSessionEntry
214
MAX-ACCESS not-accessible
217
"Information about a single open session between the AgentX
218
master agent and a subagent is contained in this entry. An
219
entry is created when a new session is successfully established
220
and is destroyed either when the subagent transport connection
221
has terminated or when the subagent session is closed.
223
INDEX { agentxConnIndex, agentxSessionIndex }
224
::= { agentxSessionTable 1 }
226
AgentxSessionEntry ::= SEQUENCE {
227
agentxSessionIndex Unsigned32,
228
agentxSessionObjectID OBJECT IDENTIFIER,
229
agentxSessionDescr SnmpAdminString,
230
agentxSessionAdminStatus INTEGER,
231
agentxSessionOpenTime TimeStamp,
232
agentxSessionAgentXVer INTEGER,
233
agentxSessionTimeout INTEGER
236
agentxSessionIndex OBJECT-TYPE
237
SYNTAX Unsigned32 (0..4294967295)
238
MAX-ACCESS not-accessible
241
"A unique index for the subagent session. It is the same as
242
h.sessionID defined in the agentx header. Note that if
243
a subagent's session with the master agent is closed for
244
any reason its index should not be re-used.
245
A value of zero(0) is specifically allowed in order
246
to be compatible with the definition of h.sessionId.
248
::= { agentxSessionEntry 1 }
250
agentxSessionObjectID OBJECT-TYPE
251
SYNTAX OBJECT IDENTIFIER
255
"This is taken from the o.id field of the agentx-Open-PDU.
256
This attribute will report a value of '0.0' for subagents
257
not supporting the notion of an AgentX session object
260
::= { agentxSessionEntry 2 }
262
agentxSessionDescr OBJECT-TYPE
263
SYNTAX SnmpAdminString
267
"A textual description of the session. This is analogous to
268
sysDescr defined in the SNMPv2-MIB in RFC 1907 [19] and is
269
taken from the o.descr field of the agentx-Open-PDU.
270
This attribute will report a zero-length string value for
271
subagents not supporting the notion of a session description.
273
::= { agentxSessionEntry 3 }
275
agentxSessionAdminStatus OBJECT-TYPE
280
MAX-ACCESS read-write
283
"The administrative (desired) status of the session. Setting
284
the value to 'down(2)' closes the subagent session (with c.reason
285
set to 'reasonByManager').
287
::= { agentxSessionEntry 4 }
289
agentxSessionOpenTime OBJECT-TYPE
294
"The value of sysUpTime when this session was opened and,
295
therefore, its value when this entry was added to the table.
297
::= { agentxSessionEntry 5 }
299
agentxSessionAgentXVer OBJECT-TYPE
300
SYNTAX INTEGER (1..255)
304
"The version of the AgentX protocol supported by the
305
session. This must be less than or equal to the value of
306
agentxMasterAgentXVer.
308
::= { agentxSessionEntry 6 }
310
agentxSessionTimeout OBJECT-TYPE
311
SYNTAX INTEGER (0..255)
316
"The length of time, in seconds, that a master agent should
317
allow to elapse after dispatching a message to this session
318
before it regards the subagent as not responding. This value
319
is taken from the o.timeout field of the agentx-Open-PDU.
320
This is a session-specific value that may be overridden by
321
values associated with the specific registered MIB regions
322
(see agentxRegTimeout). A value of zero(0) indicates that
323
the master agent's default timeout value should be used
325
(see agentxDefaultTimeout).
327
::= { agentxSessionEntry 7 }
329
-- The AgentX Registration Group
331
agentxRegistrationTableLastChange OBJECT-TYPE
336
"The value of sysUpTime when the last row creation or deletion
337
occurred in the agentxRegistrationTable.
339
::= { agentxRegistration 1 }
341
agentxRegistrationTable OBJECT-TYPE
342
SYNTAX SEQUENCE OF AgentxRegistrationEntry
343
MAX-ACCESS not-accessible
346
"A table of registered regions.
348
::= { agentxRegistration 2 }
350
agentxRegistrationEntry OBJECT-TYPE
351
SYNTAX AgentxRegistrationEntry
352
MAX-ACCESS not-accessible
355
"Contains information for a single registered region. An
356
entry is created when a session successfully registers a
357
region and is destroyed for any of three reasons: this region
358
is unregistered by the session, the session is closed,
359
or the subagent connection is closed.
361
INDEX { agentxConnIndex, agentxSessionIndex, agentxRegIndex }
362
::= { agentxRegistrationTable 1 }
364
AgentxRegistrationEntry ::= SEQUENCE {
365
agentxRegIndex Unsigned32,
366
agentxRegContext OCTET STRING,
367
agentxRegStart OBJECT IDENTIFIER,
368
agentxRegRangeSubId Unsigned32,
369
agentxRegUpperBound Unsigned32,
370
agentxRegPriority Unsigned32,
371
agentxRegTimeout INTEGER,
372
agentxRegInstance TruthValue }
374
agentxRegIndex OBJECT-TYPE
375
SYNTAX Unsigned32 (1..4294967295)
376
MAX-ACCESS not-accessible
379
"agentxRegIndex uniquely identifies a registration entry.
380
This value is constant for the lifetime of an entry.
382
::= { agentxRegistrationEntry 1 }
384
agentxRegContext OBJECT-TYPE
389
"The context in which the session supports the objects in this
390
region. A zero-length context indicates the default context.
392
::= { agentxRegistrationEntry 2 }
394
agentxRegStart OBJECT-TYPE
395
SYNTAX OBJECT IDENTIFIER
399
"The starting OBJECT IDENTIFIER of this registration entry. The
400
session identified by agentxSessionIndex implements objects
401
starting at this value (inclusive). Note that this value could
402
identify an object type, an object instance, or a partial object
405
::= { agentxRegistrationEntry 3 }
407
agentxRegRangeSubId OBJECT-TYPE
412
"agentxRegRangeSubId is used to specify the range. This is
413
taken from r.region_subid in the registration PDU. If the value
414
of this object is zero, no range is specified. If it is non-zero,
415
it identifies the `nth' sub-identifier in r.region for which
416
this entry's agentxRegUpperBound value is substituted in the
417
OID for purposes of defining the region's upper bound.
419
::= { agentxRegistrationEntry 4 }
421
agentxRegUpperBound OBJECT-TYPE
426
"agentxRegUpperBound represents the upper-bound sub-identifier in
427
a registration. This is taken from the r.upper_bound in the
428
registration PDU. If agentxRegRangeSubid (r.region_subid) is
429
zero, this value is also zero and is not used to define an upper
430
bound for this registration.
432
::= { agentxRegistrationEntry 5 }
434
agentxRegPriority OBJECT-TYPE
439
"The registration priority. Lower values have higher priority.
440
This value is taken from r.priority in the register PDU.
441
Sessions should use the value of 127 for r.priority if a
442
default value is desired.
444
::= { agentxRegistrationEntry 6 }
446
agentxRegTimeout OBJECT-TYPE
447
SYNTAX INTEGER (0..255)
452
"The timeout value, in seconds, for responses to
453
requests associated with this registered MIB region.
454
A value of zero(0) indicates the default value (indicated
455
by by agentxSessionTimeout or agentxDefaultTimeout) is to
456
be used. This value is taken from the r.timeout field of
457
the agentx-Register-PDU.
459
::= { agentxRegistrationEntry 7 }
461
agentxRegInstance OBJECT-TYPE
466
"The value of agentxRegInstance is `true' for
467
registrations for which the INSTANCE_REGISTRATION
468
was set, and is `false' for all other registrations.
470
::= { agentxRegistrationEntry 8 }
472
-- Conformance Statements for AgentX
474
agentxConformance OBJECT IDENTIFIER ::= { agentxMIB 2 }
475
agentxMIBGroups OBJECT IDENTIFIER ::= { agentxConformance 1 }
476
agentxMIBCompliances OBJECT IDENTIFIER ::= { agentxConformance 2 }
478
-- Compliance Statements for AgentX
480
agentxMIBCompliance MODULE-COMPLIANCE
483
"The compliance statement for SNMP entities that implement the
484
AgentX protocol. Note that a compliant agent can implement all
485
objects in this MIB module as read-only.
487
MODULE -- this module
488
MANDATORY-GROUPS { agentxMIBGroup }
490
OBJECT agentxSessionAdminStatus
493
"Write access is not required.
495
::= { agentxMIBCompliances 1 }
497
agentxMIBGroup OBJECT-GROUP
499
agentxDefaultTimeout,
500
agentxMasterAgentXVer,
501
agentxConnTableLastChange,
503
agentxConnTransportDomain,
504
agentxConnTransportAddress,
505
agentxSessionTableLastChange,
506
agentxSessionTimeout,
507
agentxSessionObjectID,
509
agentxSessionAdminStatus,
510
agentxSessionOpenTime,
511
agentxSessionAgentXVer,
512
agentxRegistrationTableLastChange,
523
"All accessible objects in the AgentX MIB.
525
::= { agentxMIBGroups 1 }
added
removed
mibs/AGENTX-MIB.txt
