summaryrefslogtreecommitdiff
path: root/plugins/modules/vyos_l3_interfaces.py
diff options
context:
space:
mode:
authorCaptTrews <capttrews@gmail.com>2020-01-16 15:50:24 +0000
committerCaptTrews <capttrews@gmail.com>2020-01-16 15:50:24 +0000
commit6b6166151faa3d811ae0ec3010a89e518a26287b (patch)
tree9cf59872c2ddc7e99595db4f47c72a7ce08b6c10 /plugins/modules/vyos_l3_interfaces.py
parentd31b74ba6c74a6e3cdebd80b9eb5272aeb9b0fb4 (diff)
downloadvyos-ansible-collection-6b6166151faa3d811ae0ec3010a89e518a26287b.tar.gz
vyos-ansible-collection-6b6166151faa3d811ae0ec3010a89e518a26287b.zip
Updated from network content collector
Signed-off-by: CaptTrews <capttrews@gmail.com>
Diffstat (limited to 'plugins/modules/vyos_l3_interfaces.py')
-rw-r--r--plugins/modules/vyos_l3_interfaces.py36
1 files changed, 16 insertions, 20 deletions
diff --git a/plugins/modules/vyos_l3_interfaces.py b/plugins/modules/vyos_l3_interfaces.py
index 113ea53..a77ecaf 100644
--- a/plugins/modules/vyos_l3_interfaces.py
+++ b/plugins/modules/vyos_l3_interfaces.py
@@ -36,15 +36,12 @@ ANSIBLE_METADATA = {
"supported_by": "network",
}
-DOCUMENTATION = """
----
-module: vyos_l3_interfaces
-version_added: 2.9
+DOCUMENTATION = """module: vyos_l3_interfaces
short_description: Manages L3 interface attributes of VyOS network devices.
description: This module manages the L3 interface attributes 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: Nilashish Chakraborty (@NilashishC)
options:
config:
@@ -54,62 +51,62 @@ options:
suboptions:
name:
description:
- - Full name of the interface, e.g. eth0, eth1.
+ - Full name of the interface, e.g. eth0, eth1.
type: str
- required: True
+ required: true
ipv4:
description:
- - List of IPv4 addresses of the interface.
+ - List of IPv4 addresses of the interface.
type: list
elements: dict
suboptions:
address:
description:
- - IPv4 address of the interface.
+ - IPv4 address of the interface.
type: str
ipv6:
description:
- - List of IPv6 addresses of the interface.
+ - List of IPv6 addresses of the interface.
type: list
elements: dict
suboptions:
address:
description:
- - IPv6 address of the interface.
+ - IPv6 address of the interface.
type: str
vifs:
description:
- - Virtual sub-interfaces L3 configurations.
+ - Virtual sub-interfaces L3 configurations.
elements: dict
type: list
suboptions:
vlan_id:
description:
- - Identifier for the virtual sub-interface.
+ - Identifier for the virtual sub-interface.
type: int
ipv4:
description:
- - List of IPv4 addresses of the virtual interface.
+ - List of IPv4 addresses of the virtual interface.
type: list
elements: dict
suboptions:
address:
description:
- - IPv4 address of the virtual interface.
+ - IPv4 address of the virtual interface.
type: str
ipv6:
description:
- - List of IPv6 addresses of the virtual interface.
+ - List of IPv6 addresses of the virtual interface.
type: list
elements: dict
suboptions:
address:
description:
- - IPv6 address of the virtual interface.
+ - IPv6 address of the virtual interface.
type: str
state:
description:
- - The state of the configuration after module completion.
+ - The state of the configuration after module completion.
type: str
choices:
- merged
@@ -117,7 +114,6 @@ options:
- overridden
- deleted
default: merged
-
"""
EXAMPLES = """
# Using merged