cisco.ios.ios_logging – (deprecated, removed after 2023-06-01) Manage logging on network devices
Note
This plugin is part of the cisco.ios collection (version 2.6.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 cisco.ios
.
To use it in a playbook, specify: cisco.ios.ios_logging
.
New in version 1.0.0: of cisco.ios
DEPRECATED
- Removed in
major release after 2023-06-01
- Why
Newer and updated modules released with more functionality.
- Alternative
ios_logging_global
Synopsis
This module provides declarative management of logging on Cisco Ios devices.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
List of logging definitions. |
|
Destination of the logs. On dest has to be quoted as ‘on’ or else pyyaml will convert to True before it gets to Ansible. Choices:
|
|
Set logging facility. |
|
Set logging severity levels. Choices:
|
|
The hostname or IP address of the destination. Required when dest=host. |
|
Size of buffer. The acceptable value is in range from 4096 to 4294967295 bytes. |
|
State of the logging configuration. Choices:
|
|
Destination of the logs. On dest has to be quoted as ‘on’ or else pyyaml will convert to True before it gets to Ansible. Choices:
|
|
Set logging facility. |
|
Set logging severity levels. Choices:
|
|
The hostname or IP address of the destination. Required when dest=host. |
|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html. A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
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. |
|
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 |
|
Specifies the port to use when building the connection to the remote device. |
|
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 |
|
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. |
|
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 |
|
Size of buffer. The acceptable value is in range from 4096 to 4294967295 bytes. |
|
State of the logging configuration. Choices:
|
Notes
Note
Tested against IOS 15.6
The ‘Default System Message Logging Configuration’ of the ios device like facility Local7 or logging on is not subjected to idempotency causes
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
cisco.ios.ios_logging:
dest: host
name: 172.16.0.1
state: present
- name: remove host logging configuration
cisco.ios.ios_logging:
dest: host
name: 172.16.0.1
state: absent
- name: configure console logging level and facility
cisco.ios.ios_logging:
dest: console
facility: local7
level: debugging
state: present
- name: enable logging to all
cisco.ios.ios_logging:
dest: on
- name: configure buffer size
cisco.ios.ios_logging:
dest: buffered
size: 5000
- name: Configure logging using aggregate
cisco.ios.ios_logging:
aggregate:
- {dest: console, level: notifications}
- {dest: buffered, size: 9000}
- name: remove logging using aggregate
cisco.ios.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 |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: [“logging facility local7”, “logging host 172.16.0.1”] |
Status
This module will be removed in a major release after 2023-06-01. [deprecated]
For more information see DEPRECATED.
Authors
Trishna Guha (@trishnaguha)