From d75becb8e46d764552b0df605ef9192592ae2633 Mon Sep 17 00:00:00 2001 From: Gaige B Paulsen Date: Fri, 7 Feb 2025 14:11:19 -0500 Subject: T7011: fix: lldp global integration (#385) * T7011: fix: lldp global integration * T7011: Fix lldp interfaces integration --- docs/vyos.vyos.vyos_lldp_global_module.rst | 49 +++++- docs/vyos.vyos.vyos_lldp_interfaces_module.rst | 232 ++++--------------------- 2 files changed, 71 insertions(+), 210 deletions(-) (limited to 'docs') diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst index d9e002a..9e8758c 100644 --- a/docs/vyos.vyos.vyos_lldp_global_module.rst +++ b/docs/vyos.vyos.vyos_lldp_global_module.rst @@ -61,7 +61,24 @@ Parameters -
This argument defines management-address.
+
Exactly one management address (exclusive with addresses). Deprecated in favor of addresses. To be removed in 7.0.0.
+ + + + + +
+ addresses + +
+ list + / elements=string +
+ + + + +
One or more management addresses. The management address is used to identify the management interface of the system. Only addresses connected to the system will be transmitted.
@@ -196,7 +213,8 @@ Examples - fdp - cdp snmp: enable - address: 192.0.2.11 + addresses: + - 192.0.2.11 state: merged # # @@ -215,7 +233,9 @@ Examples # # after": { # "snmp": "enable" - # "address": "192.0.2.11" + # "addresses": [ + # "192.0.2.11" + # ] # "legacy_protocols": [ # "cdp", # "fdp" @@ -250,7 +270,8 @@ Examples - edp - sonmp - cdp - address: 192.0.2.14 + addresses: + - 192.0.2.14 state: replaced # # @@ -261,7 +282,9 @@ Examples # # "before": { # "snmp": "enable" - # "address": "192.0.2.11" + # "addresses": [ + # "192.0.2.11" + # ] # "legacy_protocols": [ # "cdp", # "fdp" @@ -272,13 +295,16 @@ Examples # "commands": [ # "delete service lldp snmp", # "delete service lldp legacy-protocols fdp", + # "delete service lldp management-address '192.0.2.11'", # "set service lldp management-address '192.0.2.14'", # "set service lldp legacy-protocols edp", # "set service lldp legacy-protocols sonmp" # ] # # "after": { - # "address": "192.0.2.14" + # "addresses": [ + # "192.0.2.14" + # ] # "legacy_protocols": [ # "cdp", # "edp", @@ -319,7 +345,9 @@ Examples # ------------------------ # # "before": { - # "address": "192.0.2.14" + # "addresses": [ + # "192.0.2.14" + # ] # "legacy_protocols": [ # "cdp", # "edp", @@ -451,7 +479,8 @@ Examples - name: Render the commands for provided configuration vyos.vyos.vyos_lldp_global: config: - address: 192.0.2.17 + addresses: + - 192.0.2.17 enable: true legacy_protocols: - cdp @@ -489,7 +518,9 @@ Examples # # # "parsed": { - # "address": "192.0.2.11", + # "addresses": [ + # "192.0.2.11" + # ] # "enable": true, # "legacy_protocols": [ # "cdp", diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst index 78b0a73..8ace265 100644 --- a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst @@ -29,12 +29,12 @@ Parameters - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterParameter Choices/Defaults Comments
+
config @@ -51,7 +51,7 @@ Parameters
+
enable @@ -71,7 +71,7 @@ Parameters
+
location @@ -88,104 +88,7 @@ Parameters
-
- civic_based - -
- dictionary -
-
- -
Civic-based location data.
-
-
- ca_info - -
- list - / elements=dictionary -
-
- -
LLDP-MED address info
-
-
- ca_type - -
- integer - / required -
-
- -
LLDP-MED Civic Address type.
-
-
- ca_value - -
- string - / required -
-
- -
LLDP-MED Civic Address value.
-
-
- country_code - -
- string - / required -
-
- -
Country Code
-
coordinate_based @@ -203,7 +106,7 @@ Parameters
+
altitude @@ -221,7 +124,7 @@ Parameters
+
datum @@ -244,7 +147,7 @@ Parameters
+
latitude @@ -263,7 +166,7 @@ Parameters
+
longitude @@ -282,7 +185,7 @@ Parameters
+
elin @@ -299,7 +202,7 @@ Parameters
+
name @@ -316,7 +219,7 @@ Parameters
+
running_config @@ -333,7 +236,7 @@ Parameters
+
state @@ -386,11 +289,7 @@ Examples config: - name: eth1 location: - civic_based: - country_code: US - ca_info: - - ca_type: 0 - ca_value: ENGLISH + elin: 0000000911 - name: eth2 location: coordinate_based: @@ -408,10 +307,7 @@ Examples # before": {} # # "commands": [ - # "set service lldp interface eth1 location civic-based country-code 'US'", - # "set service lldp interface eth1 location civic-based ca-type 0 ca-value 'ENGLISH'", - # "set service lldp interface eth1 location civic-based country-code 'US'", - # "set service lldp interface eth1 location civic-based ca-type 0 ca-value 'ENGLISH'", + # "set service lldp interface eth1 location elin '0000000911'", # "set service lldp interface eth1", # "set service lldp interface eth2 location coordinate-based latitude '33.524449N'", # "set service lldp interface eth2 location coordinate-based altitude '2200'", @@ -437,14 +333,7 @@ Examples # }, # { # "location": { - # "civic_based": { - # "ca_info": [ - # { - # "ca_type": 0, - # "ca_value": "ENGLISH" - # } - # ], - # "country_code": "US" + # "elin": "0000000911" # } # }, # "name": "eth1" @@ -454,8 +343,7 @@ Examples # ------------- # # vyos@vyos:~$ show configuration commands | grep lldp - # set service lldp interface eth1 location civic-based ca-type 0 ca-value 'ENGLISH' - # set service lldp interface eth1 location civic-based country-code 'US' + # set service lldp interface eth1 location elin '0000000911' # set service lldp interface eth2 location coordinate-based altitude '2200' # set service lldp interface eth2 location coordinate-based datum 'WGS84' # set service lldp interface eth2 location coordinate-based latitude '33.524449N' @@ -468,8 +356,7 @@ Examples # ------------- # # vyos@vyos:~$ show configuration commands | grep lldp - # set service lldp interface eth1 location civic-based ca-type 0 ca-value 'ENGLISH' - # set service lldp interface eth1 location civic-based country-code 'US' + # set service lldp interface eth1 location elin '0000000911' # set service lldp interface eth2 location coordinate-based altitude '2200' # set service lldp interface eth2 location coordinate-based datum 'WGS84' # set service lldp interface eth2 location coordinate-based latitude '33.524449N' @@ -482,11 +369,7 @@ Examples config: - name: eth2 location: - civic_based: - country_code: US - ca_info: - - ca_type: 0 - ca_value: ENGLISH + elin: 0000000911 - name: eth1 location: coordinate_based: @@ -515,15 +398,7 @@ Examples # }, # { # "location": { - # "civic_based": { - # "ca_info": [ - # { - # "ca_type": 0, - # "ca_value": "ENGLISH" - # } - # ], - # "country_code": "US" - # } + # "elin": "0000000911" # }, # "name": "eth1" # } @@ -532,8 +407,7 @@ Examples # "commands": [ # "delete service lldp interface eth2 location", # "set service lldp interface eth2 'disable'", - # "set service lldp interface eth2 location civic-based country-code 'US'", - # "set service lldp interface eth2 location civic-based ca-type 0 ca-value 'ENGLISH'", + # "set service lldp interface eth2 location elin '0000000911'", # "delete service lldp interface eth1 location", # "set service lldp interface eth1 'disable'", # "set service lldp interface eth1 location coordinate-based latitude '33.524449N'", @@ -544,15 +418,7 @@ Examples # # "after": { # "location": { - # "civic_based": { - # "ca_info": [ - # { - # "ca_type": 0, - # "ca_value": "ENGLISH" - # } - # ], - # "country_code": "US" - # } + # "elin": "0000000911" # }, # "name": "eth2" # }, @@ -578,8 +444,7 @@ Examples # set service lldp interface eth1 location coordinate-based latitude '33.524449N' # set service lldp interface eth1 location coordinate-based longitude '222.267255W' # set service lldp interface eth2 'disable' - # set service lldp interface eth2 location civic-based ca-type 0 ca-value 'ENGLISH' - # set service lldp interface eth2 location civic-based country-code 'US' + # set service lldp interface eth2 location elin '0000000911' # Using overridden @@ -594,8 +459,7 @@ Examples # set service lldp interface eth1 location coordinate-based latitude '33.524449N' # set service lldp interface eth1 location coordinate-based longitude '222.267255W' # set service lldp interface eth2 'disable' - # set service lldp interface eth2 location civic-based ca-type 0 ca-value 'ENGLISH' - # set service lldp interface eth2 location civic-based country-code 'US' + # set service lldp interface eth2 location elin '0000000911' # - name: Overrides all device configuration with provided configuration vyos.vyos.vyos_lldp_interfaces: @@ -614,17 +478,7 @@ Examples # "before": [ # { # "enable": false, - # "location": { - # "civic_based": { - # "ca_info": [ - # { - # "ca_type": 0, - # "ca_value": "ENGLISH" - # } - # ], - # "country_code": "US" - # } - # }, + # "elin": "0000000911", # "name": "eth2" # }, # { @@ -708,8 +562,7 @@ Examples # ------------- # # vyos@192# run show configuration commands | grep lldp - # set service lldp interface eth1 location civic-based ca-type 0 ca-value 'ENGLISH' - # set service lldp interface eth1 location civic-based country-code 'US' + # set service lldp interface eth1 location elin '0000000911' # set service lldp interface eth2 location coordinate-based altitude '2200' # set service lldp interface eth2 location coordinate-based datum 'WGS84' # set service lldp interface eth2 location coordinate-based latitude '33.524449N' @@ -739,15 +592,7 @@ Examples # }, # { # "location": { - # "civic_based": { - # "ca_info": [ - # { - # "ca_type": 0, - # "ca_value": "ENGLISH" - # } - # ], - # "country_code": "US" - # } + # "elin": "0000000911" # }, # "name": "eth1" # } @@ -758,8 +603,7 @@ Examples # ------------- # # vyos@192# run show configuration commands | grep lldp - # set service lldp interface eth1 location civic-based ca-type 0 ca-value 'ENGLISH' - # set service lldp interface eth1 location civic-based country-code 'US' + # set service lldp interface eth1 location elin '0000000911' # set service lldp interface eth2 location coordinate-based altitude '2200' # set service lldp interface eth2 location coordinate-based datum 'WGS84' # set service lldp interface eth2 location coordinate-based latitude '33.524449N' @@ -774,11 +618,7 @@ Examples config: - name: eth1 location: - civic_based: - country_code: US - ca_info: - - ca_type: 0 - ca_value: ENGLISH + elin: 0000000911 - name: eth2 location: coordinate_based: @@ -796,8 +636,7 @@ Examples # # # "rendered": [ - # "set service lldp interface eth1 location civic-based country-code 'US'", - # "set service lldp interface eth1 location civic-based ca-type 0 ca-value 'ENGLISH'", + # "set service lldp interface eth1 location elin '0000000911'", # "set service lldp interface eth1", # "set service lldp interface eth2 location coordinate-based latitude '33.524449N'", # "set service lldp interface eth2 location coordinate-based altitude '2200'", @@ -813,8 +652,7 @@ Examples - name: Parsed the commands to provide structured configuration. vyos.vyos.vyos_lldp_interfaces: running_config: - "set service lldp interface eth1 location civic-based ca-type 0 ca-value 'ENGLISH' - set service lldp interface eth1 location civic-based country-code 'US' + "set service lldp interface eth1 location elin '0000000911' set service lldp interface eth2 location coordinate-based altitude '2200' set service lldp interface eth2 location coordinate-based datum 'WGS84' set service lldp interface eth2 location coordinate-based latitude '33.524449N' @@ -841,15 +679,7 @@ Examples # }, # { # "location": { - # "civic_based": { - # "ca_info": [ - # { - # "ca_type": 0, - # "ca_value": "ENGLISH" - # } - # ], - # "country_code": "US" - # } + # "elin": "0000000911" # }, # "name": "eth1" # } -- cgit v1.2.3