From 84afad5130564a8ad48e756cca1566c17eaafc36 Mon Sep 17 00:00:00 2001 From: Rohit Date: Thu, 18 Jun 2020 01:48:45 +0530 Subject: [VyOS]: update readme and add .rst files (#44) [VyOS]: update readme and add .rst files Reviewed-by: https://github.com/apps/ansible-zuul --- docs/vyos.vyos.vyos_banner_module.rst | 289 ++++++++++++++++++++++++++++++++++ 1 file changed, 289 insertions(+) create mode 100644 docs/vyos.vyos.vyos_banner_module.rst (limited to 'docs/vyos.vyos.vyos_banner_module.rst') diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst new file mode 100644 index 0000000..0daa5d1 --- /dev/null +++ b/docs/vyos.vyos.vyos_banner_module.rst @@ -0,0 +1,289 @@ +:orphan: + +.. _vyos.vyos.vyos_banner_module: + + +********************* +vyos.vyos.vyos_banner +********************* + +**Manage multiline banners on VyOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- 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. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ banner + +
+ - + / required
+ 		+
    Choices: +
  • pre-login
    • +
  • post-login
    • +
+ 		+
Specifies which banner that should be configured on the remote device.
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string + / required
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ Default:
22
+ 		+
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ Default:
10
+ 		+
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ state + +
+ - +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Specifies whether or not the configuration is present in the current devices active running configuration.
+
+
+ text + +
+ - +
+ 		+ +
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. Requires state=present.
+
+
+ + +Notes +----- + +.. note:: + - Tested against VyOS 1.1.8 (helium). + - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: configure the pre-login banner + vyos.vyos.vyos_banner: + banner: pre-login + text: | + this is my pre-login banner + that contains a multiline + string + state: present + - name: remove the post-login banner + vyos.vyos.vyos_banner: + banner: post-login + state: absent + + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['banner pre-login', 'this is my pre-login banner', 'that contains a multiline', 'string']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Trishna Guha (@trishnaguha) + + +.. hint:: + Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. -- cgit v1.2.3