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_interface_module.rst | 298 +++++++++++++------------- 1 file changed, 148 insertions(+), 150 deletions(-) (limited to 'docs/vyos.vyos.vyos_lldp_interface_module.rst') diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst index 98d5c704..1c860e7d 100644 --- a/docs/vyos.vyos.vyos_lldp_interface_module.rst +++ b/docs/vyos.vyos.vyos_lldp_interface_module.rst @@ -38,215 +38,217 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
aggregate
list - / elements=dictionary
- - - - -
List of interfaces LLDP should be configured on.
- + / elements=dictionary + + + + + +
List of interfaces LLDP should be configured on.
+ - - - + + +
name
string - / required
- - - - -
Name of the interface LLDP should be configured on.
- + / required + + + + + +
Name of the interface LLDP should be configured on.
+ - - - + + +
state
string -
- - - - - -
State of the LLDP configuration.
- + + + + + + +
State of the LLDP configuration.
+ - - - + + +
name
string -
- - - - -
Name of the interface LLDP should be configured on.
- + + + + + +
Name of the interface LLDP should be configured on.
+ - - + +
provider
dictionary -
- - - - -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: network_cli.
-
For more information please see the Network Guide.
-
-
A dict object containing connection details.
- + + + + + +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+ - - - + + +
host
string -
- - - - -
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
- + + + + + +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+ - - - + + +
password
string -
- - - - -
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
- + + + + + +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+ - - - + + +
port
integer -
- - - - -
Specifies the port to use when building the connection to the remote device.
- + + + + + +
Specifies the port to use when building the connection to the remote device.
+ - - - + + +
ssh_keyfile
path -
- - - - -
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
- + + + + + +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+ - - - + + +
timeout
integer -
- - - - -
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
- + + + + + +
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+ - - - + + +
username
string -
- - - - -
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
- + + + + + +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+ - - - + + +
state
string -
- - - - - -
State of the LLDP configuration.
- + + + + + + +
State of the LLDP configuration.
+ - +
@@ -264,7 +266,6 @@ Examples .. code-block:: yaml+jinja - - name: Enable LLDP on eth1 net_lldp_interface: state: present @@ -296,7 +297,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -309,24 +309,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set service lldp eth1', 'set service lldp eth2 disable']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set service lldp eth1', 'set service lldp eth2 disable']
+ - +

@@ -342,5 +342,3 @@ Authors ~~~~~~~ - Ricardo Carrillo Cruz (@rcarrillocruz) - - -- cgit v1.2.3