ios_logging - Manage logging on network devices
New in version 2.4.
Synopsis
- This module provides declarative management of logging on Cisco Ios devices.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate | List of logging definitions. | ||
auth_pass | Default: none | Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli and become: yes with become_pass .For more information please see the IOS Platform Options guide. Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead. | |
authorize |
| Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli and become: yes .For more information please see the IOS Platform Options guide. 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 ANSIBLE_NET_AUTHORIZE will be used instead. | |
dest |
| Destination of the logs. | |
facility | Set logging facility. | ||
level | Set logging severity levels. | ||
name | If value of dest is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified. | ||
provider | Default: None | Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli .For more information please see the IOS Platform Options guide. A dict object containing connection details. | |
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 ANSIBLE_NET_USERNAME will be used instead. | ||
authorize |
| 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 ANSIBLE_NET_AUTHORIZE will be used instead. | |
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 ANSIBLE_NET_SSH_KEYFILE will be used instead. | ||
auth_pass | Default: none | Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead. | |
host 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. | ||
timeout | Default: 10 | 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. | |
password | Default: None | 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 ANSIBLE_NET_PASSWORD will be used instead. | |
port | Default: 22 | Specifies the port to use when building the connection to the remote device. | |
size | Default: 4096 | Size of buffer. The acceptable value is in range from 4096 to 4294967295 bytes. | |
state |
| State of the logging configuration. |
Notes
Note
- Tested against IOS 15.6
- For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Examples
- name: configure host logging ios_logging: dest: host name: 172.16.0.1 state: present - name: remove host logging configuration ios_logging: dest: host name: 172.16.0.1 state: absent - name: configure console logging level and facility ios_logging: dest: console facility: local7 level: debugging state: present - name: enable logging to all ios_logging: dest : on - name: configure buffer size ios_logging: dest: buffered size: 5000 - name: Configure logging using aggregate ios_logging: aggregate: - { dest: console, level: notifications } - { dest: buffered, size: 9000 } - name: remove logging using aggregate ios_logging: aggregate: - { dest: console, level: notifications } - { dest: buffered, size: 9000 } state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands list | always | The list of configuration mode commands to send to the device Sample: ['logging facility local7', 'logging host 172.16.0.1'] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Support
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Author
- Trishna Guha (@trishnaguha)
Hint
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.
https://docs.ansible.com/ansible/2.5/modules/ios_logging_module.html