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

Note

This module is part of the vyos.vyos collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in vyos.vyos 1.0.0

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.

Aliases: banner

Parameters

Parameter

Comments

banner

string / required

Specifies which banner that should be configured on the remote device.

Choices:

  • "pre-login"

  • "post-login"

state

string

Specifies whether or not the configuration is present in the current devices active running configuration.

Choices:

  • "present" ← (default)

  • "absent"

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

Description

commands

list / elements=string

The list of configuration mode commands to send to the device

Returned: always

Sample: ["banner pre-login", "this is my pre-login banner", "that contains a multiline", "string"]

Authors

  • Trishna Guha (@trishnaguha)