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_lag_interfaces_module.rst | 366 +++++++++++++------------- 1 file changed, 182 insertions(+), 184 deletions(-) (limited to 'docs/vyos.vyos.vyos_lag_interfaces_module.rst') diff --git a/docs/vyos.vyos.vyos_lag_interfaces_module.rst b/docs/vyos.vyos.vyos_lag_interfaces_module.rst index b09a846..153e20e 100644 --- a/docs/vyos.vyos.vyos_lag_interfaces_module.rst +++ b/docs/vyos.vyos.vyos_lag_interfaces_module.rst @@ -31,229 +31,233 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
config
list - / elements=dictionary
- - - - -
A list of link aggregation group configurations.
- + / elements=dictionary + + + + + +
A list of link aggregation group configurations.
+ - - - + + +
arp_monitor
dictionary -
- - - - -
ARP Link monitoring parameters.
- + + + + + +
ARP Link monitoring parameters.
+ - - - - + + + +
interval
integer -
- - - - -
ARP link monitoring frequency in milliseconds.
- + + + + + +
ARP link monitoring frequency in milliseconds.
+ - - - - + + + +
target
list - / elements=string
- - - - -
IP address to use for ARP monitoring.
- + / elements=string + + + + + +
IP address to use for ARP monitoring.
+ - - - - + + + +
hash_policy
string -
- - - - - -
LAG or bonding transmit hash policy.
- + + + + + + +
LAG or bonding transmit hash policy.
+ - - - + + +
members
list - / elements=dictionary
- - - - -
List of member interfaces for the LAG (bond).
- + / elements=dictionary + + + + + +
List of member interfaces for the LAG (bond).
+ - - - - + + + +
member
string -
- - - - -
Name of the member interface.
- + + + + + +
Name of the member interface.
+ - - - - + + + +
mode
string -
- - - - - -
LAG or bond mode.
- + + + + + + +
LAG or bond mode.
+ - - - + + +
name
string - / required
- - - - -
Name of the link aggregation group (LAG) or bond.
- + / required + + + + + +
Name of the link aggregation group (LAG) or bond.
+ - - - + + +
primary
string -
- - - - -
Primary device interfaces for the LAG (bond).
- + + + + + +
Primary device interfaces for the LAG (bond).
+ - - - + + +
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 bond.
-
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 bond.
+
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.
+ - +
@@ -271,7 +275,6 @@ Examples .. code-block:: yaml+jinja - # Using merged # # Before state: @@ -865,9 +868,6 @@ Examples - - - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -880,60 +880,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 bonding bond2', 'set interfaces bonding bond2 hash-policy layer2']
- +
The set of commands pushed to the remote device.
+
+
Sample:
+
['set interfaces bonding bond2', 'set interfaces bonding bond2 hash-policy layer2']
+ - +

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