-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathENTITY-MIB.yang
1258 lines (1087 loc) · 50 KB
/
ENTITY-MIB.yang
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
/*
* This YANG module has been generated by smidump 0.5.0:
*
* smidump -f yang ENTITY-MIB
*
* Do not edit. Edit the source file instead!
*/
module ENTITY-MIB {
namespace "urn:ietf:params:xml:ns:yang:smiv2:ENTITY-MIB";
prefix "entity-mib";
import IANA-ENTITY-MIB {
prefix "iana-entity";
}
import SNMP-FRAMEWORK-MIB {
prefix "snmp-framework";
}
import SNMPv2-TC {
prefix "snmpv2-tc";
}
import UUID-TC-MIB {
prefix "uuid-tc";
}
import ietf-yang-smiv2 {
prefix "smiv2";
}
import ietf-yang-types {
prefix "yang";
}
organization
"IETF Energy Management Working Group";
contact
"WG Email: eman@ietf.org
Mailing list subscription info:
http://www.ietf.org/mailman/listinfo/eman
Andy Bierman
YumaWorks, Inc.
274 Redwood Shores Parkway, #133
Redwood City, CA 94065
USA
Phone: +1 408-716-0466
Email: andy@yumaworks.com
Dan Romascanu
Avaya
Park Atidim, Bldg. #3
Tel Aviv, 61581
Israel
Phone: +972-3-6458414
Email: dromasca@avaya.com
Juergen Quittek
NEC Europe Ltd.
Network Research Division
Kurfuersten-Anlage 36
Heidelberg 69115
Germany
Phone: +49 6221 4342-115
Email: quittek@neclab.eu
Mouli Chandramouli
Cisco Systems, Inc.
Sarjapur Outer Ring Road
Bangalore 560103
India
Phone: +91 80 4429 2409
Email: moulchan@cisco.com";
description
"The MIB module for representing multiple logical
entities supported by a single SNMP agent.
Copyright (c) 2013 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Simplified
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info).";
revision 2013-04-05 {
description
"Entity MIB (Version 4).
This revision obsoletes RFC 4133.
- Creation of a new MIB module, IANA-ENTITY-MIB, which
makes the PhysicalIndex TC an IANA-maintained TEXTUAL-
CONVENTION. IANAPhysicalClass is now imported
from the IANA-ENTITY-MIB.
- Addition of a new MIB object to the entPhysicalTable,
entPhysicalUUID. UUIDorZero is imported from the
UUID-TC-MIB.
- Addition of two new MODULE-COMPLIANCE modules-
entity4Compliance and entity4CRCompliance.
This version is published as RFC 6933.";
}
revision 2005-08-10 {
description
"Initial Version of Entity MIB (Version 3).
This revision obsoletes RFC 2737.
Additions:
- cpu(12) enumeration added to IANAPhysicalClass TC
- DISPLAY-HINT clause to PhysicalIndex TC
- PhysicalIndexOrZero TC
- entPhysicalMfgDate object
- entPhysicalUris object
Changes:
- entPhysicalContainedIn SYNTAX changed from
INTEGER to PhysicalIndexOrZero
This version was published as RFC 4133.";
}
revision 1999-12-07 {
description
"Initial Version of Entity MIB (Version 2).
This revision obsoletes RFC 2037.
This version was published as RFC 2737.";
}
revision 1996-10-31 {
description
"Initial version (version 1), published as
RFC 2037.";
}
typedef PhysicalIndex {
type int32 {
range "1..2147483647";
}
description
"An arbitrary value that uniquely identifies the physical
entity. The value should be a small positive integer.
Index values for different physical entities are not
necessarily contiguous.";
smiv2:display-hint "d";
}
typedef PhysicalIndexOrZero {
type int32 {
range "0..2147483647";
}
description
"This TEXTUAL-CONVENTION is an extension of the
PhysicalIndex convention, which defines a greater than zero
value used to identify a physical entity. This extension
permits the additional value of zero. The semantics of the
value zero are object-specific and must, therefore, be
defined as part of the description of any object that uses
this syntax. Examples of the usage of this extension are
situations where none or all physical entities need to be
referenced.";
smiv2:display-hint "d";
}
typedef SnmpEngineIdOrNone {
type binary {
length "0..32";
}
description
"A specially formatted SnmpEngineID string for use with the
Entity MIB.
If an instance of an object of SYNTAX SnmpEngineIdOrNone has
a non-zero length, then the object encoding and semantics
are defined by the SnmpEngineID TEXTUAL-CONVENTION (see STD
62, RFC 3411).
If an instance of an object of SYNTAX SnmpEngineIdOrNone
contains a zero-length string, then no appropriate
SnmpEngineID is associated with the logical entity (i.e.,
SNMPv3 is not supported).";
}
typedef PhysicalClass {
type enumeration {
enum "other" {
value "1";
}
enum "unknown" {
value "2";
}
enum "chassis" {
value "3";
}
enum "backplane" {
value "4";
}
enum "container" {
value "5";
}
enum "powerSupply" {
value "6";
}
enum "fan" {
value "7";
}
enum "sensor" {
value "8";
}
enum "module" {
value "9";
}
enum "port" {
value "10";
}
enum "stack" {
value "11";
}
enum "cpu" {
value "12";
}
}
status deprecated;
description
"Starting with version 4 of the ENTITY-MIB, this TC is
deprecated, and the usage of the IANAPhysicalClass TC from
the IANA-ENTITY-MIB is recommended instead.
An enumerated value that provides an indication of the
general hardware type of a particular physical entity.
There are no restrictions as to the number of
entPhysicalEntries of each entPhysicalClass, which must be
instantiated by an agent.
The enumeration 'other' is applicable if the physical entity
class is known but does not match any of the supported
values.
The enumeration 'unknown' is applicable if the physical
entity class is unknown to the agent.
The enumeration 'chassis' is applicable if the physical
entity class is an overall container for networking
equipment. Any class of physical entity, except a stack,
may be contained within a chassis; a chassis may only
be contained within a stack.
The enumeration 'backplane' is applicable if the physical
entity class is some sort of device for aggregating and
forwarding networking traffic, such as a shared backplane in
a modular ethernet switch. Note that an agent may model a
backplane as a single physical entity, which is actually
implemented as multiple discrete physical components (within
a chassis or stack).
The enumeration 'container' is applicable if the physical
entity class is capable of containing one or more removable
physical entities, possibly of different types. For
example, each (empty or full) slot in a chassis will be
modeled as a container. Note that all removable physical
entities should be modeled within a container entity, such
as field-replaceable modules, fans, or power supplies. Note
that all known containers should be modeled by the agent,
including empty containers.
The enumeration 'powerSupply' is applicable if the physical
entity class is a power-supplying component.
The enumeration 'fan' is applicable if the physical entity
class is a fan or other heat-reduction component.
The enumeration 'sensor' is applicable if the physical
entity class is some sort of sensor, such as a temperature
sensor within a router chassis.
The enumeration 'module' is applicable if the physical
entity class is some sort of self-contained sub-system. If
the enumeration 'module' is removable, then it should be
modeled within a container entity; otherwise, it should be
modeled directly within another physical entity (e.g., a
chassis or another module).
The enumeration 'port' is applicable if the physical entity
class is some sort of networking port capable of receiving
and/or transmitting networking traffic.
The enumeration 'stack' is applicable if the physical entity
class is some sort of super-container (possibly virtual)
intended to group together multiple chassis entities. A
stack may be realized by a 'virtual' cable, a real
interconnect cable, attached to multiple chassis, or may in
fact be comprised of multiple interconnect cables. A stack
should not be modeled within any other physical entities,
but a stack may be contained within another stack. Only
chassis entities should be contained within a stack.
The enumeration 'cpu' is applicable if the physical entity
class is some sort of central processing unit.";
}
container ENTITY-MIB {
config false;
container entityGeneral {
smiv2:oid "1.3.6.1.2.1.47.1.4";
leaf entLastChangeTime {
type yang:timestamp;
description
"The value of sysUpTime at the time a conceptual row is
created, modified, or deleted in any of these tables:
- entPhysicalTable
- entLogicalTable
- entLPMappingTable
- entAliasMappingTable
- entPhysicalContainsTable";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.4.1";
}
}
container entPhysicalTable {
description
"This table contains one row per physical entity. There is
always at least one row for an 'overall' physical entity.";
smiv2:oid "1.3.6.1.2.1.47.1.1.1";
list entPhysicalEntry {
key "entPhysicalIndex";
description
"Information about a particular physical entity.
Each entry provides objects (entPhysicalDescr,
entPhysicalVendorType, and entPhysicalClass) to help an NMS
identify and characterize the entry and objects
(entPhysicalContainedIn and entPhysicalParentRelPos) to help
an NMS relate the particular entry to other entries in this
table.";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1";
leaf entPhysicalIndex {
type entity-mib:PhysicalIndex;
description
"The index for this entry.";
smiv2:max-access "not-accessible";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.1";
}
leaf entPhysicalDescr {
type snmp-framework:SnmpAdminString;
description
"A textual description of physical entity. This object
should contain a string that identifies the manufacturer's
name for the physical entity and should be set to a
distinct value for each version or model of the physical
entity.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.2";
}
leaf entPhysicalVendorType {
type snmpv2-tc:AutonomousType;
description
"An indication of the vendor-specific hardware type of the
physical entity. Note that this is different from the
definition of MIB-II's sysObjectID.
An agent should set this object to an enterprise-specific
registration identifier value indicating the specific
equipment type in detail. The associated instance of
entPhysicalClass is used to indicate the general type of
hardware device.
If no vendor-specific registration identifier exists for
this physical entity, or the value is unknown by this agent,
then the value { 0 0 } is returned.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.3";
}
leaf entPhysicalContainedIn {
type entity-mib:PhysicalIndexOrZero;
description
"The value of entPhysicalIndex for the physical entity that
'contains' this physical entity. A value of zero indicates
this physical entity is not contained in any other physical
entity. Note that the set of 'containment' relationships
define a strict hierarchy; that is, recursion is not
allowed.
In the event that a physical entity is contained by more
than one physical entity (e.g., double-wide modules), this
object should identify the containing entity with the lowest
value of entPhysicalIndex.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.4";
}
leaf entPhysicalClass {
type iana-entity:IANAPhysicalClass;
description
"An indication of the general hardware type of the physical
entity.
An agent should set this object to the standard enumeration
value that most accurately indicates the general class of
the physical entity, or the primary class if there is more
than one entity.
If no appropriate standard registration identifier exists
for this physical entity, then the value 'other(1)' is
returned. If the value is unknown by this agent, then the
value 'unknown(2)' is returned.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.5";
}
leaf entPhysicalParentRelPos {
type int32 {
range "-1..2147483647";
}
description
"An indication of the relative position of this 'child'
component among all its 'sibling' components. Sibling
components are defined as entPhysicalEntries that share the
same instance values of each of the entPhysicalContainedIn
and entPhysicalClass objects.
An NMS can use this object to identify the relative ordering
for all sibling components of a particular parent
(identified by the entPhysicalContainedIn instance in each
sibling entry).
If possible, this value should match any external labeling
of the physical component. For example, for a container
(e.g., card slot) labeled as 'slot #3',
entPhysicalParentRelPos should have the value '3'. Note
that the entPhysicalEntry for the module plugged in slot 3
should have an entPhysicalParentRelPos value of '1'.
If the physical position of this component does not match
any external numbering or clearly visible ordering, then
user documentation or other external reference material
should be used to determine the parent-relative position.
If this is not possible, then the agent should assign a
consistent (but possibly arbitrary) ordering to a given set
of 'sibling' components, perhaps based on internal
representation of the components.
If the agent cannot determine the parent-relative position
for some reason, or if the associated value of
entPhysicalContainedIn is '0', then the value '-1' is
returned. Otherwise, a non-negative integer is returned,
indicating the parent-relative position of this physical
entity.
Parent-relative ordering normally starts from '1' and
continues to 'N', where 'N' represents the highest
positioned child entity. However, if the physical entities
(e.g., slots) are labeled from a starting position of zero,
then the first sibling should be associated with an
entPhysicalParentRelPos value of '0'. Note that this
ordering may be sparse or dense, depending on agent
implementation.
The actual values returned are not globally meaningful, as
each 'parent' component may use different numbering
algorithms. The ordering is only meaningful among siblings
of the same parent component.
The agent should retain parent-relative position values
across reboots, either through algorithmic assignment or use
of non-volatile storage.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.6";
}
leaf entPhysicalName {
type snmp-framework:SnmpAdminString;
description
"The textual name of the physical entity. The value of this
object should be the name of the component as assigned by
the local device and should be suitable for use in commands
entered at the device's 'console'. This might be a text
name (e.g., 'console') or a simple component number (e.g.,
port or module number, such as '1'), depending on the
physical component naming syntax of the device.
If there is no local name, or if this object is otherwise
not applicable, then this object contains a zero-length
string.
Note that the value of entPhysicalName for two physical
entities will be the same in the event that the console
interface does not distinguish between them, e.g., slot-1
and the card in slot-1.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.7";
}
leaf entPhysicalHardwareRev {
type snmp-framework:SnmpAdminString;
description
"The vendor-specific hardware revision string for the
physical entity. The preferred value is the hardware
revision identifier actually printed on the component itself
(if present).
Note that if revision information is stored internally in a
non-printable (e.g., binary) format, then the agent must
convert such information to a printable format in an
implementation-specific manner.
If no specific hardware revision string is associated with
the physical component, or if this information is unknown to
the agent, then this object will contain a zero-length
string.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.8";
}
leaf entPhysicalFirmwareRev {
type snmp-framework:SnmpAdminString;
description
"The vendor-specific firmware revision string for the
physical entity.
Note that if revision information is stored internally in a
non-printable (e.g., binary) format, then the agent must
convert such information to a printable format in an
implementation-specific manner.
If no specific firmware programs are associated with the
physical component, or if this information is unknown to the
agent, then this object will contain a zero-length string.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.9";
}
leaf entPhysicalSoftwareRev {
type snmp-framework:SnmpAdminString;
description
"The vendor-specific software revision string for the
physical entity.
Note that if revision information is stored internally in a
non-printable (e.g., binary) format, then the agent must
convert such information to a printable format in an
implementation-specific manner.
If no specific software programs are associated with the
physical component, or if this information is unknown to the
agent, then this object will contain a zero-length string.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.10";
}
leaf entPhysicalSerialNum {
type snmp-framework:SnmpAdminString {
length "0..32";
}
description
"The vendor-specific serial number string for the physical
entity. The preferred value is the serial number string
actually printed on the component itself (if present).
On the first instantiation of a physical entity, the value
of entPhysicalSerialNum associated with that entity is set
to the correct vendor-assigned serial number, if this
information is available to the agent. If a serial number
is unknown or non-existent, the entPhysicalSerialNum will be
set to a zero-length string instead.
Note that implementations that can correctly identify the
serial numbers of all installed physical entities do not
need to provide write access to the entPhysicalSerialNum
object. Agents that cannot provide non-volatile storage
for the entPhysicalSerialNum strings are not required to
implement write access for this object.
Not every physical component will have a serial number, or
even need one. Physical entities for which the associated
value of the entPhysicalIsFRU object is equal to 'false(2)'
(e.g., the repeater ports within a repeater module) do not
need their own unique serial numbers. An agent does not
have to provide write access for such entities and may
return a zero-length string.
If write access is implemented for an instance of
entPhysicalSerialNum and a value is written into the
instance, the agent must retain the supplied value in the
entPhysicalSerialNum instance (associated with the same
physical entity) for as long as that entity remains
instantiated. This includes instantiations across all
re-initializations/reboots of the network management system,
including those resulting in a change of the physical
entity's entPhysicalIndex value.";
smiv2:max-access "read-write";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.11";
}
leaf entPhysicalMfgName {
type snmp-framework:SnmpAdminString;
description
"The name of the manufacturer of this physical component.
The preferred value is the manufacturer name string actually
printed on the component itself (if present).
Note that comparisons between instances of the
entPhysicalModelName, entPhysicalFirmwareRev,
entPhysicalSoftwareRev, and the entPhysicalSerialNum
objects are only meaningful amongst entPhysicalEntries with
the same value of entPhysicalMfgName.
If the manufacturer name string associated with the physical
component is unknown to the agent, then this object will
contain a zero-length string.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.12";
}
leaf entPhysicalModelName {
type snmp-framework:SnmpAdminString;
description
"The vendor-specific model name identifier string associated
with this physical component. The preferred value is the
customer-visible part number, which may be printed on the
component itself.
If the model name string associated with the physical
component is unknown to the agent, then this object will
contain a zero-length string.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.13";
}
leaf entPhysicalAlias {
type snmp-framework:SnmpAdminString {
length "0..32";
}
description
"This object is an 'alias' name for the physical entity, as
specified by a network manager, and provides a non-volatile
'handle' for the physical entity.
On the first instantiation of a physical entity, the value
of entPhysicalAlias associated with that entity is set to
the zero-length string. However, the agent may set the
value to a locally unique default value, instead of a
zero-length string.
If write access is implemented for an instance of
entPhysicalAlias and a value is written into the instance,
the agent must retain the supplied value in the
entPhysicalAlias instance (associated with the same physical
entity) for as long as that entity remains instantiated.
This includes instantiations across all
re-initializations/reboots of the network management system,
including those resulting in a change of the physical
entity's entPhysicalIndex value.";
smiv2:max-access "read-write";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.14";
}
leaf entPhysicalAssetID {
type snmp-framework:SnmpAdminString {
length "0..32";
}
description
"This object is a user-assigned asset tracking identifier
(as specified by a network manager) for the physical entity
and provides non-volatile storage of this information.
On the first instantiation of a physical entity, the value
of entPhysicalAssetID associated with that entity is set to
the zero-length string.
Not every physical component will have an asset tracking
identifier or even need one. Physical entities for which
the associated value of the entPhysicalIsFRU object is equal
to 'false(2)' (e.g., the repeater ports within a repeater
module) do not need their own unique asset tracking
identifier. An agent does not have to provide write access
for such entities and may instead return a zero-length
string.
If write access is implemented for an instance of
entPhysicalAssetID and a value is written into the
instance, the agent must retain the supplied value in the
entPhysicalAssetID instance (associated with the same
physical entity) for as long as that entity remains
instantiated. This includes instantiations across all
re-initializations/reboots of the network management system,
including those resulting in a change of the physical
entity's entPhysicalIndex value.
If no asset tracking information is associated with the
physical component, then this object will contain a
zero-length string.";
smiv2:max-access "read-write";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.15";
}
leaf entPhysicalIsFRU {
type boolean;
description
"This object indicates whether or not this physical entity
is considered a 'field replaceable unit' by the vendor.
If this object contains the value 'true(1)', then this
entPhysicalEntry identifies a field replaceable unit. For
all entPhysicalEntries that represent components
permanently contained within a field replaceable unit, the
value 'false(2)' should be returned for this object.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.16";
}
leaf entPhysicalMfgDate {
type snmpv2-tc:DateAndTime;
description
"This object contains the date of manufacturing of the
managed entity. If the manufacturing date is unknown or
not supported, the object is not instantiated. The special
value '0000000000000000'H may also be returned in this
case.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.17";
}
leaf entPhysicalUris {
type binary;
description
"This object contains identification
information about the physical entity. The object
contains URIs; therefore, the syntax of this object
must conform to RFC 3986, Section 3.
Multiple URIs may be present and are separated by white
space characters. Leading and trailing white space
characters are ignored.
If no URI identification information is known
about the physical entity, the object is not
instantiated. A zero-length octet string may also be
returned in this case.";
reference
"RFC 3986, Uniform Resource Identifiers (URI): Generic
Syntax, Section 2, August 1998.";
smiv2:max-access "read-write";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.18";
}
leaf entPhysicalUUID {
type uuid-tc:UUIDorZero;
description
"This object contains identification information
about the physical entity. The object contains a
Universally Unique Identifier, the syntax of this object
must conform to RFC 4122, Section 4.1.
A zero-length octet string is returned if no UUID
information is known.";
reference
"RFC 4122, A Universally Unique IDentifier (UUID) URN
Namespace, Section 4.1, July 2005.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.1.1.1.19";
}
}
}
container entLogicalTable {
description
"This table contains one row per logical entity. For agents
that implement more than one naming scope, at least one
entry must exist. Agents that instantiate all MIB objects
within a single naming scope are not required to implement
this table.";
smiv2:oid "1.3.6.1.2.1.47.1.2.1";
list entLogicalEntry {
key "entLogicalIndex";
description
"Information about a particular logical entity. Entities
may be managed by this agent or other SNMP agents (possibly)
in the same chassis.";
smiv2:oid "1.3.6.1.2.1.47.1.2.1.1";
leaf entLogicalIndex {
type int32 {
range "1..2147483647";
}
description
"The value of this object uniquely identifies the logical
entity. The value should be a small positive integer; index
values for different logical entities are not necessarily
contiguous.";
smiv2:max-access "not-accessible";
smiv2:oid "1.3.6.1.2.1.47.1.2.1.1.1";
}
leaf entLogicalDescr {
type snmp-framework:SnmpAdminString;
description
"A textual description of the logical entity. This object
should contain a string that identifies the manufacturer's
name for the logical entity and should be set to a distinct
value for each version of the logical entity.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.2.1.1.2";
}
leaf entLogicalType {
type snmpv2-tc:AutonomousType;
description
"An indication of the type of logical entity. This will
typically be the OBJECT IDENTIFIER name of the node in the
SMI's naming hierarchy that represents the major MIB
module, or the majority of the MIB modules, supported by the
logical entity. For example:
a logical entity of a regular host/router -> mib-2
a logical entity of a 802.1d bridge -> dot1dBridge
a logical entity of a 802.3 repeater -> snmpDot3RptrMgmt
If an appropriate node in the SMI's naming hierarchy cannot
be identified, the value 'mib-2' should be used.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.2.1.1.3";
}
leaf entLogicalCommunity {
type binary {
length "0..255";
}
status deprecated;
description
"An SNMPv1 or SNMPv2c community string, which can be used to
access detailed management information for this logical
entity. The agent should allow read access with this
community string (to an appropriate subset of all managed
objects) and may also return a community string based on the
privileges of the request used to read this object. Note
that an agent may return a community string with read-only
privileges, even if this object is accessed with a
read-write community string. However, the agent must take
care not to return a community string that allows more
privileges than the community string used to access this
object.
A compliant SNMP agent may wish to conserve naming scopes by
representing multiple logical entities in a single 'default'
naming scope. This is possible when the logical entities,
represented by the same value of entLogicalCommunity, have
no object instances in common. For example, 'bridge1' and
'repeater1' may be part of the main naming scope, but at
least one additional community string is needed to represent
'bridge2' and 'repeater2'.
Logical entities 'bridge1' and 'repeater1' would be
represented by sysOREntries associated with the 'default'
naming scope.
For agents not accessible via SNMPv1 or SNMPv2c, the value
of this object is the empty string. This object may also
contain an empty string if a community string has not yet
been assigned by the agent or if no community string with
suitable access rights can be returned for a particular SNMP
request.
Note that this object is deprecated. Agents that implement
SNMPv3 access should use the entLogicalContextEngineID and
entLogicalContextName objects to identify the context
associated with each logical entity. SNMPv3 agents may
return a zero-length string for this object or may continue
to return a community string (e.g., tri-lingual agent
support).";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.2.1.1.4";
}
leaf entLogicalTAddress {
type snmpv2-tc:TAddress;
description
"The transport service address by which the logical entity
receives network management traffic, formatted according to
the corresponding value of entLogicalTDomain.
For snmpUDPDomain, a TAddress is 6 octets long: the initial
4 octets contain the IP-address in network-byte order, and
the last 2 contain the UDP port in network-byte order.
Consult RFC 3417 for further information on snmpUDPDomain.";
reference
"Transport Mappings for the Simple Network Management
Protocol (SNMP), STD 62, RFC 3417.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.2.1.1.5";
}
leaf entLogicalTDomain {
type snmpv2-tc:TDomain;
description
"Indicates the kind of transport service by which the
logical entity receives network management traffic.
Possible values for this object are presently found in
RFC 3417.";
reference
"Transport Mappings for the Simple Network Management
Protocol (SNMP), STD 62, RFC 3417.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.2.1.1.6";
}
leaf entLogicalContextEngineID {
type entity-mib:SnmpEngineIdOrNone;
description
"The authoritative contextEngineID that can be used to send
an SNMP message concerning information held by this logical
entity to the address specified by the associated
'entLogicalTAddress/entLogicalTDomain' pair.
This object, together with the associated
entLogicalContextName object, defines the context associated
with a particular logical entity and allows access to SNMP
engines identified by a contextEngineID and contextName
pair.
If no value has been configured by the agent, a zero-length
string is returned, or the agent may choose not to
instantiate this object at all.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.2.1.1.7";
}
leaf entLogicalContextName {
type snmp-framework:SnmpAdminString;
description
"The contextName that can be used to send an SNMP message
concerning information held by this logical entity to the
address specified by the associated
'entLogicalTAddress/entLogicalTDomain' pair.
This object, together with the associated
entLogicalContextEngineID object, defines the context
associated with a particular logical entity and allows
access to SNMP engines identified by a contextEngineID and
contextName pair.
If no value has been configured by the agent, a zero-length
string is returned, or the agent may choose not to
instantiate this object at all.";
smiv2:max-access "read-only";
smiv2:oid "1.3.6.1.2.1.47.1.2.1.1.8";
}
}
}
container entLPMappingTable {
description
"This table contains zero or more rows of logical entity to
physical equipment associations. For each logical entity
known by this agent, there are zero or more mappings to the
physical resources, which are used to realize that logical
entity.
An agent should limit the number and nature of entries in
this table such that only meaningful and non-redundant
information is returned. For example, in a system that
contains a single power supply, mappings between logical
entities and the power supply are not useful and should not
be included.
Also, only the most appropriate physical component, which is
closest to the root of a particular containment tree, should
be identified in an entLPMapping entry.
For example, suppose a bridge is realized on a particular
module, and all ports on that module are ports on this
bridge. A mapping between the bridge and the module would
be useful, but additional mappings between the bridge and
each of the ports on that module would be redundant (because
the entPhysicalContainedIn hierarchy can provide the same
information). On the other hand, if more than one bridge
were utilizing ports on this module, then mappings between
each bridge and the ports it used would be appropriate.
Also, in the case of a single backplane repeater, a mapping
for the backplane to the single repeater entity is not
necessary.";
smiv2:oid "1.3.6.1.2.1.47.1.3.1";
list entLPMappingEntry {
key "entLogicalIndex entLPPhysicalIndex";
description
"Information about a particular logical-entity-to-physical-
equipment association. Note that the nature of the
association is not specifically identified in this entry.