From a45e2988263f5109a56b6dcb2c46ecbc6738cb3a Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Thu, 27 Aug 2020 14:58:25 -0400 Subject: Release 1.0.4 (#81) Release 1.0.4 Reviewed-by: https://github.com/apps/ansible-zuul --- docs/vyos.vyos.vyos_lldp_interfaces_module.rst | 498 ++++++++++++------------- 1 file changed, 249 insertions(+), 249 deletions(-) (limited to 'docs/vyos.vyos.vyos_lldp_interfaces_module.rst') diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst index d64b20c..c5ea47b 100644 --- a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst @@ -31,324 +31,330 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
A list of lldp interfaces configurations.
- + / elements=dictionary + + + + + +
A list of lldp interfaces configurations.
+ - - - + + +
enable
boolean -
- - - - - -
to disable lldp on the interface.
- + + + + + + +
to disable lldp on the interface.
+ - - - + + +
location
dictionary -
- - - - -
LLDP-MED location data.
- + + + + + +
LLDP-MED location data.
+ - - - - + + + +
civic_based
dictionary -
- - - - -
Civic-based location data.
- + + + + + +
Civic-based location data.
+ - - - - - + + + + +
ca_info
list - / elements=dictionary
- - - - -
LLDP-MED address info
- + / elements=dictionary + + + + + +
LLDP-MED address info
+ - - - - - - + + + + + +
ca_type
integer -
- - - - -
LLDP-MED Civic Address type.
- + + + + + +
LLDP-MED Civic Address type.
+ - - - - - - + + + + + +
ca_value
string -
- - - - -
LLDP-MED Civic Address value.
- + + + + + +
LLDP-MED Civic Address value.
+ - - - - - - + + + + + +
country_code
string - / required
- - - - -
Country Code
- + / required + + + + + +
Country Code
+ - - - - - + + + + +
coordinate_based
dictionary -
- - - - -
Coordinate-based location.
- + + + + + +
Coordinate-based location.
+ - - - - - + + + + +
altitude
integer -
- - - - -
Altitude in meters.
- + + + + + +
Altitude in meters.
+ - - - - - + + + + +
datum
string -
- - - - - -
Coordinate datum type.
- + + + + + + +
Coordinate datum type.
+ - - - - - + + + + +
latitude
string - / required
- - - - -
Latitude.
- + / required + + + + + +
Latitude.
+ - - - - - + + + + +
longitude
string - / required
- - - - -
Longitude.
- + / required + + + + + +
Longitude.
+ - - - - - + + + + +
elin
string -
- - - - -
Emergency Call Service ELIN number (between 10-25 numbers).
- + + + + + +
Emergency Call Service ELIN number (between 10-25 numbers).
+ - - - - + + + +
name
string - / required
- - - - -
Name of the lldp interface.
- + / required + + + + + +
Name of the lldp interface.
+ - - - + + +
running_config
string -
- - - - -
This option is used only with state parsed.
-
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep lldp.
-
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
- + + + + + +
This option is used only with state parsed.
+
The value of this option should be the output received from the VyOS device by executing the command show configuration commands | grep lldp.
+
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
+ - - + +
state
string -
- - - - - -
The state of the configuration after module completion.
- + + + + + + +
The state of the configuration after module completion.
+ - +
@@ -366,7 +372,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -844,9 +849,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -859,60 +861,60 @@ Common return values are documented `here Returned Description - - + +
after
list -
- + + when changed -
The configuration as structured data after module completion.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data after module completion.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
before
list -
- +
+ always -
The configuration as structured data prior to module invocation.
-
-
Sample:
-
The configuration returned will always be in the same format +
The configuration as structured data prior to module invocation.
+
+
Sample:
+
The configuration returned will always be in the same format of the parameters above.
- + - - + +
commands
list -
- +
+ always -
The set of commands pushed to the remote device.
-
-
Sample:
-
["set service lldp interface eth2 'disable'", 'delete service lldp interface eth1 location']
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
["set service lldp interface eth2 'disable'", 'delete service lldp interface eth1 location']
+ - +

@@ -924,5 +926,3 @@ Authors ~~~~~~~ - Rohit Thakur (@rohitthakur2590) - - -- cgit v1.2.3