cisco.nxos.nxos_banner (7.0.0) — module

Install collection

Install with ansible-galaxy collection install cisco.nxos:==7.0.0

Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 7.0.0

Description

This will configure both exec and motd banners on remote devices running Cisco NXOS. 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 exec banner
  cisco.nxos.nxos_banner:
    banner: exec
    text: |
      this is my exec 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
  cisco.nxos.nxos_banner:
    banner: motd
    state: absent

Scanned by Steampunk Spotter

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

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

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. Requires I(state=present).
    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:
    - exec
    - motd
    description:
    - Specifies which banner that should be configured on the remote device.
    required: true
    type: str

multiline_delimiter:
    default: '@'
    description: Specify the delimiting character than will be used for configuration.
    type: str

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  sample:
  - banner exec
  - this is my exec banner
  - that contains a multiline
  - string
  type: list