summaryrefslogtreecommitdiff
path: root/plugins/modules/vyos_lag_interfaces.py
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/modules/vyos_lag_interfaces.py')
-rw-r--r--plugins/modules/vyos_lag_interfaces.py55
1 files changed, 26 insertions, 29 deletions
diff --git a/plugins/modules/vyos_lag_interfaces.py b/plugins/modules/vyos_lag_interfaces.py
index 5c9b4c1..84f3d01 100644
--- a/plugins/modules/vyos_lag_interfaces.py
+++ b/plugins/modules/vyos_lag_interfaces.py
@@ -36,15 +36,13 @@ ANSIBLE_METADATA = {
"supported_by": "network",
}
-DOCUMENTATION = """
----
-module: vyos_lag_interfaces
-version_added: 2.9
+DOCUMENTATION = """module: vyos_lag_interfaces
short_description: Manages attributes of link aggregation groups on VyOS network devices.
-description: This module manages attributes of link aggregation groups on VyOS network devices.
+description: This module manages attributes of link aggregation groups on VyOS network
+ devices.
notes:
- - Tested against VyOS 1.1.8 (helium).
- - This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html).
+- Tested against VyOS 1.1.8 (helium).
+- This module works with connection C(network_cli). See L(the VyOS OS Platform Options,../network/user_guide/platform_vyos.html).
author: Rohit Thakur (@rohitthakur2590)
options:
config:
@@ -53,58 +51,58 @@ options:
suboptions:
name:
description:
- - Name of the link aggregation group (LAG) or bond.
+ - Name of the link aggregation group (LAG) or bond.
type: str
- required: True
+ required: true
mode:
description:
- - LAG or bond mode.
+ - LAG or bond mode.
type: str
choices:
- - 802.3ad
- - active-backup
- - broadcast
- - round-robin
- - transmit-load-balance
- - adaptive-load-balance
- - xor-hash
+ - 802.3ad
+ - active-backup
+ - broadcast
+ - round-robin
+ - transmit-load-balance
+ - adaptive-load-balance
+ - xor-hash
members:
description:
- - List of member interfaces for the LAG (bond).
+ - List of member interfaces for the LAG (bond).
type: list
suboptions:
member:
description:
- - Name of the member interface.
+ - Name of the member interface.
type: str
primary:
description:
- - Primary device interfaces for the LAG (bond).
+ - Primary device interfaces for the LAG (bond).
type: str
hash_policy:
description:
- - LAG or bonding transmit hash policy.
+ - LAG or bonding transmit hash policy.
type: str
choices:
- - layer2
- - layer2+3
- - layer3+4
+ - layer2
+ - layer2+3
+ - layer3+4
arp_monitor:
description:
- - ARP Link monitoring parameters.
+ - ARP Link monitoring parameters.
type: dict
suboptions:
interval:
description:
- - ARP link monitoring frequency in milliseconds.
+ - ARP link monitoring frequency in milliseconds.
type: int
target:
description:
- - IP address to use for ARP monitoring.
+ - IP address to use for ARP monitoring.
type: list
state:
description:
- - The state of the configuration after module completion.
+ - The state of the configuration after module completion.
type: str
choices:
- merged
@@ -112,7 +110,6 @@ options:
- overridden
- deleted
default: merged
-
"""
EXAMPLES = """
# Using merged