alliedtelesis.awplus.awplus_banner (1.2.2) — module

Install collection

Install with ansible-galaxy collection install alliedtelesis.awplus:==1.2.2

Add to requirements.yml

  collections:
    - name: alliedtelesis.awplus
      version: 1.2.2

Description

This module configures the banners of AlliedWare Plus devices.

Usage examples

Scanned by Steampunk Spotter

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

# Using merged
#
# Before state:
# -------------
# aw1#show running-config | include banner
# no banner motd

- name: Configure exec banner
  alliedtelesis.awplus.awplus_banner:
    config:
      - banner: exec
        text: ansible exec banner
    state: merged

Scanned by Steampunk Spotter

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

# After state:
# ------------
# aw1#show running-config bgp
# banner exec ansible exec banner
# no banner motd


# Using replaced
#
# Before state:
# -------------
# aw1#show running-config | include banner
# banner exec ansible exec banner
# banner motd ansible motd banner

- name: Replace device configuration with provided configuration
  alliedtelesis.awplus.awplus_banner:
    config:
      - banner: motd
        text: ansible motd banner 2
    state: replaced

Scanned by Steampunk Spotter

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

# After state:
# ------------
# aw1#show running-config | include banner
# banner motd ansible motd banner 2


# Using deleted
#
# Before state:
# -------------
# aw1#show running-config | include banner
# banner exec ansible exec banner
# banner motd ansible motd banner

- name: Delete banner configuration
  alliedtelesis.awplus.awplus_banner:
    state: deleted

Inputs

    
state:
    choices:
    - merged
    - replaced
    - deleted
    default: merged
    description:
    - The state the configuration should be left in
    type: str

config:
    description: The provided configuration.
    elements: dict
    suboptions:
      banner:
        choices:
        - motd
        - exec
        description:
        - Set the 'Message of the Day' banner to be displayed before login or the banner
          to be displayed following a successful login.
        required: true
        type: str
      text:
        description:
        - The banner text that should be displayed in the remote device running configuration.
        type: str
    type: list

Outputs

after:
  description: The resulting configuration model invocation.
  returned: when changed
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
before:
  description: The configuration prior to the model invocation.
  returned: always
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
commands:
  description: The set of commands pushed to the remote device.
  returned: always
  sample:
  - banner exec ansible exec banner
  - no banner motd
  type: list