Note
This plugin is part of the community.network collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.icx_banner.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| banner string / required |
| Specifies which banner should be configured on the remote device. |
| check_running_config boolean |
| 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. |
| enterkey boolean |
| Specifies whether or not the motd configuration should accept the require-enter-key Default is false. |
| state string |
| Specifies whether or not the configuration is present in the current devices active running configuration. |
| text string | The banner text that should be present in the remote device running configuration. This argument accepts a multiline string, with no empty lines. |
Note
- name: Configure the motd banner
community.network.icx_banner:
banner: motd
text: |
this is my motd banner
that contains a multiline
string
state: present
- name: Remove the motd banner
community.network.icx_banner:
banner: motd
state: absent
- name: Configure require-enter-key for motd
community.network.icx_banner:
banner: motd
enterkey: True
- name: Remove require-enter-key for motd
community.network.icx_banner:
banner: motd
enterkey: False
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| commands list / elements=string | always | The list of configuration mode commands to send to the device Sample: ['banner motd', 'this is my motd banner', 'that contains a multiline', 'string'] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/icx_banner_module.html