community.network.icx_banner – Manage multiline banners on Ruckus ICX 7000 series switches

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.icx_banner.

Synopsis

  • This will configure both login and motd banners on remote ruckus ICX 7000 series switches. It allows playbooks to add or remove banner text from the active running configuration.

Parameters

Parameter Choices/Defaults Comments
banner
string / required
    Choices:
  • motd
  • exec
  • incoming
Specifies which banner should be configured on the remote device.
check_running_config
boolean
    Choices:
  • no
  • yes ←
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter.
enterkey
boolean
    Choices:
  • no
  • yes
Specifies whether or not the motd configuration should accept the require-enter-key
Default is false.
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.

Notes

Note

  • Tested against ICX 10.1

Examples

- name: Configure the motd banner
  community.network.icx_banner:
    banner: motd
    text: |
        this is my motd banner
        that contains a multiline
        string
    state: present

- name: Remove the motd banner
  community.network.icx_banner:
    banner: motd
    state: absent

- name: Configure require-enter-key for motd
  community.network.icx_banner:
    banner: motd
    enterkey: True

- name: Remove require-enter-key for motd
  community.network.icx_banner:
    banner: motd
    enterkey: False

Return Values

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

Key Returned Description
commands
list / elements=string
always
The list of configuration mode commands to send to the device

Sample:
['banner motd', 'this is my motd banner', 'that contains a multiline', 'string']


Authors

  • Ruckus Wireless (@Commscope)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/icx_banner_module.html