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.

cisco.ios.ios_banner module – Module to configure multiline banners.

Note

This module is part of the cisco.ios collection (version 4.6.1).

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 cisco.ios.

To use it in a playbook, specify: cisco.ios.ios_banner.

New in cisco.ios 1.0.0

Synopsis

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

Note

This module has a corresponding action plugin.

Aliases: banner

Parameters

Parameter	Comments
banner string / required	Specifies which banner should be configured on the remote device. In Ansible 2.4 and earlier only login and motd were supported. Choices: "login" "motd" "exec" "incoming" "slip-ppp"
multiline_delimiter string	Specify the delimiting character than will be used for configuration. Default: "@"
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 Cisco IOSXE Version 17.3 on CML.

• This module works with connection network_cli. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html

• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

• For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

- name: Configure the login banner
  cisco.ios.ios_banner:
    banner: login
    text: |
      this is my login banner
      that contains a multiline
      string
    state: present

- name: Remove the motd banner
  cisco.ios.ios_banner:
    banner: motd
    state: absent

- name: Configure banner from file
  cisco.ios.ios_banner:
    banner: motd
    text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" # Use unix formatted text files (LF not CRLF) to avoid idempotency issues.
    state: present

- name: Configure the login banner using delimiter
  cisco.ios.ios_banner:
    banner: login
    multiline_delimiter: x
    text: this is my login banner
    state: present

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 login", "this is my login banner", "that contains a multiline", "string"]

Authors

• Ricardo Carrillo Cruz (@rcarrillocruz)

Collection links

• Issue Tracker
• Repository (Sources)