Refactor LLDP management addresses and deprecate previous management address leafs

release/models/lldp/openconfig-lldp-types.yang

@@ -21,7 +21,13 @@ module openconfig-lldp-types {
   description
     "This module defines types related to the LLDP protocol model.";
 
-  oc-ext:openconfig-version "0.1.1";
+  oc-ext:openconfig-version "0.2.0";
+
+  revision "2025-05-02" {
+    description
+      "Add Management interface numbering subtype typedef.";
+    reference "0.2.0";
+  }
 
   revision "2018-11-21" {
     description
@@ -302,5 +308,30 @@ module openconfig-lldp-types {
       "IEEE 802.1AB LLDP MIB";
   }
 
+  typedef mgmt-interface-number-subtype {
+    type enumeration {
+      enum UNKNOWN {
+        value 1;
+        description
+          "Interface is not known";
+      }
+      enum IFINDEX {
+        value 2;
+        description
+          "Interface is based on the IF-MIB ifIndex";
+      }
+      enum SYSTEM_PORT_NUMBER {
+        value 3;
+        description
+          "Interface is based on the system port number";
+      }
+    }
+    description
+      "The Management address interface numbering subtype field
+      indicating the numbering method used for defining the interface
+      number.";
+    reference
+     "Sec 8.5.9.5 of IEEE Std 802.1AB-2016";
+  }
 
-}
+}

release/models/lldp/openconfig-lldp.yang

@@ -9,7 +9,8 @@ module openconfig-lldp {
 
   import openconfig-lldp-types { prefix oc-lldp-types; }
   import openconfig-interfaces { prefix oc-if; }
-  import ietf-yang-types { prefix yang; }
+  import openconfig-yang-types { prefix oc-yang; }
+  import openconfig-inet-types { prefix oc-inet; }
   import openconfig-extensions { prefix oc-ext; }
 
 
@@ -24,7 +25,16 @@ module openconfig-lldp {
     "This module defines configuration and operational state data
     for the LLDP protocol.";
 
-  oc-ext:openconfig-version "0.2.1";
+  oc-ext:openconfig-version "1.0.0";
+
+  revision "2025-05-02" {
+    description
+      "Refactor LLDP management addresses to accomodate 802.1AB defined
+      TLV.  Add configurable management interface.  Switch from IETF to
+      OC YANG types.  Deprecate management-address-type and
+      management-address leafs.  Cleanup unused/empty groupings.";
+    reference "1.0.0";
+  }
 
   revision "2018-11-21" {
     description
@@ -59,43 +69,43 @@ module openconfig-lldp {
       "Definition of global and per-interface counters";
 
     leaf frame-in {
-      type yang:counter64;
+      type oc-yang:counter64;
       description
         "The number of lldp frames received.";
     }
 
     leaf frame-out {
-      type yang:counter64;
+      type oc-yang:counter64;
       description
         "The number of frames transmitted out.";
     }
 
     leaf frame-error-in {
-      type yang:counter64;
+      type oc-yang:counter64;
       description
         "The number of LLDP frames received with errors.";
     }
 
     leaf frame-discard {
-      type yang:counter64;
+      type oc-yang:counter64;
       description
         "The number of LLDP frames received and discarded.";
     }
 
     leaf tlv-discard {
-      type yang:counter64;
+      type oc-yang:counter64;
       description
         "The number of TLV frames received and discarded.";
     }
 
     leaf tlv-unknown {
-      type yang:counter64;
+      type oc-yang:counter64;
       description
         "The number of frames received with unknown TLV.";
     }
 
     leaf last-clear {
-      type yang:date-and-time;
+      type oc-yang:date-and-time;
       description
         "Indicates the last time the counters were
         cleared.";
@@ -109,13 +119,13 @@ module openconfig-lldp {
     uses lldp-common-counters;
 
     leaf tlv-accepted {
-      type yang:counter64;
+      type oc-yang:counter64;
       description
         "The number of valid TLVs received.";
     }
 
     leaf entries-aged-out {
-      type yang:counter64;
+      type oc-yang:counter64;
       description
         "The number of entries aged out due to timeout.";
     }
@@ -129,7 +139,7 @@ module openconfig-lldp {
       uses lldp-common-counters;
 
       leaf frame-error-out {
-        type yang:counter64;
+        type oc-yang:counter64;
         description
           "The number of frame transmit errors on the
           interface.";
@@ -182,19 +192,86 @@ module openconfig-lldp {
         identifier string. It is an enumerator defined by the
         LldpChassisIdSubtype object from IEEE 802.1AB MIB.";
     }
+
+    leaf management-interface {
+      type oc-if:interface-id;
+      description
+        "The interface in which to derive the population of Management
+        Address TLV parameters.  If unspecified, the implementation may
+        choose which interface is utilized.";
+    }
   }
 
-  grouping lldp-system-info-state {
+  grouping lldp-management-addresses {
     description
-      "Operational state data reported for the local and remote
-      systems";
+      "Operational state data to represent local or remote Management
+      Address TLV parameters.";
+
+    container management-addresses {
+      config false;
+
+      description
+        "Encapsulating container for management addresses";
+
+      list management-address {
+        description
+          "List of management addresses in use by the local/remote
+          system";
+
+        key address;
+
+        leaf address {
+          type leafref {
+            path "../state/address";
+          }
+          description
+            "Reference to the management address key";
+        }
+
+        container state {
+          description
+            "Operational state data for management addresses";
 
+          uses lldp-management-address-state;
+        }
+      }
+    }
   }
 
-  grouping lldp-neighbor-config {
+  grouping lldp-management-address-state {
     description
-      "Configuration data for LLDP neighbors";
+      "Local or remote management address state data.";
+
+    leaf address {
+      type union {
+        type oc-inet:ip-address;
+        type oc-yang:mac-address;
+      }
+      description
+        "Management address associated with the Management Address
+        TLV.";
+      reference
+        "Sec 8.5.9.4 of IEEE Std 802.1AB-2016";
+    }
 
+    leaf interface-number {
+      type uint32;
+      description
+        "Interface number that identifies the specific interface
+        associated with this management address.";
+      reference
+        "Sec 8.5.9.6 of IEEE Std 802.1AB-2016";
+    }
+
+    leaf interface-number-subtype {
+      type oc-lldp-types:mgmt-interface-number-subtype;
+      description
+        "The Management address interface numbering subtype field
+        indicating the numbering method used for defining the
+        interface-number.";
+      reference
+        "Sec 8.5.9.5 of IEEE Std 802.1AB-2016";
+    }
   }
 
   grouping lldp-neighbor-state {
@@ -258,20 +335,32 @@ module openconfig-lldp {
 
     leaf management-address {
       type string;
+      status deprecated;
       description
         "The Management Address is a mandatory TLV which identifies a
         network address associated with the local LLDP agent, which
         can be used to reach the agent on the port identified in the
-        Port ID TLV.";
+        Port ID TLV.
+
+        This leaf has been deprecated in favor of the management-address
+        list structure to accomodate multiple addresses and distinct
+        typing to pair up with the 802.1AB Management Address TLV
+        specification.";
     }
 
     leaf management-address-type {
       type string;
+      status deprecated;
       description
         "The enumerated value for the network address type
         identified in this TLV. This enumeration is defined in the
         'Assigned Numbers' RFC [RFC3232] and the
-        ianaAddressFamilyNumbers object.";
+        ianaAddressFamilyNumbers object.
+
+        This leaf has been deprecated in favor of the management-address
+        list structure to accomodate multiple addresses and distinct
+        typing to pair up with the 802.1AB Management Address TLV
+        specification.";
     }
   }
 
@@ -479,7 +568,6 @@ module openconfig-lldp {
           description
             "Configuration data ";
 
-          uses lldp-neighbor-config;
         }
 
         container state {
@@ -490,11 +578,10 @@ module openconfig-lldp {
             "Operational state data ";
 
           uses lldp-system-info-config;
-          uses lldp-system-info-state;
-          uses lldp-neighbor-config;
           uses lldp-neighbor-state;
         }
 
+        uses lldp-management-addresses;
         uses lldp-custom-tlv-top;
         uses lldp-capabilities-top;
       }
@@ -644,10 +731,10 @@ module openconfig-lldp {
 
         uses lldp-config;
         uses lldp-system-info-config;
-        uses lldp-system-info-state;
         uses lldp-state;
       }
 
+      uses lldp-management-addresses;
       uses lldp-interface-top;
     }
   }

release/models/optical-transport/openconfig-terminal-device.yang

@@ -77,7 +77,13 @@ module openconfig-terminal-device {
     ports per linecard, separate linecards for client and line ports,
     etc.).";
 
-  oc-ext:openconfig-version "1.9.2";
+  oc-ext:openconfig-version "1.10.0";
+
+  revision "2025-04-08" {
+    description
+      "Removal of references to unused/removed LLDP groupings";
+    reference "1.10.0";
+  }
 
   revision "2024-06-12" {
     description
@@ -477,8 +483,6 @@ module openconfig-terminal-device {
             "Operational state data ";
 
           uses oc-lldp:lldp-system-info-config;
-          uses oc-lldp:lldp-system-info-state;
-          uses oc-lldp:lldp-neighbor-config;
           uses oc-lldp:lldp-neighbor-state;
         }