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_vlan_module.rst | 513 ++++++++++++++++++------------------ 1 file changed, 258 insertions(+), 255 deletions(-) (limited to 'docs/vyos.vyos.vyos_vlan_module.rst') diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index 084649f..d00260e 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -31,386 +31,393 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
address
string -
- - - - -
Configure Virtual interface address.
- + + + + + +
Configure Virtual interface address.
+ - - + +
aggregate
list - / elements=dictionary
- - - - -
List of VLANs definitions.
- + / elements=dictionary + + + + + +
List of VLANs definitions.
+ - - - + + +
address
string -
- - - - -
Configure Virtual interface address.
- + + + + + +
Configure Virtual interface address.
+ - - - + + +
associated_interfaces
list - / elements=string
- - - - -
This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
- + / elements=string + + + + + +
This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
+ - - - + + +
delay
integer -
- - - - -
Delay the play should wait to check for declarative intent params values.
- + + + + + +
Delay the play should wait to check for declarative intent params values.
+ - - - + + +
interfaces
list - / elements=string / required
- - - - -
List of interfaces that should be associated to the VLAN.
- + / elements=string + / required + + + + + +
List of interfaces that should be associated to the VLAN.
+ - - - + + +
name
string -
- - - - -
Name of the VLAN.
- + + + + + +
Name of the VLAN.
+ - - - + + +
state
string -
- - - - - -
State of the VLAN configuration.
- + + + + + + +
State of the VLAN configuration.
+ - - - + + +
vlan_id
integer - / required
- - - - -
ID of the VLAN. Range 0-4094.
- + / required + + + + + +
ID of the VLAN. Range 0-4094.
+ - - - + + +
associated_interfaces
list - / elements=string
- - - - -
This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
- + / elements=string + + + + + +
This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
+ - - + +
delay
integer -
- - - Default:
10
- - -
Delay the play should wait to check for declarative intent params values.
- + + + + Default:
10
+ + +
Delay the play should wait to check for declarative intent params values.
+ - - + +
interfaces
list - / elements=string
- - - - -
List of interfaces that should be associated to the VLAN.
- + / elements=string + + + + + +
List of interfaces that should be associated to the VLAN.
+ - - + +
name
string -
- - - - -
Name of the VLAN.
- + + + + + +
Name of the VLAN.
+ - - + +
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.
+ - - - + + +
purge
boolean -
- - - - - -
Purge VLANs not defined in the aggregate parameter.
- + + + + + + +
Purge VLANs not defined in the aggregate parameter.
+ - - + +
state
string -
- - - - - -
State of the VLAN configuration.
- + + + + + + +
State of the VLAN configuration.
+ - - + +
vlan_id
integer -
- - - - -
ID of the VLAN. Range 0-4094.
- + + + + + +
ID of the VLAN. Range 0-4094.
+ - +
@@ -429,7 +436,6 @@ Examples .. code-block:: yaml+jinja - - name: Create vlan vyos.vyos.vyos_vlan: vlan_id: 100 @@ -472,7 +478,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -485,24 +490,24 @@ Common return values are documented `here Returned Description - - + +
commands
list -
- + + always -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set interfaces ethernet eth1 vif 100 description VLAN 100', 'set interfaces ethernet eth1 vif 100 address 172.26.100.37/24', 'delete interfaces ethernet eth1 vif 100']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set interfaces ethernet eth1 vif 100 description VLAN 100', 'set interfaces ethernet eth1 vif 100 address 172.26.100.37/24', 'delete interfaces ethernet eth1 vif 100']
+ - +

@@ -514,5 +519,3 @@ Authors ~~~~~~~ - Trishna Guha (@trishnaguha) - - -- cgit v1.2.3