summaryrefslogtreecommitdiff
path: root/plugins/modules/vyos_banner.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_banner.py
parentd31b74ba6c74a6e3cdebd80b9eb5272aeb9b0fb4 (diff)
downloadvyos-ansible-old-6b6166151faa3d811ae0ec3010a89e518a26287b.tar.gz
vyos-ansible-old-6b6166151faa3d811ae0ec3010a89e518a26287b.zip
Updated from network content collector
Signed-off-by: CaptTrews <capttrews@gmail.com>
Diffstat (limited to 'plugins/modules/vyos_banner.py')
-rw-r--r--plugins/modules/vyos_banner.py39
1 files changed, 19 insertions, 20 deletions
diff --git a/plugins/modules/vyos_banner.py b/plugins/modules/vyos_banner.py
index 81a985d..b08fb73 100644
--- a/plugins/modules/vyos_banner.py
+++ b/plugins/modules/vyos_banner.py
@@ -25,38 +25,37 @@ ANSIBLE_METADATA = {
"supported_by": "network",
}
-DOCUMENTATION = """
----
-module: vyos_banner
-version_added: "2.4"
-author: "Trishna Guha (@trishnaguha)"
+DOCUMENTATION = """module: vyos_banner
+author: Trishna Guha (@trishnaguha)
short_description: Manage multiline banners on VyOS devices
description:
- - This will configure both pre-login and post-login banners on remote
- devices running VyOS. It allows playbooks to add or remote
- banner text from the active running configuration.
+- This will configure both pre-login and post-login banners on remote devices running
+ VyOS. It allows playbooks to add or remote banner text from the active running configuration.
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).
options:
banner:
description:
- - Specifies which banner that should be
- configured on the remote device.
+ - Specifies which banner that should be configured on the remote device.
required: true
- choices: ['pre-login', 'post-login']
+ choices:
+ - pre-login
+ - post-login
text:
description:
- - The banner text that should be
- present in the remote device running configuration. This argument
- accepts a multiline string, with no empty lines. Requires I(state=present).
+ - The banner text that should be present in the remote device running configuration.
+ This argument accepts a multiline string, with no empty lines. Requires I(state=present).
state:
description:
- - Specifies whether or not the configuration is present in the current
- devices active running configuration.
+ - Specifies whether or not the configuration is present in the current devices
+ active running configuration.
default: present
- choices: ['present', 'absent']
-extends_documentation_fragment: vyos
+ choices:
+ - present
+ - absent
+extends_documentation_fragment:
+- vyos.vyos.vyos
"""
EXAMPLES = """