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_interface_module.rst | 696 +++++++++++++++---------------- 1 file changed, 348 insertions(+), 348 deletions(-) (limited to 'docs/vyos.vyos.vyos_interface_module.rst') diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst index c00b430f..111ff311 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -38,521 +38,525 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
aggregate
list - / elements=dictionary
- - - - -
List of Interfaces definitions.
- + / elements=dictionary + + + + + +
List of Interfaces definitions.
+ - - - + + +
delay
integer -
- - - - -
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down and neighbors.
- + + + + + +
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down and neighbors.
+ - - - + + +
description
string -
- - - - -
Description of Interface.
- + + + + + +
Description of Interface.
+ - - - + + +
duplex
string -
- - - - - -
Interface link status.
- + + + + + + +
Interface link status.
+ - - - + + +
enabled
boolean -
- - - - - -
Interface link status.
- + + + + + + +
Interface link status.
+ - - - + + +
mtu
integer -
- - - - -
Maximum size of transmit packet.
- + + + + + +
Maximum size of transmit packet.
+ - - - + + +
name
string - / required
- - - - -
Name of the Interface.
- + / required + + + + + +
Name of the Interface.
+ - - - + + +
neighbors
list - / elements=dictionary
- - - - -
Check the operational state of given interface name for LLDP neighbor.
-
The following suboptions are available.
- + / elements=dictionary + + + + + +
Check the operational state of given interface name for LLDP neighbor.
+
The following suboptions are available.
+ - - - - + + + +
host
string -
- - - - -
LLDP neighbor host for given interface name.
- + + + + + +
LLDP neighbor host for given interface name.
+ - - - - + + + +
port
string -
- - - - -
LLDP neighbor port to which given interface name is connected.
- + + + + + +
LLDP neighbor port to which given interface name is connected.
+ - - - - + + + +
speed
string -
- - - - -
Interface link speed.
- + + + + + +
Interface link speed.
+ - - - + + +
state
string -
- - - - - -
State of the Interface configuration, up means present and operationally up and down means present and operationally down
- + + + + + + +
State of the Interface configuration, up means present and operationally up and down means present and operationally down
+ - - - + + +
delay
integer -
- - - Default:
10
- - -
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down and neighbors.
- + + + + Default:
10
+ + +
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down and neighbors.
+ - - + +
description
string -
- - - - -
Description of Interface.
- + + + + + +
Description of Interface.
+ - - + +
duplex
string -
- - - - - -
Interface link status.
- + + + + + + +
Interface link status.
+ - - + +
enabled
boolean -
- - - - - -
Interface link status.
- + + + + + + +
Interface link status.
+ - - + +
mtu
integer -
- - - - -
Maximum size of transmit packet.
- + + + + + +
Maximum size of transmit packet.
+ - - + +
name
string -
- - - - -
Name of the Interface.
- + + + + + +
Name of the Interface.
+ - - + +
neighbors
list - / elements=dictionary
- - - - -
Check the operational state of given interface name for LLDP neighbor.
-
The following suboptions are available.
- + / elements=dictionary + + + + + +
Check the operational state of given interface name for LLDP neighbor.
+
The following suboptions are available.
+ - - - + + +
host
string -
- - - - -
LLDP neighbor host for given interface name.
- + + + + + +
LLDP neighbor host for given interface name.
+ - - - + + +
port
string -
- - - - -
LLDP neighbor port to which given interface name is connected.
- + + + + + +
LLDP neighbor port to which given interface name is connected.
+ - - - + + +
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.
+ - - - + + +
speed
string -
- - - - -
Interface link speed.
- + + + + + +
Interface link speed.
+ - - + +
state
string -
- - - - - -
State of the Interface configuration, up means present and operationally up and down means present and operationally down
- + + + + + + +
State of the Interface configuration, up means present and operationally up and down means present and operationally down
+ - +
@@ -570,7 +574,6 @@ Examples .. code-block:: yaml+jinja - - name: configure interface vyos.vyos.vyos_interface: name: eth0 @@ -634,7 +637,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -647,24 +649,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 interfaces ethernet eth0 description "test-interface"', 'set interfaces ethernet eth0 speed 100', 'set interfaces ethernet eth0 mtu 256', 'set interfaces ethernet eth0 duplex full']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set interfaces ethernet eth0 description "test-interface"', 'set interfaces ethernet eth0 speed 100', 'set interfaces ethernet eth0 mtu 256', 'set interfaces ethernet eth0 duplex full']
+ - +

@@ -680,5 +682,3 @@ Authors ~~~~~~~ - Ganesh Nalawade (@ganeshrn) - - -- cgit v1.2.3