2 namespace urn:ieee:std:802.1Q:yang:ieee802-types;
5 "IEEE 802.1 Working Group";
7 "WG-URL: http://ieee802.org/1/
8 WG-EMail: stds-802-1-l@ieee.org
10 Contact: IEEE 802.1 Working Group Chair
11 Postal: C/O IEEE 802.1 Working Group
12 IEEE Standards Association
17 E-mail: stds-802-1-chairs@ieee.org";
19 "This module contains a collection of generally useful derived
20 data types for IEEE YANG models.";
23 "Published as part of IEEE Std 802.1Qcx-2020.
26 "IEEE Std 802.1Qcx-2020, Bridges and Bridged Networks -
27 YANG Data Model for Connectivity Fault Management.";
31 "Published as part of IEEE Std 802.1Q-2018.
34 "IEEE Std 802.1Q-2018, Bridges and Bridged Networks.";
39 pattern "[0-9a-fA-F]{2}(-[0-9a-fA-F]{2}){5}";
42 "The mac-address type represents a MAC address in the canonical
43 format and hexadecimal format specified by IEEE Std 802. The
44 hexidecimal representation uses uppercase characters.";
46 "3.1 of IEEE Std 802-2014
47 8.1 of IEEE Std 802-2014";
50 typedef chassis-id-subtype-type {
52 enum chassis-component {
55 "Represents a chassis identifier based on the value of
56 entPhysicalAlias object (defined in IETF RFC 2737) for a
57 chassis component (i.e., an entPhysicalClass value of
60 enum interface-alias {
63 "Represents a chassis identifier based on the value of
64 ifAlias object (defined in IETF RFC 2863) for an interface
65 on the containing chassis.";
70 "Represents a chassis identifier based on the value of
71 entPhysicalAlias object (defined in IETF RFC 2737) for a
72 port or backplane component (i.e., entPhysicalClass value of
73 port(10) or backplane(4)), within the containing chassis.";
78 "Represents a chassis identifier based on the value of a
79 unicast source address (encoded in network byte order and
80 IEEE 802.3 canonical bit order), of a port on the containing
81 chassis as defined in IEEE Std 802-2001.";
83 enum network-address {
86 "Represents a chassis identifier based on a network address,
87 associated with a particular chassis. The encoded address is
88 actually composed of two fields. The first field is a
89 single octet, representing the IANA AddressFamilyNumbers
90 value for the specific address type, and the second field is
91 the network address value.";
96 "Represents a chassis identifier based on the value of
97 ifName object (defined in IETF RFC 2863) for an interface
98 on the containing chassis.";
103 "Represents a chassis identifier based on a locally defined
108 "The source of a chassis identifier.";
113 typedef chassis-id-type {
118 "The format of a chassis identifier string. Objects of this type
119 are always used with an associated lldp-chassis-is-subtype
120 object, which identifies the format of the particular
121 lldp-chassis-id object instance.
123 If the associated lldp-chassis-id-subtype object has a value of
124 chassis-component, then the octet string identifies
125 a particular instance of the entPhysicalAlias object
126 (defined in IETF RFC 2737) for a chassis component (i.e.,
127 an entPhysicalClass value of chassis(3)).
129 If the associated lldp-chassis-id-subtype object has a value
130 of interface-alias, then the octet string identifies
131 a particular instance of the ifAlias object (defined in
132 IETF RFC 2863) for an interface on the containing chassis.
133 If the particular ifAlias object does not contain any values,
134 another chassis identifier type should be used.
136 If the associated lldp-chassis-id-subtype object has a value
137 of port-component, then the octet string identifies a
138 particular instance of the entPhysicalAlias object (defined
139 in IETF RFC 2737) for a port or backplane component within
140 the containing chassis.
142 If the associated lldp-chassis-id-subtype object has a value of
143 mac-address, then this string identifies a particular
144 unicast source address (encoded in network byte order and
145 IEEE 802.3 canonical bit order), of a port on the containing
146 chassis as defined in IEEE Std 802-2001.
148 If the associated lldp-chassis-id-subtype object has a value of
149 network-address, then this string identifies a particular
150 network address, encoded in network byte order, associated
151 with one or more ports on the containing chassis. The first
152 octet contains the IANA Address Family Numbers enumeration
153 value for the specific address type, and octets 2 through
154 N contain the network address value in network byte order.
156 If the associated lldp-chassis-id-subtype object has a value
157 of interface-name, then the octet string identifies
158 a particular instance of the ifName object (defined in
159 IETF RFC 2863) for an interface on the containing chassis.
160 If the particular ifName object does not contain any values,
161 another chassis identifier type should be used.
163 If the associated lldp-chassis-id-subtype object has a value of
164 local, then this string identifies a locally assigned
170 typedef port-id-subtype-type {
172 enum interface-alias {
175 "Represents a port identifier based on the ifAlias
176 MIB object, defined in IETF RFC 2863.";
178 enum port-component {
181 "Represents a port identifier based on the value of
182 entPhysicalAlias (defined in IETF RFC 2737) for a port
183 component (i.e., entPhysicalClass value of port(10)),
184 within the containing chassis.";
189 "Represents a port identifier based on a unicast source
190 address (encoded in network byte order and IEEE 802.3
191 canonical bit order), which has been detected by the agent
192 and associated with a particular port (IEEE Std 802-2001).";
194 enum network-address {
197 "Represents a port identifier based on a network address,
198 detected by the agent and associated with a particular
201 enum interface-name {
204 "Represents a port identifier based on the ifName MIB object,
205 defined in IETF RFC 2863.";
207 enum agent-circuit-id {
210 "Represents a port identifier based on the agent-local
211 identifier of the circuit (defined in RFC 3046), detected by
212 the agent and associated with a particular port.";
217 "Represents a port identifier based on a value locally
222 "The source of a particular type of port identifier used
223 in the LLDP YANG module.";
226 typedef port-id-type {
231 "The format of a port identifier string. Objects of this type
232 are always used with an associated lldp-port-id-subtype object,
233 which identifies the format of the particular lldp-port-id
236 If the associated lldp-port-id-subtype object has a value of
237 interface-alias, then the octet string identifies a
238 particular instance of the ifAlias object (defined in IETF
239 RFC 2863). If the particular ifAlias object does not contain
240 any values, another port identifier type should be used.
242 If the associated lldp-port-id-subtype object has a value of
243 port-component, then the octet string identifies a
244 particular instance of the entPhysicalAlias object (defined
245 in IETF RFC 2737) for a port or backplane component.
247 If the associated lldp-port-id-subtype object has a value of
248 mac-address, then this string identifies a particular
249 unicast source address (encoded in network byte order
250 and IEEE 802.3 canonical bit order) associated with the port
253 If the associated lldp-port-id-subtype object has a value of
254 network-address, then this string identifies a network
255 address associated with the port. The first octet contains
256 the IANA AddressFamilyNumbers enumeration value for the
257 specific address type, and octets 2 through N contain the
258 networkAddress address value in network byte order.
260 If the associated lldp-port-id-subtype object has a value of
261 interface-name, then the octet string identifies a
262 particular instance of the ifName object (defined in IETF
263 RFC 2863). If the particular ifName object does not contain
264 any values, another port identifier type should be used.
266 If the associated lldp-port-id-subtype object has a value of
267 agent-circuit-id, then this string identifies a agent-local
268 identifier of the circuit (defined in RFC 3046).
270 If the associated lldp-port-id-subtype object has a value of
271 local, then this string identifies a locally assigned port ID.";