ansible.builtin.junos_banner (v2.4.4.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.4.4.0.post1

Description

This will configure both login and motd banners on network devices. It allows playbooks to add or remote banner text from the active running configuration.

Requirements

• ncclient (>=v0.5.2)

Usage examples

Scanned by Steampunk Spotter

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

- name: configure the login banner
  junos_banner:
    banner: login
    text: |
      this is my login 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
  junos_banner:
    banner: motd
    state: absent

Scanned by Steampunk Spotter

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

- name: deactivate the motd banner
  junos_banner:
    banner: motd
    state: present
    active: False

Scanned by Steampunk Spotter

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

- name: activate the motd banner
  junos_banner:
    banner: motd
    state: present
    active: True

Scanned by Steampunk Spotter

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

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

Inputs

    
text:
    default: null
    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).

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

active:
    choices:
    - true
    - false
    default: true
    description:
    - Specifies whether or not the configuration is active or deactivated

banner:
    choices:
    - login
    - motd
    description:
    - Specifies which banner that should be configured on the remote device. Value C(login)
      indicates system login message prior to authenticating, C(motd) is login announcement
      after successful authentication.
    required: true

Outputs

diff.prepared:
  description: Configuration difference before and after applying change.
  returned: when configuration is changed and diff option is enabled.
  sample: '[edit system login] +   message "this is my login banner";

    '
  type: string