ansible.builtin.eos_banner (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

This will configure both login and motd banners on remote devices running Arista EOS. It allows playbooks to add or remote 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 login banner
  eos_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
  eos_banner:
    banner: motd
    state: absent

Inputs

    
text:
    description:
    - The banner text that should be present in the remote device running configuration.  This
      argument accepts a multiline string. 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.

banner:
    choices:
    - login
    - motd
    description:
    - Specifies which banner that should be configured on the remote device.
    required: true

provider:
    description:
    - B(Deprecated)
    - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
    - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for eAPI.'
    - This option will be removed in a release after 2022-06-01.
    - For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html).
    - HORIZONTALLINE
    - A dict object containing connection details.
    suboptions:
      auth_pass:
        description:
        - Specifies the password to use if required to enter privileged mode on the remote
          device.  If I(authorize) is false, then this argument does nothing. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
          will be used instead.
        type: str
      authorize:
        default: false
        description:
        - Instructs the module to enter privileged mode on the remote device before sending
          any commands.  If not specified, the device will attempt to execute all commands
          in non-privileged mode. If the value is not specified in the task, the value
          of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead.
        type: bool
      host:
        description:
        - Specifies the DNS host name or address for connecting to the remote device over
          the specified transport.  The value of host is used as the destination address
          for the transport.
        type: str
      password:
        description:
        - Specifies the password to use to authenticate the connection to the remote device.  This
          is a common argument used for either I(cli) or I(eapi) transports. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
          will be used instead.
        type: str
      port:
        default: 0
        description:
        - Specifies the port to use when building the connection to the remote device.  This
          value applies to either I(cli) or I(eapi).
        - The port value will default to the appropriate transport common port if none
          is provided in the task (cli=22, http=80, https=443).
        type: int
      ssh_keyfile:
        description:
        - Specifies the SSH keyfile to use to authenticate the connection to the remote
          device.  This argument is only used for I(cli) transports. If the value is not
          specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
          will be used instead.
        type: path
      timeout:
        description:
        - Specifies the timeout in seconds for communicating with the network device for
          either connecting or sending commands.  If the timeout is exceeded before the
          operation is completed, the module will error.
        type: int
      transport:
        choices:
        - cli
        - eapi
        default: cli
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      use_proxy:
        default: true
        description:
        - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
          ignored.
        type: bool
      use_ssl:
        default: true
        description:
        - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=eapi).  If
          the transport argument is not eapi, this value is ignored.
        type: bool
      username:
        description:
        - Configures the username to use to authenticate the connection to the remote
          device.  This value is used to authenticate either the CLI login or the eAPI
          authentication depending on which transport is used. If the value is not specified
          in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will
          be used instead.
        type: str
      validate_certs:
        default: true
        description:
        - If C(no), SSL certificates will not be validated. This should only be used on
          personally controlled sites using self-signed certificates.  If the transport
          argument is not eapi, this value is ignored.
        type: bool
    type: dict

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  sample:
  - banner login
  - this is my login banner
  - that contains a multiline
  - string
  - EOF
  type: list
session_name:
  description: The EOS config session name used to load the configuration
  returned: if changes
  sample: ansible_1479315771
  type: str