-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathCISCO-TC
1632 lines (1333 loc) · 62.9 KB
/
CISCO-TC
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
-- *****************************************************************
-- CISCO-TC.my: Cisco MIB Textual Conventions
--
-- May 1994, Jeffrey T. Johnson
--
-- Copyright (c) 1994-2007 by cisco Systems, Inc.
-- All rights reserved.
--
-- ****************************************************************
CISCO-TC DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY,
Gauge32,
Integer32,
Unsigned32,
Counter64
FROM SNMPv2-SMI
TEXTUAL-CONVENTION
FROM SNMPv2-TC
ciscoModules
FROM CISCO-SMI;
ciscoTextualConventions MODULE-IDENTITY
LAST-UPDATED "200702150000Z"
ORGANIZATION "Cisco Systems, Inc."
CONTACT-INFO
"Cisco Systems
Customer Service
Postal: 170 W Tasman Drive
San Jose, CA 95134
USA
Tel: +1 800 553-NETS
E-mail: [email protected]"
DESCRIPTION
"This module defines textual conventions used throughout
cisco enterprise mibs."
REVISION "200702150000Z"
DESCRIPTION
"Added following textual conventions:
CiscoVlanList,
CiscoCosList,
CiscoPbbServiceIdentifier"
REVISION "200607060000Z"
DESCRIPTION
"Added the following enums to IfOperStatusReason:
- elpFailureAllZeroPeerWWNRcvd,
- preferredPathIsolation."
REVISION "200604130000Z"
DESCRIPTION
"Added enumeration to IfOperStatusReason from 113-131
('dpvmVsanSuspended' to 'domainOther')."
REVISION "200506240000Z"
DESCRIPTION
"Added CvE164Address textual convention."
REVISION "200506160000Z"
DESCRIPTION
"Added following textual conventions:
CiscoURLString
CiscoHTTPResponseStatusCode
EntLogicalIndexOrZero."
REVISION "200410110000Z"
DESCRIPTION
"Added IfOperStatusReason textual convention."
REVISION "200406080000Z"
DESCRIPTION
"Added CiscoPortListRange textual convention."
REVISION "200404140000Z"
DESCRIPTION
"Added CiscoPortList textual convention.
Removed Unsigned32 textual convention."
REVISION "200212180000Z"
DESCRIPTION
"Changed MilliSeconds TC to CiscoMilliSeconds as it was
overlapping with the one in a standard MIB."
REVISION "200212121600Z"
DESCRIPTION
"Added the 'http' enumeration to CiscoNetworkProtocol."
REVISION "200212020000Z"
DESCRIPTION
"Added Unsigned64 textual convention."
REVISION "200209220000Z"
DESCRIPTION
"Added ListIndex, ListIndexOrZero, TimeIntervalSec,
TimeintervalMin, MicroSeconds and MicroSeconds TC from Andiamo's
TC MIB ."
REVISION "200209170000Z"
DESCRIPTION
"Added ConfigIterator & BulkConfigResult textual
convention for bulk provisioning.
Added CountryCodeITU textual convention for ITU-T defined
country codes for non-standard facilities."
REVISION "200204160000Z"
DESCRIPTION
"Added PerfHighIntervalCount TEXTUAL-CONVENTION."
REVISION "200107070000Z"
DESCRIPTION
"Added enumerations to CiscoNetworkProtocol"
REVISION "200101180000Z"
DESCRIPTION
"Added CiscoAlarmSeverity textual convention.
Changed SAPType display hint to d. Changed
INTEGER to Integer32 in CiscoPort and
CiscoIpProtocol TCs. Changed SnmpAdminString
to OCTET STRING in CiscoLocationSpecifier.
Removed IMPORTs for ciscoProducts and
SnmpAdminString."
REVISION "200011210000Z"
DESCRIPTION
"Added CiscoLocationClass, CiscoLocationSpecifier
CiscoInetAddressMask, CiscoAbsZeroBasedCounter32,
CiscoSnapShotAbsCounter32 textual conventions."
REVISION "9810280000Z"
DESCRIPTION
"Added CiscoRowOperStatus, EntPhysicalIndexOrZero,
Port and IpProtocol textual conventions."
REVISION "9703130000Z"
DESCRIPTION
"Added SAPType, CountryCode textual convention."
REVISION "9608140000Z"
DESCRIPTION
"Added InterfaceIndexOrZero textual convention."
REVISION "9607080000Z"
DESCRIPTION
"Added new CiscoNetworkProtocol enumerations."
REVISION "9602220000Z"
DESCRIPTION
"Added Unsigned32 textual conventions."
REVISION "9506070000Z"
DESCRIPTION
"Miscellaneous updates/corrections, including making
CiscoNetworkProtocol enumerations contiguous."
::= { ciscoModules 1 }
Layer2Cos ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"An integer that is in the range of the layer 2 CoS values. It
corresponds to the IEEE 802.1P CoS value which defines eight
(2^3) user priority levels.
Note: the IEEE 802.1P has been merged into IEEE 802.1D."
REFERENCE
"IEEE 802.1D, 2004 Edition, Annex G User priorities and traffic
classes."
SYNTAX Integer32 (0..7 )
CiscoNetworkProtocol ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Represents the different types of network layer protocols."
SYNTAX INTEGER {
ip(1),
decnet(2),
pup(3),
chaos(4),
xns(5),
x121(6),
appletalk(7),
clns(8),
lat(9),
vines(10),
cons(11),
apollo(12),
stun(13),
novell(14),
qllc(15),
snapshot(16),
atmIlmi(17),
bstun(18),
x25pvc(19),
ipv6(20),
cdm(21),
nbf(22),
bpxIgx(23),
clnsPfx(24),
http(25),
unknown(65535)
}
CiscoNetworkAddress ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Represents a network layer address. The length and format of
the address is protocol dependent as follows:
ip 4 octets
decnet 2 octets
pup obsolete
chaos 2 octets
xns 10 octets
first 4 octets are the net number
last 6 octets are the host number
x121
appletalk 3 octets
first 2 octets are the net number
last octet is the host number
clns
lat
vines 6 octets
first 4 octets are the net number
last 2 octets are the host number
cons
apollo 10 octets
first 4 octets are the net number
last 6 octets are the host number
stun 8 octets
novell 10 octets
first 4 octets are the net number
last 6 octets are the host number
qllc 6 octets
bstun 1 octet - bi-sync serial tunnel
snapshot 1 octet
atmIlmi 4 octets
x25 pvc 2 octets (12 bits)
ipv6 16 octets
cdm
nbf
bgpIgx
clnsPfx upto 20 octets
http upto 70 octets
first 4 octets are the IPv4 host
address
next 2 octets are the TCP port
number
remaining(1 upto 64) octets are
the URI"
SYNTAX OCTET STRING
Unsigned64 ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"An unsigned 64 bit integer. We use SYNTAX Counter64 for the
encoding rules."
SYNTAX Counter64
InterfaceIndexOrZero ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Either the value 0, or the ifIndex value of an
interface in the ifTable."
SYNTAX Integer32 (0..2147483647 )
SAPType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Service Access Point - is a term that denotes the means
by which a user entity in layer n+1 accesses a service
of a provider entity in layer n."
SYNTAX Integer32 (0..254 )
CountryCode ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Represents a case-insensitive 2-letter country code taken
from ISO-3166. Unrecognized countries are represented as
empty string."
SYNTAX OCTET STRING (SIZE (0 | 2))
CountryCodeITU ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual convention represents a country or area code for
non-standard facilities in telematic services."
REFERENCE "ITU-T T.35 - Section 3.1 Country Code"
SYNTAX Unsigned32 (0..255 )
EntPhysicalIndexOrZero ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual convention is an extension of entPhysicalIndex.
If non-zero, the object is an entPhysicalIndex. If zero, no
appropriate entPhysicalIndex exists. Any additional semantics
are object specific."
SYNTAX Integer32 (0..2147483647 )
CiscoRowOperStatus ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Represents the operational status of an table entry.
This textual convention allows explicitly representing
the states of rows dependent on rows in other tables.
active(1) -
Indicates this entry's RowStatus is active
and the RowStatus for each dependency is active.
activeDependencies(2) -
Indicates that the RowStatus for each dependency
is active, but the entry's RowStatus is not active.
inactiveDependency(3) -
Indicates that the RowStatus for at least one
dependency is not active.
missingDependency(4) -
Indicates that at least one dependency does
not exist in it's table."
SYNTAX INTEGER {
active(1),
activeDependencies(2),
inactiveDependency(3),
missingDependency(4)
}
CiscoPort ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The TCP or UDP port number range."
REFERENCE
"Transmission Control Protocol. J. Postel. RFC793,
User Datagram Protocol. J. Postel. RFC768"
SYNTAX Integer32 (0..65535 )
CiscoIpProtocol ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"IP protocol number range."
REFERENCE "Internet Protocol. J. Postel. RFC791"
SYNTAX Integer32 (0..255 )
CiscoLocationClass ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"An enumerated value which provides an indication of
the general location type of a particular physical and/or
logical interface.
chassis - a system framework for mounting one or more
shelves/slots/cards.
shelf - a cabinet that holds one or more slots.
slot - card or subSlot holder.
subSlot - daughter-card holder.
port - a physical port (e.g., a DS1 or DS3 physical port).
subPort - a logical port on a physical port (e.g., a DS1
subPort on a DS3 physical port).
channel - a logical interface (e.g., a DS0 channel, signaling
channel, ATM port, other virtual interfaces).
subChannel - a sub-channel on a logical interface."
SYNTAX INTEGER {
chassis(1),
shelf(2),
slot(3),
subSlot(4),
port(5),
subPort(6),
channel(7),
subChannel(8)
}
CiscoLocationSpecifier ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Use this TC to define objects that indicate the
physical entity and/or logical interface location
of a managed entity on a managed device. In SNMP, a
standard mechanism for indicating the physical location
of entities is via the ENTITY-MIB. However, that approach
is not satisfactory in some cases because:
1. The entity requiring a location-based naming may be
associated with an entity which can not be represented
as a physical entity in the ENTITY-MIB,
2. NMS applications may desire a more direct
name/representation of a physical entity than is
available via the ENTITY-MIB, e.g., a physical entity
which is named via a hierarchy of levels in the ENTITY-MIB.
The value of an object defined using this TC is an ASCII
string consisting of zero or more elements separated by
commas. Each element is of the form = .
An example of this syntax is 'slot=5,port=3'.
The syntax of the string is formally specified using
ABNF notation (with one exception, noted below), as
follows:
location-specifier = elem *(',' elem)
; subject to
; size restriction specified in the SYNTAX
; clause below
elem = loctype '=' number
number = %x00-FFFFFFFF / %d0-4294967295
loctype = 1*32VCHAR
It is recommended that loctype use one of the enumerated
labels defined for CiscoLocationClass.
(NOTE: To conform to ABNF notation as defined in RFC2234,
substitute the single-quote symbol with a double-quote
symbol in the above rules.)
A zero length of CiscoLocationSpecifier is object-specific
and must be defined as part of the description of any object
which uses this syntax."
REFERENCE
"RFC2234, Augmented BNF for syntax specifications: ABNF"
SYNTAX OCTET STRING (SIZE (0..255))
CiscoInetAddressMask ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Denotes a generic Internet subnet address mask.
The Internet subnet address mask is represented as the
number of contiguous 1-bit from MSB (most significant bit)
of the Internet subnet address mask.
A CiscoInetAddressMask value is always interpreted within
the context of an InetAddressType value. The
InetAddressType only object or InetAddressType with
InetAddress objects which define the context must be
registered immediately before the object which uses the
CiscoInetAddressMask textual convention. In other words,
the object identifiers for the InetAddressType object and
the CiscoInetAddressMask object MUST have the same length
and the last sub-identifier of the InetAddressType object
MUST be 1 less than the last sub-identifier of the
CiscoInetAddressMask object and MUST be 2 less than the
last sub-identifier of the CiscoInetAddressMask object if
an InetAddress object is defined between InetAddressType
and CiscoInetAddressMask objects.
The maximum value of the CiscoInetAddressMask TC is 32 for
the value 'ipv4(1)' in InetAddressType object and 128 for
the value 'ipv6(2)' in InetAddressType object.
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 Internet subnet mask was unknown,
or when none subnet masks need to be referenced."
REFERENCE
"RFC2851, Textual Conventions for Internet Network Addresses."
SYNTAX Unsigned32 (0..128 )
CiscoAbsZeroBasedCounter32 ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This TC describes an object which counts events with the
following semantics: objects of this type will be set to
zero(0) on creation and will thereafter count appropriate
events, it locks at the maximum value of 4,294,967,295 if
the counter overflows.
This TC may be used only in situations where wrapping is
not possible or extremely unlikely situation."
SYNTAX Gauge32
CiscoSnapShotAbsCounter32 ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This TC describes an object which stores a snap-shot value
with the following semantics: objects of this type will
take a snap-shot value from their associated
CiscoAbsZeroBasedCounter32 type objects on creation."
SYNTAX Unsigned32
CiscoAlarmSeverity ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Represents the perceived alarm severity associated
with a service or safety affecting condition and/or
event. These are based on ITU severities, except
that info(7) is added.
cleared(1) -
Indicates a previous alarm condition has been
cleared. It is not required (unless specifically
stated elsewhere on a case by case basis) that an
alarm condition that has been cleared will produce
a notification or other event containing an
alarm severity with this value.
indeterminate(2) -
Indicates that the severity level cannot be
determined.
critical(3) -
Indicates that a service or safety affecting
condition has occurred and an immediate
corrective action is required.
major(4) -
Indicates that a service affecting condition has
occurred and an urgent corrective action is
required.
minor(5) -
Indicates the existence of a non-service affecting
condition and that corrective action should be
taken in order to prevent a more serious (for
example, service or safety affecting) condition.
warning(6) -
Indicates the detection of a potential or impending
service or safety affecting condition, before any
significant effects have been felt.
info(7) -
Indicates an alarm condition that does not
meet any other severity definition. This can
include important, but non-urgent, notices or
informational events."
REFERENCE "ITU-X.733"
SYNTAX INTEGER {
cleared(1),
indeterminate(2),
critical(3),
major(4),
minor(5),
warning(6),
info(7)
}
PerfHighIntervalCount ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"A 64 bit counter associated with a
performance measurement in a previous
15 minute measurement interval. In the
case where the agent has no valid data
available for a particular interval the
corresponding object instance is not
available and upon a retrieval request
a corresponding error message shall be
returned to indicate that this instance
does not exist (for example, a noSuchName
error for SNMPv1 and a noSuchInstance for
SNMPv2 GET operation).
In a system supporting
a history of n intervals with
IntervalCount(1) and IntervalCount(n) the
most and least recent intervals
respectively, the following applies at
the end of a 15 minute interval:
- discard the value of IntervalCount(n)
- the value of IntervalCount(i) becomes that
of IntervalCount(i-1) for n >= i > 1
- the value of IntervalCount(1) becomes that
of CurrentCount
- the TotalCount, if supported, is adjusted.
This definition is based on CounterBasedGauge64 TEXTUAL
CONVENTION defined in RFC2856. The PerfHighIntervalCount
type represents a non-negative
integer, which may increase or decrease, but shall never
exceed a maximum value, nor fall below a minimum value. The
maximum value can not be greater than 2^64-1
(18446744073709551615 decimal), and the minimum value can
not be smaller than 0. The value of a PerfHighIntervalCount,
has its maximum value whenever the information being modeled
is greater than or equal to its maximum value, and has its
minimum value whenever the information being modeled is
smaller than or equal to its minimum value. If the
information being modeled subsequently decreases below
(increases above) the maximum (minimum) value, the
PerfHighIntervalCount also decreases (increases).
Note that this TC is not strictly supported in SMIv2,
because the 'always increasing' and 'counter wrap' semantics
associated with the Counter64 base type are not preserved.
It is possible that management applications which rely
solely upon the (Counter64) ASN.1 tag to determine object
semantics will mistakenly operate upon objects of this type
as they would for Counter64 objects.
This textual convention represents a limited and short-term
solution, and may be deprecated as a long term solution is
defined and deployed to replace it."
REFERENCE
"RFC 2856(HCNUM-TC MIB).
RFC 2493(PerfHist-TC-MIB)."
SYNTAX Counter64
ConfigIterator ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This object type is a control object type which applies to
writable objects in the same SNMP PDU related to the
same table containing those objects. It controls an
operation which repeatedly applies the specified
configuration data to more than one rows in a table.
The operation starts from the row specified by the index
of the instance and repeats for the number of rows as
the value of the object.
ConfigIterator object needs to be accompanied by one set of
writable objects which are of the same instance to apply to.
For example, a SNMP PDU contains
{ objectA.10 = 1,
objectB.10 = 'E1',
objectC.10 = 44,
objectRepetition.10 = 100 }
The SYNTAX of objectRepetition is ConfigIterator.
This will apply value 1 to objectA, value 'E1' to objectB,
value 44 to objectC in the table starting from row 10
repeatedly for 100 rows.
The iteration is based on the number of rows, not based on
the value of the index. For sparse tables, the index 10,
20, 30, 110, and 120 counts for 5 rows, the operation will
go beyond index 100 in the previous SNMP PDU example.
The iteration will stop prematurely when it comes to the
following situations:
(1) When the number of the rows in the table is less than
the designated row indicated by the ConfigIterator
object.
(2) When it encounters the first error in any row, the
operation won't continue to next row.
The operation of ConfigIterator object applies only to
the writable objects having the same index as the
ConfigIterator object in one SNMP PDU.
For example, a SNMP PDU contains
{ objectD.5 = 38,
objectE.6 = 'T1',
objectF.5 = 'false',
objectIterator.5 = 10 }
The SYNTAX of objectIterator is ConfigIterator.
This will apply value 38 to objectD, value 'false' to
objectF in the table starting from row 5 repeatedly
for 10 rows. Since the object objectE.6 has different
index (6) from the index of objectIterator, the
repetition won't be applied to it. However the value
of objectE in the row 6 will be set to 'T1' according
to regular SNMP SET orperation.
If there is row overlapping of the iteration in a SNMP PDU,
it will be operated as they are in two different SNMP PDUs.
For example, a SNMP PDU contains
{ objectD.5 = 38,
objectD.6 = 40,
objectE.6 = 'T1',
objectF.5 = 'false',
objectIterator.5 = 10
objectIterator.6 = 10 }
This will apply value 38 to objectD, value 'false' to
objectF starting from row 5 repeatedly for 10 rows, and
apply value 40 to objectD, value 'T1' to objectE starting
from row 6 repeatedly for 10 rows. The final value of
objectD.6 can be 38 or 40, it depends on the SNMP stack of
the system starts SNMP SET for the row 5 before the row 6
or the other way around.
The object defined as ConfigIterator will be set to value 1
after the iteration operation is kick-off regardless the
system has completed the operation to the designated rows
or not. Therefore retrieving the value of this object
is meaningless. It acts as the one time operation for
bulk configuration.
The object defined as ConfigIterator has no meaning by itself,
it has to be combined with one or more than one writable
objects from the same table and within the same SNMP PDU
for the repetition operation.
For example, a SNMP PDU contains
{ objectG.2 = 49,
objectH.2 = 'AE'h
objectIterator.4 = 20 }
The SYNTAX of objectIterator is ConfigIterator. Since
there are no objects having the same index as the index
of objectIterator in the PDU, the result of this SNMP
operation will set value 49 to objectG and value 0xAE
to objectH of the row 2 only as regular SNMP SET operation.
The index of the instance indicates the starting row for the
iteration.
The order of the iteration depends, for instance, on:
(1) physical hardware position, or
(2) logical index.
It depends on the characters of the table which contains
the ConfigIterator object.
Iteration can be done through some or all the components
of the index for a table. The description of the iterator
object in that table should describe which part of the
index the iteration is applied to.
The operation for this object type is based on the best
effort. When the agent receives a SNMP PDU containing this
data type, the return status of the SNMP request reflects
only the result of the SET operation has applied to the
starting row. It may return a SNMP response with SUCCESS
status regardless the number of rows for the data actually
been deployed later on. Therefore it is possible the data
might not be completely deployed to the number of rows
designated by the ConfigIterator and the operation stops
prematurely due to an error it first encounters after
n rows (n < the value of ConfigIterator object).
Usually the error report mechanism for this type of operation
is accomplished by combining this type of object with the
other two objects in the same table:
(1) An OwnerString object
(2) An object indicates the result of the operation.
When issuing this bulk configuration request, the SNMP
manager should provide its identifier in (1) object.
After issuing the request, it should check the value of (1)
object if it is the same with it own name.
If they are the same, then the value of the object presents
in (2) is the result from the previous operation from this
manager. Otherwise, another SNMP manager might issue
the bulk configuration to the same table before the previous
bulk operation has been completed. These two objects will
represent the last bulk operation in the table."
SYNTAX Unsigned32 (1..4294967295 )
BulkConfigResult ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual convention defines the format of the
displayable textual result from the bulk configuration
operation specified as ConfigIterator type.
The format should be:
'COMPLETION= error occured>/,
ERROR=/:
'
For example:
'COMPLETION=22/100,ERROR=38/44:Invalid Ds1 line coding
for the line type'"
SYNTAX OCTET STRING (SIZE (0..255))
ListIndex ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"A unique value greater than zero, for each of the
list that is defined. The object using this
convention should give all the object specific
details including the list type."
SYNTAX Integer32 (1..2147483647 )
ListIndexOrZero ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual convention is an extension of the
ListIndex. In addition to the ListIndex range,
this also includes 0 in its range of values.
This value could be object specific and
should be given the description of that object.
In most cases, a value 0 means that the it does
not represent any lists."
SYNTAX Integer32 (0..2147483647 )
TimeIntervalSec ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"A period of time, measured in units of 1 second."
SYNTAX Unsigned32
TimeIntervalMin ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"A period of time, measured in units of 1 minute."
SYNTAX Unsigned32
CiscoMilliSeconds ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Represents time unit value in milliseconds."
SYNTAX Unsigned32
MicroSeconds ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Represents time unit value in microseconds."
SYNTAX Unsigned32
CiscoPortList ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Each octet within this value specifies a set of eight
ports. The object defined by this textual convention
can specify a port range of 2k ports in its description.
Example: 1 - 2048, 2049 - 4096, etc. The first octet
represents the first 8 ports of the range of ports
specified by the object, the second octet represents
the next 8 ports, etc. When a port range is not
specified, a default port range of '1 - 2048' is assumed.
Within each octet, the most significant bit represents
the lowest numbered port, and the least significant bit
represents the highest numbered port. Thus, each port
of the bridge is represented by a single bit within the
value of this object. If that bit has a value of '1'
then that port is included in the set of ports; the port
is not included if its bit has a value of '0'.
Note that if the length of this string is less than
256 octets, any 'missing' octets are assumed to contain
the value zero. An NMS may omit any zero-valued octets
from the end of this string in order to reduce SetPDU size,
and the agent may also omit zero-valued trailing octets,
to reduce the size of GetResponse PDUs."
SYNTAX OCTET STRING (SIZE (0..256))
CiscoPortListRange ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Indicates the port range.
oneto2K(1) indicates that the port number range is
from 1 to 2048.
twoKto4K(2) indicates that the port number range is
from 2049 to 4096.
fourKto6K(3) indicates that the port number range is
from 4097 to 6144.
sixKto8K(4) indicates that the port number range is
from 6145 to 8192.
eightKto10K(5) indicates that the port number range is
from 8193 to 10240.
tenKto12K(6) indicates that the port number range is
from 10241 to 12288.
twelveKto14K(7) indicates that the port number range is
from 12289 to 14336.
fourteenKto16K(8) indicates that the port number range is
from 14337 to 16384.
When an object is defined with this textual convention,
it must be accompanied by an object of CiscoPortList
syntax."
SYNTAX INTEGER {
oneto2k(1),
twoKto4K(2),
fourKto6K(3),
sixKto8K(4),
eightKto10K(5),
tenKto12K(6),
twelveKto14K(7),
fourteenKto16K(8)
}
IfOperStatusReason ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The cause of current operational state of the
interface.
GLOSSARY:
BB - Buffer-to-Buffer.
BB_Credit - Buffer-to-Buffer credit, a link level flow
control mechanism.
B_Port - A Fibre Channel, Bridging port.
Class F - A connectionless service with notification on
non-delivery between E_Ports, used for control,
coordination, and configuration of the Fabric.
Class N - Refers to any class of service (different types
of frame delivery services) other than Class F.
E_D_TOV - Error Detect Timeout Value.
ELP - Exchange Link Parameter.
E-mode - A fibre channel port providing E_Port
functionality.
E_Port - A Fabric Expansion Port.
EPP - Exchange Peer Parameters.
ESC - Exchange Switch Capabilities.
Fabric - The set of physically connected fibre channel
switches.
FC-FS - Fibre Channel Framing and Signaling.
FCIP - Fibre Channel over IP protocol.
FCOT - Fibre channel optical transmitter.
FC-PH - The Fibre Channel Physical and Signaling
standard.
FCSP - Fibre Channel Security Protocol.
Fibre Channel - The primary protocol for building SANs.
FICON - An I\O protocol used between IBM (and compatible)
mainframes and storage.
FLOGI - Fabric Login, used by a node port to establish a
session with the fabric.
GBIC - Gigabit Interface Converter; a removable
transceiver module permitting Fibre Channel and
Gigabit Ethernet physical-layer transport.
Interconnect_Ports - Switch Ports that assume either the
E_Port or B_Port mode are generally referred to
as Interconnect_Ports.
LIP - Loop Initialization Primitive sequence.
LR - Link Reset, the FC-PH defined primitive sequence
used to initiate a link reset.
NOS - Not Operational Sequence, the FC-PH defined
primitive sequence to indicate that the
transmitting port has detected a link failure (or)
offline condition.
Nx_Port - A Fiber Channel Node Port.
OLS - Offline Sequence, the FC-PH defined primitive
sequence to indicate that the port is entering
into offline state.
OHMS - Online Health Management System.
R_A_TOV - Resource Allocation Timeout Value.
RCF - Reconfigure Fabric.
Rxbbcredit - Receive BB credit value configured for
a FC interface.
SAN - Storage Area Network; a network linking computing
devices to disk or tape arrays and other devices
over Fibre Channel.
TE_Port - Trunking E_Port.
TOV - Time out value.
VSAN - Virtual Storage Area Network.
WWN - World Wide Name.
xE_Port - A Fiber channel port that can assume either
E_Port or TE_Port mode.
The enumerated values which provides the cause of the current
operational state of the interface are,
'other(1)' - reasons other than defined here.
'none(2)' - no failure.
'hwFailure(3)' - hardware failure.
'loopbackDiagFailure(4)' - loopback diagnostics failure.
'errorDisabled(5)' - the port is not operational due to
some error conditions that require administrative
attention.
'swFailure(6)' - software failure.
'linkFailure(7)' - physical link failure.
'offline(8)' - physical link is in offline state as
defined in the FC-FS standards.
'nonParticipating(9)' - during loop initialization, the
port is not allowed to participate in loop operations.
'initializing(10)' - port is being initialized.
'vsanInactive(11)'- port VSAN is inactive. The port becomes
operational again when the port VSAN is active.
'adminDown(12)' - ifAdminStatus is 'down'.