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

Note

This module is part of the community.network collection (version 4.0.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 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

Comments

banner

string / required

Specifies which banner should be configured on the remote device.

Choices:

  • motd

  • exec

  • incoming

check_running_config

boolean

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.

Choices:

  • no

  • yes ← (default)

enterkey

boolean

Specifies whether or not the motd configuration should accept the require-enter-key

Default is false.

Choices:

  • no

  • yes

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.

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

Description

commands

list / elements=string

The list of configuration mode commands to send to the device

Returned: always

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

Authors

  • Ruckus Wireless (@Commscope)