vyos.vyos.vyos_banner – Manage multiline banners on VyOS devices

vyos.vyos.vyos_banner – Manage multiline banners on VyOS devices

Note

This plugin is part of the vyos.vyos collection (version 1.1.0).

To install it use: ansible-galaxy collection install vyos.vyos.

To use it in a playbook, specify: vyos.vyos.vyos_banner.

New in version 1.0.0: of vyos.vyos

• Synopsis
• Parameters
• Notes
• Examples
• Return Values

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.

Note

This module has a corresponding action plugin.

Parameters

Parameter		Choices/Defaults	Comments
banner string / required		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		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		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		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 string		present ← absent	Specifies whether or not the configuration is present in the current devices active running configuration.
text string			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.
• For more information on using Ansible to manage network devices see the Ansible Network Guide

Examples

- 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:

Key	Returned	Description
commands list / elements=string	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']

Authors

• Trishna Guha (@trishnaguha)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/vyos/vyos/vyos_banner_module.html