forked from YangModels/yang
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathieee802-dot1ab-lldp.yang
1509 lines (1340 loc) · 53.7 KB
/
ieee802-dot1ab-lldp.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
module ieee802-dot1ab-lldp {
yang-version 1.1;
/*** NAMESPACE / PREFIX DEFINITION ***/
namespace "urn:ieee:std:802.1AB:yang:ieee802-dot1ab-lldp";
prefix "lldp";
/*** LINKAGE (IMPORTS / INCLUDES) ***/
import ietf-routing { prefix "rt"; }
import ietf-yang-types { prefix "yang"; }
import ietf-interfaces { prefix "if"; }
import ieee802-dot1q-bridge { prefix "dot1q"; }
import ieee802-types { prefix "ieee"; }
import iana-if-type { prefix "ianaift"; }
/*** META INFORMATION ***/
organization
"Ericsson AB";
contact
"Web URL: https://www.ericsson.com
Contact: Chin Chen
E-mail: chin.chen@ericsson.com";
description
"Management Information Base module for LLDP configuration,
statistics, local system data and remote systems data
components.
This experimental YANG module is an individual contribution, and
does not represent a formally sanctioned YANG module of IEEE.
Therefore, this YANG module will change in incompatible ways
from its current revision to the formally published YANG
module for IEEE Std 802.1AB-2016.";
revision 2018-01-22 {
description
"Replace augment to bridge with the reference.";
reference
"IEEE Std 802.1AB-2016";
}
revision 2017-06-26 {
description
"Module for IEEE Std 802.1AB-2016";
reference
"IEEE Std 802.1AB-2016";
}
/*** TYPE DEFINITIONS ***/
typedef bridge-ref {
type leafref {
path "/dot1q:bridges/dot1q:bridge/dot1q:name";
}
description
"This type is used by data models that need to reference
a configured Bridge.";
}
typedef port-ref {
type leafref {
path "/lldp:lldp/lldp:port/lldp:name";
}
description
"This type is used by data models that need to reference port.";
}
typedef chassis-id-subtype {
type enumeration {
enum chassis-component {
value 1;
description
"The subtype 'chassis-component(1)' represents a chassis
identifier based on the value of entPhysicalAlias object
(defined in IETF RFC 2737) for a chassis component (i.e.,
an entPhysicalClass value of 'chassis(3)').";
}
enum interface-alias {
value 2;
description
"The subtype 'interface-alias(2)' represents a chassis
identifier based on the value of ifAlias object
(defined in IETF RFC 2863) for an interface on the
containing chassis.";
}
enum port-component {
value 3;
description
"The subtype 'port-component(3)' represents a chassis
identifier based on the value of entPhysicalAlias
object (defined in IETF RFC 2737) for a port or backplane
component (i.e., entPhysicalClass value of 'port(10)' or
'backplane(4)'), within the containing chassis.";
}
enum mac-address {
value 4;
description
"The subtype 'mac-address(4)' represents a chassis
identifier based on the value of a unicast source
address (encoded in network byte order and IEEE 802.3
canonical bit order), of a port on the containing
chassis as defined in IEEE Std 802-2001.";
}
enum network-address {
value 5;
description
"The subtype 'network-address(5)' represents a chassis
identifier based on a network address, associated with
a particular chassis. The encoded address is actually
composed of two fields. The first field is a single octet,
representing the IANA address-family value for the
specific address type, and the second field is the network
address value.";
}
enum interface-name {
value 6;
description
"The enumeration 'interface-name(6)' represents a chassis
identifier based on the value of ifName object (defined in
IETF RFC 2863) for an interface on the containing chassis.";
}
enum local {
value 7;
description
"The enumeration 'local(7)' represents a chassis identifier
based on a locally defined value.";
}
}
description
"This is the subtype of chassis identifier used in the LLDP MIB.";
reference
"IEEE Std 802.1AB-2016: 8.5.2.2";
}
typedef chassis-id-type {
type binary {
length "1..255";
}
description
"This TC describes the format of a chassis identifier string.
Objects of this type are always used with an associated
chassis-id-subtype object, which identifies the format of
the particular chassis-id object instance.
If the associated chassis-id-subtype object has a value of
'chassis-component(1)', then the octet string identifies
a particular instance of the entPhysicalAlias object
(defined in IETF RFC 2737) for a chassis component (i.e.,
an entPhysicalClass value of 'chassis(3)').
If the associated chassis-id-subtype object has a value
of 'interface-alias(2)', then the octet string identifies
a particular instance of the ifAlias object (defined in
IETF RFC 2863) for an interface on the containing chassis.
If the particular ifAlias object does not contain any values,
another chassis identifier type should be used.
If the associated chassis-id-subtype object has a value
of 'port-component(3)', then the octet string identifies a
particular instance of the entPhysicalAlias object (defined
in IETF RFC 2737) for a port or backplane component within
the containing chassis.
If the associated chassis-id-subtype object has a value of
'mac-address(4)', then this string identifies a particular
unicast source address (encoded in network byte order and
IEEE 802.3 canonical bit order), of a port on the containing
chassis as defined in IEEE Std 802-2001.
If the associated chassis-id-subtype object has a value of
'network-address(5)', then this string identifies a particular
network address, encoded in network byte order, associated
with one or more ports on the containing chassis. The first
octet contains the IANA Address Family Numbers enumeration
value for the specific address type, and octets 2 through
N contain the network address value in network byte order.
If the associated chassis-id-subtype object has a value
of 'interface-name(6)', then the octet string identifies
a particular instance of the ifName object (defined in
IETF RFC 2863) for an interface on the containing chassis.
If the particular ifName object does not contain any values,
another chassis identifier type should be used.
If the associated chassis-id-subtype object has a value of
'local(7)', then this string identifies a locally assigned
Chassis ID.";
reference
"IEEE Std 802.1AB-2016: 8.5.2.3";
}
typedef port-id-subtype {
type enumeration {
enum interface-alias {
value 1;
description
"The subtype 'interface-alias(1)' represents a port
identifier based on the ifAlias MIB object, defined in IETF
RFC 2863.";
}
enum port-component {
value 2;
description
"The subtype 'port-component(2)' represents a port
identifier based on the value of entPhysicalAlias (defined in
IETF RFC 2737) for a port component (i.e., entPhysicalClass
value of 'port(10)'), within the containing chassis.";
}
enum mac-address {
value 3;
description
"The subtype 'mac-address(3)' represents a port identifier
based on a unicast source address (encoded in network
byte order and IEEE 802.3 canonical bit order), which has
been detected by the agent and associated with a particular
port (IEEE Std 802-2001).";
}
enum network-address {
value 4;
description
"The subtype 'network-address(4)' represents a port
identifier based on a network address, detected by the agent
and associated with a particular port.";
}
enum interface-name {
value 5;
description
"The subtype 'interface-name(5)' represents a port
identifier based on the ifName MIB object, defined in IETF
RFC 2863.";
}
enum agent-circuit-id {
value 6;
description
"The subtype 'agent-circuit-id(6)' represents a port
identifier based on the agent-local identifier of the circuit
(defined in RFC 3046), detected by the agent and associated
with a particular port.";
}
enum local {
value 7;
description
"The subtype 'local(7)' represents a port identifier
based on a value locally assigned.";
}
}
description
"This is the subtype of port identifier used in the LLDP MIB.";
reference
"IEEE Std 802.1AB-2016: 8.5.3.2";
}
typedef port-id-type {
type binary {
length "1..255";
}
description
"This TC describes the format of a port identifier string.
Objects of this type are always used with an associated
port-id-subtype object, which identifies the format of the
particular port-id object instance.
If the associated port-id-subtype object has a value of
'interface-alias(1)', then the octet string identifies a
particular instance of the ifAlias object (defined in IETF
RFC 2863). If the particular ifAlias object does not contain
any values, another port identifier type should be used.
If the associated port-id-subtype object has a value of
'port-component(2)', then the octet string identifies a
particular instance of the entPhysicalAlias object (defined
in IETF RFC 2737) for a port or backplane component.
If the associated port-id-subtype object has a value of
'mac-address(3)', then this string identifies a particular
unicast source address (encoded in network byte order
and IEEE 802.3 canonical bit order) associated with the port
(IEEE Std 802-2001).
If the associated port-id-subtype object has a value of
'network-address(4)', then this string identifies a network
address associated with the port. The first octet contains
the IANA address-family enumeration value for the
specific address type, and octets 2 through N contain the
network-address address value in network byte order.
If the associated port-id-subtype object has a value of
'interface-name(5)', then the octet string identifies a
particular instance of the ifName object (defined in IETF
RFC 2863). If the particular ifName object does not contain
any values, another port identifier type should be used.
If the associated port-id-subtype object has a value of
'agent-circuit-id(6)', then this string identifies a agent-local
identifier of the circuit (defined in RFC 3046).
If the associated port-id-subtype object has a value of
'local(7)', then this string identifies a locally
assigned port ID.";
reference
"IEEE Std 802.1AB-2016: 8.5.3.3";
}
typedef man-addr-if-subtype {
type enumeration {
enum unknown {
value 1;
description
"The subtype 'unknown(1)' represents the case where the
interface is not known.";
}
enum port-ref {
value 2;
description
"The subtype 'port-ref(2)' represents interface identifier
based on the port-ref MIB object.";
}
enum system-port-number {
value 3;
description
"The subtype 'system-port-number(3)' represents interface
identifier based on the system port numbering convention.";
}
}
description
"This is the basis of a particular type of
interface associated with the management address.";
reference
"IEEE Std 802.1AB-2016: 8.5.9.5";
}
typedef man-addr-type {
type binary {
length "1..31";
}
description
"The value of a management address associated with the LLDP
agent that may be used to reach higher layer entities to
assist discovery by network management.
It should be noted that appropriate security credentials,
such as SNMP engineId, may be required to access the LLDP
agent using a management address. These necessary credentials
should be known by the network management and the objects
associated with the credentials are not included in the
LLDP agent.";
reference
"IEEE Std 802.1AB-2016: 8.5.9.4";
}
typedef system-capabilities-map {
type bits {
bit other {
position 0;
description
"This bit indicates that the system has capabilities
other than those listed below.";
}
bit repeater {
position 1;
description
"This bit indicates that the system has repeater
capability.";
}
bit bridge {
position 2;
description
"This bit indicates that the system has bridge
capability.";
}
bit wlan-access-point {
position 3;
description
"This bit indicates that the system has
WLAN access point capability.";
}
bit router {
position 4;
description
"This bit indicates that the system has router
capability.";
}
bit telephone {
position 5;
description
"This bit indicates that the system has telephone
capability.";
}
bit docsis-cable-device {
position 6;
description
"This bit indicates that the system has
DOCSIS Cable Device capability (IETF RFC 4639 & 2670).";
}
bit station-only {
position 7;
description
"This bit indicates that the system has only
station capability and nothing else.";
}
bit cvlan-component {
position 8;
description
"This bit indicates that the system has
C-VLAN component functionality.";
}
bit svlan-component {
position 9;
description
"This bit indicates that the system has
S-VLAN component functionality.";
}
bit two-port-mac-relay {
position 10;
description
"This bit indicates that the system has
Two-port MAC Relay (TPMR) functionality.";
}
}
description
"This describes system capabilities.";
reference
"IEEE Std 802.1AB-2016: 8.5.8.1";
}
typedef port-list {
type binary {
length "0..512";
}
description
"Each octet within this value specifies a set of eight ports,
with the first octet specifying ports 1 through 8, the second
octet specifying ports 9 through 16, etc. 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 system 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'.";
reference
"IETF RFC 2674 section 5";
}
typedef dest-address-index-type {
type uint32 {
range "1..4096";
}
description
"An index value used as the key to the list of destination
MAC addresses used both as the destination addresses on
transmitted LLDPDUs and on received LLDPDUs. This index value
is also used as a secondary key in lists that use interface
as a primary key.";
}
/*** GROUPING DEFINITIONS ***/
grouping lldp-cfg {
description
"LLDP basic configuration group.";
leaf message-fast-tx {
type uint32 {
range "1..3600";
}
default "1";
description
"This node indicates the time interval in timer
ticks between transmissions during fast transmission
periods(i.e., txFast is non-zero).
The recommended default value of msgFastTx is 1;
this value can be changed by management to any
value in the range 1 through 3600.";
reference
"IEEE Std 802.1AB-2016: 9.2.5.5";
}
leaf message-tx-hold-multiplier {
type uint32 {
range "1..100";
}
default "4";
description
"This node is used, as a multiplier of msg-tx-interval,
to determine the value of txTTL that is carried in LLDP
frames transmitted by the LLDP agent.
The recommended default value of msgTxHold is 4;
this value can be changed by management to any value in
the range 1 through 100.";
reference
"IEEE Std 802.1AB-2016: 9.2.5.6";
}
leaf message-tx-interval {
type uint32 {
range "1..3600";
}
units "second";
default "30";
description
"This node indicates the time interval in timer ticks
between transmissions during normal transmission periods
(i.e., txFast is zero).
The recommended default value for msgTxInterval is 30 s;
this value can be changed by management to any value in
the range 1 through 3600.";
reference
"IEEE Std 802.1AB-2016: 9.2.5.7";
}
leaf reinit-delay {
type uint32 {
range "1..10";
}
units "second";
default "2";
description
"The reinit-delay indicates the amount of delay (in units of
seconds) from when admin-status becomes 'disabled'
until re-initialization is attempted.
The recommended default value for reinit-delay is 2 s.";
reference
"IEEE Std 802.1AB-2016: 9.2.5.10";
}
leaf tx-credit-max {
type uint32 {
range "1..10";
}
default "5";
description
"The maximum number of consecutive LLDPDUs that can be
transmitted at any time.
The recommended default value is 5;
this value can be changed by management to any value
in the range 1 through 10.";
reference
"IEEE Std 802.1AB-2016: 9.2.5.17";
}
leaf tx-fast-init {
type uint32 {
range "1..8";
}
default "4";
description
"This tx-fast-init is used as the initial value for the
fast transmitting LLDPPDU. This value determines the
number of LLDPDUs that are transmitted during a fast
transmission period.
The recommended default value is 4;
this value can be changed by management to any value in
the range 1 through 8.";
reference
"IEEE Std 802.1AB-2016: 9.2.5.19";
}
leaf notification-interval {
type uint32 {
range "1..3600";
}
units "second";
default "30";
description
"This notification-interval controls the transmission
of LLDP notifications.
If notification transmission is enabled for particular ports,
the suggested default throttling period is 30 seconds.
The value of this object must be restored from non-volatile
storage after a re-initialization of the management system.";
reference
"IEEE Std 802.1AB-2016: 9.2.5.7";
}
}
/*** SCHEMA DEFINITIONS ***/
container lldp {
description
"Link Layer Discovery Protocol configuration and
operational information.";
leaf bridge {
type bridge-ref;
description
"A Bridge on which the LLDP is associated with.";
}
uses lldp-cfg;
container remote-statistics {
config false;
description "LLDP remote operational statistics data.";
leaf last-change-time {
type yang:timestamp;
description
"The value of sysUpTime object (defined in IETF RFC 3418)
at the time an entry is created, modified, or deleted in the
in tables associated with the remote-systems-data objects
and all LLDP extension objects associated with remote systems.
An NMS can use this object to reduce polling of the
remote-systems-data objects.";
}
leaf remote-inserts {
type yang:zero-based-counter32;
units "table entries";
description
"The number of times the complete set of information
advertised by a particular MSAP has been inserted into tables
contained in remote-systems-data and lldpExtensions objects.
The complete set of information received from a particular
MSAP should be inserted into related tables. If partial
information cannot be inserted for a reason such as lack
of resources, all of the complete set of information should
be removed.
This counter should be incremented only once after the
complete set of information is successfully recorded
in all related tables. Any failures during inserting
information set which result in deletion of previously
inserted information should not trigger any changes in
inserts since the insert is not completed
yet or or in deletes, since the deletion
would only be a partial deletion. If the failure was the
result of lack of resources, the drops
counter should be incremented once.";
}
leaf remote-deletes {
type yang:zero-based-counter32;
units "table entries";
description
"The number of times the complete set of information
advertised by a particular MSAP has been deleted from
tables contained in remote-systems-data and lldpExtensions
objects.
This counter should be incremented only once when the
complete set of information is completely deleted from all
related tables. Partial deletions, such as deletion of
rows associated with a particular MSAP from some tables,
but not from all tables are not allowed, thus should not
change the value of this counter.";
}
leaf remote-drops {
type yang:zero-based-counter32;
units "table entries";
description
"The number of times the complete set of information
advertised by a particular MSAP could not be entered into
tables contained in remote-systems-data and lldpExtensions
objects because of insufficient resources.";
}
leaf remote-ageouts {
type yang:zero-based-counter32;
description
"The number of times the complete set of information
advertised by a particular MSAP has been deleted from tables
contained in remote-systems-data and lldpExtensions objects
because the information timeliness interval has expired.
This counter should be incremented only once when the complete
set of information is completely invalidated (aged out)
from all related tables. Partial aging, similar to deletion
case, is not allowed, and thus, should not change the value
of this counter.";
}
}
container local-system-data {
config false;
description "LLDP local system operational data.";
leaf chassis-id-subtype {
type lldp:chassis-id-subtype;
description
"The type of encoding used to identify the chassis
associated with the local system.";
reference
"IEEE Std 802.1AB-2016: 8.5.2.2";
}
leaf chassis-id {
type lldp:chassis-id-type;
description
"The string value used to identify the chassis component
associated with the local system.";
reference
"IEEE Std 802.1AB-2016: 8.5.2.3";
}
leaf system-name {
type string {
length "0..255";
}
description
"The string value used to identify the system name of the
local system. If the local agent supports IETF RFC 3418,
system-name object should have the same value of sys-name
object.";
reference
"IEEE Std 802.1AB-2016: 8.5.6.2";
}
leaf system-description {
type string {
length "0..255";
}
description
"The string value used to identify the system description
of the local system. If the local agent supports IETF RFC 3418,
system-name object should have the same value of sys-desc
object.";
reference
"IEEE Std 802.1AB-2016: 8.5.7.2";
}
leaf system-capabilities-supported {
type lldp:system-capabilities-map;
description
"The bitmap value used to identify which system capabilities
are supported on the local system.";
reference
"IEEE Std 802.1AB-2016: 8.5.8.1";
}
leaf system-capabilities-enabled {
type lldp:system-capabilities-map;
description
"The bitmap value used to identify which system capabilities
are enabled on the local system.";
reference
"IEEE Std 802.1AB-2016: 8.5.8.2";
}
}
/* LLDP port configuration table */
list port {
key "name dest-mac-address";
description
"LLDP configuration information for a particular port.
This configuration parameter controls the transmission and
the reception of LLDP frames on those ports whose rows are
created in this table.";
leaf name {
type if:interface-ref;
must "deref(.)/../type = 'ianaift:ethernetCsmacd'"
+ " or deref(.)/../type = 'ianaift:ieee8023adLag'" {
error-message
"The LLDP is only configured on Link Aggreagation
and Ethernet Port.";
}
description
"The port name used to identify the port component
(contained in the local chassis with the LLDP agent)
associated with this entry.";
}
leaf dest-mac-address {
type ieee:mac-address;
description
"The dest-mac-address specifies the destination MAC
addresses.";
}
leaf admin-status {
type enumeration {
enum tx-only {
value 1;
description
"If the associated admin-status object has a
value of 'tx-only(1)', then LLDP agent will transmit LLDP
frames on this port and it will not store any information
about the remote systems connected.";
}
enum rx-only {
value 2;
description
"If the associated admin-status object has a
value of 'rx-only(2)', then the LLDP agent will receive,
but it will not transmit LLDP frames on this port.";
}
enum tx-and-rx {
value 3;
description
"If the associated admin-status object has a
value of 'tx-and-rx(3)', then the LLDP agent will transmit
and receive LLDP frames on this port.";
}
enum disabled {
value 4;
description
"If the associated admin-status object has a
value of 'disabled(4)', then LLDP agent will not transmit or
receive LLDP frames on this port. If there is remote systems
information which is received on this port and stored in
other tables, before the port's admin-status
becomes disabled, then the information will naturally age out.";
}
}
default "tx-and-rx";
description
"The administratively desired status of the local LLDP agent.";
reference
"IEEE Std 802.1AB-2016: 9.2.5.1";
}
leaf notification-enable {
type boolean;
default "false";
description
"The notification-enable controls, on a per
port basis, whether or not notifications from the agent
are enabled. The value true(1) means that notifications are
enabled; the value false(2) means that they are not.";
}
leaf tlvs-tx-enable {
type bits {
bit port-desc {
position 0;
description
"The bit 'port-desc(0)' indicates that LLDP agent should
transmit 'Port Description tlv'.";
}
bit sys-name {
position 1;
description
"The bit 'sys-name(1)' indicates that LLDP agent should transmit
'System Name tlv'.";
}
bit sys-desc {
position 2;
description
"The bit 'sys-desc(2)' indicates that LLDP agent should transmit
'System Description tlv'.";
}
bit sys-cap {
position 3;
description
"The bit 'sys-cap(3)' indicates that LLDP agent should transmit
'System Capabilities tlv'.";
}
}
description
"The tlvs-tx-enable, defined as a bitmap,
includes the basic set of LLDP tlvs whose transmission is
allowed on the local LLDP agent by the network management.
Each bit in the bitmap corresponds to a tlv type associated
with a specific optional tlv.
It should be noted that the organizationally-specific tlvs
are excluded from the lldptlvsTxEnable bitmap.
LLDP Organization Specific Information Extension MIBs should
have similar configuration object to control transmission
of their organizationally defined tlvs.
There is no bit reserved for the management address tlv type
since transmission of management address tlvs are controlled
by another object, man-addr-type.
The default value for tlvs-tx-enable object is
empty set, which means no enumerated values are set.
The value of this object must be restored from non-volatile
storage after a re-initialization of the management system.";
reference
"IEEE Std 802.1AB-2016 9.1.2.1";
}
uses lldp-cfg;
list management-address-tx-port {
key "address-subtype man-address";
description
"LLDP configuration information that specifies the set
of ports (represented as a PortList) on which the local
system management address instance will be transmitted.
This configuration object augments the local-management-address,
therefore it is only present along with the management
address instance contained in the associated
local-management-address entry.
Each active man-address must be restored from
non-volatile and re-created (along with the corresponding
local-management-address) after a re-initialization of the
management system.";
leaf address-subtype {
type identityref {
base rt:address-family;
}
description
"The management address subtype field shall contain an
integer value indicating the type of address.";
reference
"IEEE Std 802.1AB-2016 8.5.9.3";
}
leaf man-address {
type man-addr-type;
description
"The management address field shall contain an octet string
indicating the particular management address associated
with this TLV.";
reference
"IEEE Std 802.1AB-2016 8.5.9.4";
}
leaf tx-enable {
type boolean;
default "false";
description
"Specify to enable transmission of system
management address instance on a particular port.";
reference
"IEEE Std 802.1AB-2016 9.1.2.1";
}
leaf addr-len {
type uint32;
config false;
description
"The total length of the management address subtype and the
management address fields in LLDPDUs transmitted by the
local LLDP agent.
The management address length field is needed so that the
receiving systems that do not implement SNMP will not be
required to implement an iana family numbers/address length
equivalency table in order to decode the management adress.";
reference
"IEEE Std 802.1AB-2016: 8.5.9.2";
}
leaf if-subtype {
type lldp:man-addr-if-subtype;
config false;
description
"The enumeration value that identifies the interface numbering
method used for defining the interface number, associated
with the local system.";
reference
"IEEE Std 802.1AB-2016: 8.5.9.5";
}
leaf if-id {
type uint32;
config false;
description
"The integer value used to identify the interface number
regarding the management address component associated with
the local system.";
reference
"IEEE Std 802.1AB-2016: 8.5.9.6";
}
}
leaf port-id-subtype {
type lldp:port-id-subtype;
config false;
description
"The type of port identifier encoding used in the associated
'port-id' object.";
reference
"IEEE Std 802.1AB-2016: 8.5.3.2";
}
leaf port-id {
type lldp:port-id-type;
config false;
description
"The string value used to identify the port component
associated with a given port in the local system.";
reference
"IEEE Std 802.1AB-2016: 8.5.3.3";
}