ansible.netcommon.net_banner – (deprecated, removed after 2022-06-01) Manage multiline banners on network devices
Note
This plugin is part of the ansible.netcommon collection (version 2.4.0).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.net_banner
.
New in version 1.0.0: of ansible.netcommon
DEPRECATED
- Removed in
-
major release after 2022-06-01
- Why
-
Updated modules released with more functionality
- Alternative
-
Use platform-specific “[netos]_banner” module
Synopsis
- This will configure both login and motd banners on network devices. It allows playbooks to add or remove banner text from the active running configuration.
Note
This module has a corresponding action plugin.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
banner string / required |
| Specifies which banner that should be configured on the remote device. |
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. Requires state=present. |
Notes
Note
- This module is supported on
ansible_network_os
network platforms. See the Network Platform Options for details.
Examples
- name: configure the login banner ansible.netcommon.net_banner: banner: login text: | this is my login banner that contains a multiline string state: present - name: remove the motd banner ansible.netcommon.net_banner: banner: motd state: absent - name: Configure banner from file ansible.netcommon.net_banner: banner: motd text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}" state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands list / elements=string | always, except for the platforms that use Netconf transport to manage the device. | The list of configuration mode commands to send to the device Sample: ['banner login', 'this is my login banner', 'that contains a multiline', 'string'] |
Status
- This module will be removed in a major release after 2022-06-01. [deprecated]
- For more information see DEPRECATED.
Authors
- Ricardo Carrillo Cruz (@rcarrillocruz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/netcommon/net_banner_module.html