community.general.icx_banner (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure the motd banner
  icx_banner:
    banner: motd
    text: |
        this is my motd banner
        that contains a multiline
        string
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure require-enter-key for motd
  icx_banner:
    banner: motd
    enterkey: True

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: remove require-enter-key for motd
  icx_banner:
    banner: motd
    enterkey: False

Inputs

    
text:
    description:
    - The banner text that should be present in the remote device running configuration.
      This argument accepts a multiline string, with no empty lines.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specifies whether or not the configuration is present in the current devices active
      running configuration.
    type: str

banner:
    choices:
    - motd
    - exec
    - incoming
    description:
    - Specifies which banner should be configured on the remote device.
    required: true
    type: str

enterkey:
    default: false
    description:
    - Specifies whether or not the motd configuration should accept the require-enter-key
    type: bool

check_running_config:
    default: true
    description:
    - 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.
    type: bool

Outputs

commands:
  description: 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
  type: list