1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
|
<pre>Network Working Group L. Heintz
Request For Comments: 2742 Cisco Systems
Category: Standards Track S. Gudur
Independent Consultant
M. Ellison, Ed.
Ellison Software Consulting, Inc.
January 2000
<span class="h1">Definitions of Managed Objects for Extensible SNMP Agents</span>
Status of this Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2000). All Rights Reserved.
Abstract
This memo defines a portion of the Management Information Base (MIB)
for use with network management protocols in the Internet community.
In particular, it describes objects managing SNMP agents that use the
Agent Extensibility (AgentX) Protocol.
This memo specifies a MIB module in a manner that is both compliant
to the SMIv2, and semantically identical to the peer SMIv1
definitions.
Table of Contents
<a href="#section-1">1</a>. The SNMP Management Framework ............................... <a href="#page-2">2</a>
<a href="#section-2">2</a>. Introduction ................................................ <a href="#page-3">3</a>
<a href="#section-3">3</a>. AgentX MIB Overview ......................................... <a href="#page-3">3</a>
<a href="#section-4">4</a>. Managed Object Definitions for AgentX ....................... <a href="#page-4">4</a>
<a href="#section-5">5</a>. Intellectual Property ....................................... <a href="#page-15">15</a>
<a href="#section-6">6</a>. Acknowledgements ............................................ <a href="#page-16">16</a>
<a href="#section-7">7</a>. Security Considerations ..................................... <a href="#page-16">16</a>
<a href="#section-8">8</a>. References .................................................. <a href="#page-17">17</a>
<a href="#section-9">9</a>. Authors' and Editor's Addresses ............................. <a href="#page-19">19</a>
<a href="#section-10">10</a>. Full Copyright Statement ................................... <a href="#page-20">20</a>
<span class="grey">Heintz, et al. Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. The SNMP Management Framework</span>
The SNMP Management Framework presently consists of five major
components:
- An overall architecture, described in <a href="./rfc2571">RFC 2571</a> [<a href="#ref-1" title=""An Architecture for Describing SNMP Management Frameworks"">1</a>].
- Mechanisms for describing and naming objects and events for the
purpose of management. The first version of this Structure of
Management Information (SMI) is called SMIv1 and described in STD
16, <a href="./rfc1155">RFC 1155</a> [<a href="#ref-2" title=""Structure and Identification of Management Information for TCP/IP-based Internets"">2</a>], STD 16, <a href="./rfc1212">RFC 1212</a> [<a href="#ref-3" title=""Concise MIB Definitions"">3</a>] and <a href="./rfc1215">RFC 1215</a> [<a href="#ref-4" title=""A Convention for Defining Traps for use with the SNMP"">4</a>]. The
second version, called SMIv2, is described in STD 58, <a href="./rfc2578">RFC 2578</a>
[<a href="#ref-5" title=""Structure of Management Information Version 2 (SMIv2)"">5</a>], STD 58, <a href="./rfc2579">RFC 2579</a> [<a href="#ref-6" title=""Textual Conventions for SMIv2"">6</a>] and STD 58, <a href="./rfc2580">RFC 2580</a> [<a href="#ref-7" title=""Conformance Statements for SMIv2"">7</a>].
- Message protocols for transferring management information. The
first version of the SNMP message protocol is called SNMPv1 and
described in STD 15, <a href="./rfc1157">RFC 1157</a> [<a href="#ref-8" title=""Simple Network Management Protocol"">8</a>]. A second version of the SNMP
message protocol, which is not an Internet standards track
protocol, is called SNMPv2c and described in <a href="./rfc1901">RFC 1901</a> [<a href="#ref-9" title=""Introduction to Community-based SNMPv2"">9</a>] and <a href="./rfc1906">RFC</a>
<a href="./rfc1906">1906</a> [<a href="#ref-10" title=""Transport Mappings for Version 2 of the Simple Network Management Protocol (SNMPv2)"">10</a>]. The third version of the message protocol is called
SNMPv3 and described in <a href="./rfc1906">RFC 1906</a> [<a href="#ref-10" title=""Transport Mappings for Version 2 of the Simple Network Management Protocol (SNMPv2)"">10</a>], <a href="./rfc2572">RFC 2572</a> [<a href="#ref-11" title=""Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)"">11</a>] and <a href="./rfc2574">RFC 2574</a>
[<a href="#ref-12" title=""User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)"">12</a>].
- Protocol operations for accessing management information. The
first set of protocol operations and associated PDU formats is
described in STD 15, <a href="./rfc1157">RFC 1157</a> [<a href="#ref-8" title=""Simple Network Management Protocol"">8</a>]. A second set of protocol
operations and associated PDU formats is described in <a href="./rfc1905">RFC 1905</a>
[<a href="#ref-13" title=""Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)"">13</a>].
- A set of fundamental applications described in <a href="./rfc2573">RFC 2573</a> [<a href="#ref-14" title=""SNMP Applications"">14</a>] and
the view-based access control mechanism described in <a href="./rfc2575">RFC 2575</a>
[<a href="#ref-15" title=""View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)"">15</a>].
A more detailed introduction to the current SNMP Management Framework
can be found in <a href="./rfc2570">RFC 2570</a> [<a href="#ref-16" title=""Introduction to Version 3 of the Internet-standard Network Management Framework"">16</a>].
Managed objects are accessed via a virtual information store, termed
the Management Information Base or MIB. Objects in the MIB are
defined using the mechanisms defined in the SMI.
This memo specifies a MIB module that is compliant to the SMIv2. A
MIB conforming to the SMIv1 can be produced through the appropriate
translations. The resulting translated MIB must be semantically
equivalent, except where objects or events are omitted because no
translation is possible (use of Counter64). Some machine readable
information in SMIv2 will be converted into textual descriptions in
<span class="grey">Heintz, et al. Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
SMIv1 during the translation process. However, this loss of machine
readable information is not considered to change the semantics of the
MIB.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Introduction</span>
The SNMP Agent Extensibility Protocol (AgentX) is a protocol used to
distribute the implementation of an SNMP agent amongst a single
"master agent" and multiple "subagents". See [<a href="#ref-17" title=""Agent Extensibility (AgentX) Protocol, Version 1"">17</a>] for details about
the AgentX protocol.
The goals of the AgentX MIB are:
- List the set of subagent connections that currently have logical
sessions open with the master agent.
- Identify each subagent connection transport address and type.
- Identify each subagent session vendor, AgentX protocol version,
and other characteristics.
- Identify the set of MIB objects each session implements, the
context in which the objects are registered, and the priority of
the registration.
- Determine protocol operational parameters such as the timeout
interval for responses from a session and the priority at which a
session registers a particular MIB region.
- Allow (but do not require) managers to explicitly close subagent
sessions with the master agent.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. AgentX MIB Overview</span>
This MIB is organized into four groups. The agentxGeneral group
provides information describing the master agent's AgentX support,
including the protocol version supported. The agentxConnection group
provides information describing the current set of connections
capable of carrying AgentX sessions. The agentxSession group
provides information describing the current set of AgentX sessions.
The agentxRegistration group provides information describing the
current set of registrations.
Three tables form the heart of this mib. These are the connection,
session, and registration tables.
<span class="grey">Heintz, et al. Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
Entries in the registration table exist in a many-to-one relationship
with entries in the session table. This relationship is expressed
through the two common indices, agentxSessionIndex and
agentxConnIndex. Entries in the registration table also exist in a
many-to-one relationship with entries in the connection table. This
relationship is expressed through the common index, agentxConnIndex.
Entries in the session table exist in a many-to-one relationship with
entries in the connection table. This relationship is expressed
through the common index, agentxConnIndex.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Managed Object Definitions for AgentX</span>
AGENTX-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, Unsigned32, mib-2
FROM SNMPv2-SMI
SnmpAdminString
FROM SNMP-FRAMEWORK-MIB
MODULE-COMPLIANCE, OBJECT-GROUP
FROM SNMPv2-CONF
TEXTUAL-CONVENTION, TimeStamp, TruthValue, TDomain
FROM SNMPv2-TC;
agentxMIB MODULE-IDENTITY
LAST-UPDATED "200001100000Z" -- Midnight 10 January 2000
ORGANIZATION "AgentX Working Group"
CONTACT-INFO "WG-email: agentx@dorothy.bmc.com
Subscribe: agentx-request@dorothy.bmc.com
WG-email Archive: <a href="ftp://ftp.peer.com/pub/agentx/archives">ftp://ftp.peer.com/pub/agentx/archives</a>
FTP repository: <a href="ftp://ftp.peer.com/pub/agentx">ftp://ftp.peer.com/pub/agentx</a>
<a href="http://www.ietf.org/html.charters/agentx-charter.html">http://www.ietf.org/html.charters/agentx-charter.html</a>
Chair: Bob Natale
ACE*COMM Corporation
Email: bnatale@acecomm.com
WG editor: Mark Ellison
Ellison Software Consulting, Inc.
Email: ellison@world.std.com
Co-author: Lauren Heintz
Cisco Systems,
EMail: lheintz@cisco.com
Co-author: Smitha Gudur
Independent Consultant
Email: sgudur@hotmail.com
<span class="grey">Heintz, et al. Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
"
DESCRIPTION "This is the MIB module for the SNMP Agent Extensibility
Protocol (AgentX). This MIB module will be implemented by
the master agent.
"
REVISION "200001100000Z" -- Midnight 10 January 2000
DESCRIPTION
"Initial version published as <a href="./rfc2742">RFC 2742</a>."
::= { mib-2 74 }
-- Textual Conventions
AgentxTAddress ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Denotes a transport service address. This is identical to
the TAddress textual convention (SNMPv2-SMI) except that
zero-length values are permitted.
"
SYNTAX OCTET STRING (SIZE (0..255))
-- Administrative assignments
agentxObjects OBJECT IDENTIFIER ::= { agentxMIB 1 }
agentxGeneral OBJECT IDENTIFIER ::= { agentxObjects 1 }
agentxConnection OBJECT IDENTIFIER ::= { agentxObjects 2 }
agentxSession OBJECT IDENTIFIER ::= { agentxObjects 3 }
agentxRegistration OBJECT IDENTIFIER ::= { agentxObjects 4 }
agentxDefaultTimeout OBJECT-TYPE
SYNTAX INTEGER (0..255)
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"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
<span class="grey">Heintz, et al. Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
master agent to await a response to a dispatch from a
given subagent.
"
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.
The current protocol version is 1. Note that the master agent
must also allow interaction with earlier version subagents.
"
::= { 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 }
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
carried on a given AgentX connection.
"
::= { agentxConnection 2 }
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
<span class="grey">Heintz, et al. Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
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.
"
INDEX { agentxConnIndex }
::= { agentxConnectionTable 1 }
AgentxConnectionEntry ::= SEQUENCE {
agentxConnIndex Unsigned32,
agentxConnOpenTime TimeStamp,
agentxConnTransportDomain TDomain,
agentxConnTransportAddress AgentxTAddress }
agentxConnIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"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.
"
::= { 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
subagent.
"
::= { agentxConnectionEntry 3 }
agentxConnTransportAddress OBJECT-TYPE
SYNTAX AgentxTAddress
<span class="grey">Heintz, et al. Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"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.
"
::= { agentxConnectionEntry 4 }
-- 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 }
agentxSessionTable OBJECT-TYPE
SYNTAX SEQUENCE OF AgentxSessionEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table of AgentX subagent sessions currently in effect.
"
::= { agentxSession 2 }
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 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.
"
INDEX { agentxConnIndex, agentxSessionIndex }
::= { agentxSessionTable 1 }
AgentxSessionEntry ::= SEQUENCE {
agentxSessionIndex Unsigned32,
<span class="grey">Heintz, et al. Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
agentxSessionObjectID OBJECT IDENTIFIER,
agentxSessionDescr SnmpAdminString,
agentxSessionAdminStatus INTEGER,
agentxSessionOpenTime TimeStamp,
agentxSessionAgentXVer INTEGER,
agentxSessionTimeout INTEGER
}
agentxSessionIndex OBJECT-TYPE
SYNTAX Unsigned32 (0..4294967295)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"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.
"
::= { agentxSessionEntry 1 }
agentxSessionObjectID OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"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.
"
::= { agentxSessionEntry 2 }
agentxSessionDescr OBJECT-TYPE
SYNTAX SnmpAdminString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual description of the session. This is analogous to
sysDescr defined in the SNMPv2-MIB in <a href="./rfc1907">RFC 1907</a> [<a href="#ref-19" title=""Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)"">19</a>] 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.
"
::= { agentxSessionEntry 3 }
agentxSessionAdminStatus OBJECT-TYPE
<span class="grey">Heintz, et al. Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
SYNTAX INTEGER {
up(1),
down(2)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The administrative (desired) status of the session. Setting
the value to 'down(2)' closes the subagent session (with c.reason
set to 'reasonByManager').
"
::= { 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
session. This must be less than or equal to the value of
agentxMasterAgentXVer.
"
::= { 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 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
<span class="grey">Heintz, et al. Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
(see agentxDefaultTimeout).
"
::= { agentxSessionEntry 7 }
-- The AgentX Registration Group
agentxRegistrationTableLastChange 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 agentxRegistrationTable.
"
::= { agentxRegistration 1 }
agentxRegistrationTable OBJECT-TYPE
SYNTAX SEQUENCE OF AgentxRegistrationEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table of registered regions.
"
::= { agentxRegistration 2 }
agentxRegistrationEntry OBJECT-TYPE
SYNTAX AgentxRegistrationEntry
MAX-ACCESS not-accessible
STATUS current
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.
"
INDEX { agentxConnIndex, agentxSessionIndex, agentxRegIndex }
::= { agentxRegistrationTable 1 }
AgentxRegistrationEntry ::= SEQUENCE {
agentxRegIndex Unsigned32,
agentxRegContext OCTET STRING,
agentxRegStart OBJECT IDENTIFIER,
agentxRegRangeSubId Unsigned32,
agentxRegUpperBound Unsigned32,
agentxRegPriority Unsigned32,
agentxRegTimeout INTEGER,
agentxRegInstance TruthValue }
<span class="grey">Heintz, et al. Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
agentxRegIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"agentxRegIndex uniquely identifies a registration entry.
This 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 session 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
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.
"
::= { agentxRegistrationEntry 3 }
agentxRegRangeSubId OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"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.
"
::= { agentxRegistrationEntry 4 }
agentxRegUpperBound OBJECT-TYPE
<span class="grey">Heintz, et al. Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"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.
"
::= { agentxRegistrationEntry 5 }
agentxRegPriority OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"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.
"
::= { agentxRegistrationEntry 6 }
agentxRegTimeout OBJECT-TYPE
SYNTAX INTEGER (0..255)
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"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.
"
::= { 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.
"
<span class="grey">Heintz, et al. Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
::= { agentxRegistrationEntry 8 }
-- Conformance Statements for AgentX
agentxConformance OBJECT IDENTIFIER ::= { agentxMIB 2 }
agentxMIBGroups OBJECT IDENTIFIER ::= { agentxConformance 1 }
agentxMIBCompliances OBJECT IDENTIFIER ::= { agentxConformance 2 }
-- Compliance Statements for AgentX
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 agentxSessionAdminStatus
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required.
"
::= { agentxMIBCompliances 1 }
agentxMIBGroup OBJECT-GROUP
OBJECTS {
agentxDefaultTimeout,
agentxMasterAgentXVer,
agentxConnTableLastChange,
agentxConnOpenTime,
agentxConnTransportDomain,
agentxConnTransportAddress,
agentxSessionTableLastChange,
agentxSessionTimeout,
agentxSessionObjectID,
agentxSessionDescr,
agentxSessionAdminStatus,
agentxSessionOpenTime,
agentxSessionAgentXVer,
agentxRegistrationTableLastChange,
agentxRegContext,
agentxRegStart,
agentxRegRangeSubId,
agentxRegUpperBound,
agentxRegPriority,
<span class="grey">Heintz, et al. Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
agentxRegTimeout,
agentxRegInstance
}
STATUS current
DESCRIPTION
"All accessible objects in the AgentX MIB.
"
::= { agentxMIBGroups 1 }
END
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Intellectual Property</span>
The IETF takes no position regarding the validity or scope of any
intellectual property or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; neither does it represent that it
has made any effort to identify any such rights. Information on the
IETF's procedures with respect to rights in standards-track and
standards-related documentation can be found in <a href="https://www.rfc-editor.org/bcp/bcp11">BCP-11</a>. Copies of
claims of rights made available for publication and any assurances of
licenses to be made available, or the result of an attempt made to
obtain a general license or permission for the use of such
proprietary rights by implementors or users of this specification can
be obtained from the IETF Secretariat.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights which may cover technology that may be required to practice
this standard. Please address the information to the IETF Executive
Director.
<span class="grey">Heintz, et al. Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Acknowledgements</span>
This document is the result of the efforts of the IETF AgentX Working
Group (WG).
This MIB is an evolution of the Subagent MIB by Bert Wijnen
(wijnen@vnet.ibm.com) which in turn was derived from the SMUX-MIB by
Marshall Rose [<a href="#ref-18" title=""SNMP MUX Protocol and MIB"">18</a>].
Thanks are in order to the following AgentX WG members:
Mike Daniele (Compaq Computer Corporation)
Dale Francisco (Cisco Systems)
Bob Natale (ACE*COMM Corporation)
Randy Presuhn (BMC Software, Inc.)
Shawn Routhier (Epilogue)
Mike Thatcher (Independent Consultant)
Special acknowledgement is made to:
Maria Greene (Xedia)
Special acknowledgement is also made to the following individuals for
participating in the 1998 AgentX testing summit (bakeoff) held in
Sunnyvale, California:
Jeff Case (SNMP Research, Inc.)
Mike Daniele (Compaq Computer Corporation)
Mark Ellison (Ellison Software Consulting, Inc.)
Lauren Heintz (BMC Software, Inc.)
Verne Hyde (Independent Consultant)
Bob Natale (ACE*COMM Corporation)
Shawn Routhier (Epilogue)
Mike Thatcher (Independent Consultant)
Bert Wijnen (IBM T. J. Watson Research Center)
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Security Considerations</span>
There is a single management object defined in this MIB that has a
MAX-ACCESS clause of read-write. This object may be considered
sensitive or vulnerable in some network environments. The support
for SET operations in a non-secure environment without proper
protection can have a negative effect on network operations.
<span class="grey">Heintz, et al. Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
There is a single managed object in this MIB that may contain
sensitive information. This object is agentxSessionAdminStatus.
Setting agentxSessionAdminStatus to an inappropriate value can
effectively prevent access to management information, or provide
access to inappropriate information.
It is thus important to control even GET access to these objects and
possibly to even encrypt the values of these objects when sending
them over the network via SNMP. Not all versions of SNMP provide
features for such a secure environment.
SNMPv1 by itself is not a secure environment. Even if the network
itself is secure (for example by using IPSec), even then, there is no
control as to who on the secure network is allowed to access and
GET/SET (read/change/create/delete) the objects in this MIB.
It is recommended that the implementers consider the security
features as provided by the SNMPv3 framework. Specifically, the use
of the User-based Security Model <a href="./rfc2574">RFC 2574</a> [<a href="#ref-12" title=""User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)"">12</a>] and the View-based
Access Control Model <a href="./rfc2575">RFC 2575</a> [<a href="#ref-15" title=""View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)"">15</a>] is recommended.
It is then a customer/user responsibility to ensure that the SNMP
entity giving access to an instance of this MIB, is properly
configured to give access to the objects only to those principals
(users) that have legitimate rights to indeed GET or SET
(change/delete) them.
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. References</span>
[<a id="ref-1">1</a>] Harrington, D., Presuhn, R. and B. Wijnen, "An Architecture for
Describing SNMP Management Frameworks", <a href="./rfc2571">RFC 2571</a>, April 1999.
[<a id="ref-2">2</a>] Rose, M. and K. McCloghrie, "Structure and Identification of
Management Information for TCP/IP-based Internets", STD 16, <a href="./rfc1155">RFC</a>
<a href="./rfc1155">1155</a>, May 1990.
[<a id="ref-3">3</a>] Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16,
<a href="./rfc1212">RFC 1212</a>, March 1991.
[<a id="ref-4">4</a>] Rose, M., "A Convention for Defining Traps for use with the
SNMP", <a href="./rfc1215">RFC 1215</a>, March 1991.
[<a id="ref-5">5</a>] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose,
M. and S. Waldbusser, "Structure of Management Information
Version 2 (SMIv2)", STD 58, <a href="./rfc2578">RFC 2578</a>, April 1999.
<span class="grey">Heintz, et al. Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
[<a id="ref-6">6</a>] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M. and S. Waldbusser, "Textual Conventions for SMIv2", STD
58, <a href="./rfc2579">RFC 2579</a>, April 1999.
[<a id="ref-7">7</a>] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose,
M. and S. Waldbusser, "Conformance Statements for SMIv2", STD
58, <a href="./rfc2580">RFC 2580</a>, April 1999.
[<a id="ref-8">8</a>] Case, J., Fedor, M., Schoffstall, M. and J. Davin, "Simple
Network Management Protocol", STD 15, <a href="./rfc1157">RFC 1157</a>, May 1990.
[<a id="ref-9">9</a>] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
"Introduction to Community-based SNMPv2", <a href="./rfc1901">RFC 1901</a>, January
1996.
[<a id="ref-10">10</a>] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
"Transport Mappings for Version 2 of the Simple Network
Management Protocol (SNMPv2)", <a href="./rfc1906">RFC 1906</a>, January 1996.
[<a id="ref-11">11</a>] Case, J., Harrington D., Presuhn R. and B. Wijnen, "Message
Processing and Dispatching for the Simple Network Management
Protocol (SNMP)", <a href="./rfc2572">RFC 2572</a>, April 1999.
[<a id="ref-12">12</a>] Blumenthal, U. and B. Wijnen, "User-based Security Model (USM)
for version 3 of the Simple Network Management Protocol
(SNMPv3)", <a href="./rfc2574">RFC 2574</a>, April 1999.
[<a id="ref-13">13</a>] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Protocol
Operations for Version 2 of the Simple Network Management
Protocol (SNMPv2)", <a href="./rfc1905">RFC 1905</a>, January 1996.
[<a id="ref-14">14</a>] Levi, D., Meyer, P. and B. Stewart, "SNMP Applications", <a href="./rfc2573">RFC</a>
<a href="./rfc2573">2573</a>, April 1999.
[<a id="ref-15">15</a>] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access
Control Model (VACM) for the Simple Network Management Protocol
(SNMP)", <a href="./rfc2575">RFC 2575</a>, April 1999.
[<a id="ref-16">16</a>] Case, J., Mundy, R., Partain, D. and B. Stewart, "Introduction
to Version 3 of the Internet-standard Network Management
Framework", <a href="./rfc2570">RFC 2570</a>, April 1999.
[<a id="ref-17">17</a>] Daniele, M., Wijnen, B., Ellison, M. and D. Francisco, "Agent
Extensibility (AgentX) Protocol, Version 1", <a href="./rfc2741">RFC 2741</a>, January
2000.
[<a id="ref-18">18</a>] Rose, M., "SNMP MUX Protocol and MIB", <a href="./rfc1227">RFC 1227</a>, May 1991.
<span class="grey">Heintz, et al. Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
[<a id="ref-19">19</a>] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
"Management Information Base for Version 2 of the Simple Network
Management Protocol (SNMPv2)", <a href="./rfc1907">RFC 1907</a>, January 1996.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Authors' and Editor's Addresses</span>
Lauren Heintz
Cisco Systems
1450 North McDowell Blvd.
Petaluma, CA 94954-6515
USA
Phone: +1 707-793-1714
EMail: lheintz@cisco.com
Smitha Gudur
Independent Consultant
EMail: sgudur@hotmail.com
Mark Ellison (WG editor)
Ellison Software Consulting, Inc.
38 Salem Road
Atkinso, NH 03811
USA
Phone: +1 603-362-9270
Email: ellison@world.std.com
<span class="grey">Heintz, et al. Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc2742">RFC 2742</a> Agent X MIB January 2000</span>
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Full Copyright Statement</span>
Copyright (C) The Internet Society (2000). 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 implementation 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.
Acknowledgement
Funding for the RFC Editor function is currently provided by the
Internet Society.
Heintz, et al. Standards Track [Page 20]
</pre>
|
