Documentation

vyos_banner - Manage multiline banners on VyOS devices

New in version 2.4.

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.

Options

parameter required default choices comments
banner
 yes
  • pre-login
  • post-login
Specifies which banner that should be configured on the remote device.
state
 no present
  • present
  • absent
Specifies whether or not the configuration is present in the current devices active running configuration.
text
 no
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.

Examples

- name: configure the pre-login banner
  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_banner:
    banner: post-login
    state: absent

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
commands
The list of configuration mode commands to send to the device
 always list ['banner pre-login', 'this is my pre-login banner', 'that contains a multiline', 'string']


Notes

Note

  • Tested against VYOS 1.1.7

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.