| banner |
- / required
| || |
Specifies which banner that should be configured on the remote device.
| provider |
Starting with Ansible 2.5 we recommend using
For more information please see the Network Guide.
A dict object containing connection details.
| host |
string / required
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.
| password |
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
| port |
| Default: |
Specifies the port to use when building the connection to the remote device.
| ssh_keyfile |
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
| timeout |
| Default: |
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.
| username |
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
| state |
| || |
Specifies whether or not the configuration is present in the current devices active running configuration.
| text |
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.
- name: configure the pre-login banner vyos_banner: banner: pre-login text: | this is my pre-login banner that contains a multiline string state: present - name: remove the post-login banner vyos_banner: banner: post-login state: absent
Common return values are documented here, the following are the fields unique to this module:
| commands |
The list of configuration mode commands to send to the device
['banner pre-login', 'this is my pre-login banner', 'that contains a multiline', 'string']
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.