vyos.vyos.vyos_banner_module.rst

vyos.vyos.vyos_banner

Manage multiline banners on VyOS devices

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

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

Parameter	Choices/Defaults	Comments
banner string / required	Choices: pre-login post-login	Specifies which banner that should be configured on the remote device.
state string	Choices: 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 ansible.netcommon.network_cli. See the VyOS OS Platform Options.
• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <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	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)