You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

net_banner - Manage multiline banners on network devices¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status
- Maintenance Info

Synopsis ¶

This will configure both login and motd banners on network devices. It allows playbooks to add or remote banner text from the active running configuration.

Options ¶

parameter	required	default	choices	comments
banner	yes		login motd	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 login banner
  net_banner:
    banner: login
    text: |
      this is my login banner
      that contains a multiline
      string
    state: present

- name: remove the motd banner
  net_banner:
    banner: motd
    state: absent

- name: Configure banner from file
  net_banner:
    banner:  motd
    text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
    state: present

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, except for the platforms that use Netconf transport to manage the device.	list	['banner login', 'this is my login banner', 'that contains a multiline', 'string']

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.