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_interfaces_module.rst | 433 +++++++++++++++--------------- 1 file changed, 215 insertions(+), 218 deletions(-) (limited to 'docs/vyos.vyos.vyos_interfaces_module.rst') diff --git a/docs/vyos.vyos.vyos_interfaces_module.rst b/docs/vyos.vyos.vyos_interfaces_module.rst index 67c71de..5bf5d23 100644 --- a/docs/vyos.vyos.vyos_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_interfaces_module.rst @@ -32,275 +32,278 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
The provided interfaces configuration.
- + / elements=dictionary + + + + + +
The provided interfaces configuration.
+ - - - + + +
description
string -
- - - - -
Interface description.
- + + + + + +
Interface description.
+ - - - + + +
duplex
string -
- - - - - -
Interface duplex mode.
-
Applicable for Ethernet interfaces only.
- + + + + + + +
Interface duplex mode.
+
Applicable for Ethernet interfaces only.
+ - - - + + +
enabled
boolean -
- - - - - -
Administrative state of the interface.
-
Set the value to true to administratively enable the interface or false to disable it.
- + + + + + + +
Administrative state of the interface.
+
Set the value to true to administratively enable the interface or false to disable it.
+ - - - + + +
mtu
integer -
- - - - -
MTU for a specific interface. Refer to vendor documentation for valid values.
-
Applicable for Ethernet, Bonding, VXLAN and Virtual Tunnel interfaces.
- + + + + + +
MTU for a specific interface. Refer to vendor documentation for valid values.
+
Applicable for Ethernet, Bonding, VXLAN and Virtual Tunnel interfaces.
+ - - - + + +
name
string - / required
- - - - -
Full name of the interface, e.g. eth0, eth1, bond0, vti1, vxlan2.
- + / required + + + + + +
Full name of the interface, e.g. eth0, eth1, bond0, vti1, vxlan2.
+ - - - + + +
speed
string -
- - - - - -
Interface link speed.
-
Applicable for Ethernet interfaces only.
- + + + + + + +
Interface link speed.
+
Applicable for Ethernet interfaces only.
+ - - - + + +
vifs
list - / elements=dictionary
- - - - -
Virtual sub-interfaces related configuration.
-
802.1Q VLAN interfaces are represented as virtual sub-interfaces in VyOS.
- + / elements=dictionary + + + + + +
Virtual sub-interfaces related configuration.
+
802.1Q VLAN interfaces are represented as virtual sub-interfaces in VyOS.
+ - - - - + + + +
description
string -
- - - - -
Virtual sub-interface description.
- + + + + + +
Virtual sub-interface description.
+ - - - - + + + +
enabled
boolean -
- - - - - -
Administrative state of the virtual sub-interface.
-
Set the value to true to administratively enable the interface or false to disable it.
- + + + + + + +
Administrative state of the virtual sub-interface.
+
Set the value to true to administratively enable the interface or false to disable it.
+ - - - - + + + +
mtu
integer -
- - - - -
MTU for the virtual sub-interface.
-
Refer to vendor documentation for valid values.
- + + + + + +
MTU for the virtual sub-interface.
+
Refer to vendor documentation for valid values.
+ - - - - + + + +
vlan_id
integer -
- - - - -
Identifier for the virtual sub-interface.
- + + + + + +
Identifier for the virtual sub-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 interfaces.
-
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 interfaces.
+
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.
+ - +
@@ -318,7 +321,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # ------------- @@ -1246,9 +1248,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -1261,60 +1260,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 interfaces ethernet eth1 mtu 1200', 'set interfaces ethernet eth2 vif 100 description VIF 100']
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set interfaces ethernet eth1 mtu 1200', 'set interfaces ethernet eth2 vif 100 description VIF 100']
+ - +

@@ -1327,5 +1326,3 @@ Authors - Nilashish Chakraborty (@nilashishc) - Rohit Thakur (@rohitthakur2590) - - -- cgit v1.2.3