ansible.netcommon.net_logging module – (deprecated, removed after 2022-06-01) Manage logging on network devices
Note
This module is part of the ansible.netcommon collection (version 3.1.3).
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_logging
.
New in ansible.netcommon 1.0.0
DEPRECATED
- Removed in:
major release after 2022-06-01
- Why:
Updated modules released with more functionality
- Alternative:
Use platform-specific “[netos]_logging” module
Synopsis
This module provides declarative management of logging on network devices.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
List of logging definitions. |
|
Destination of the logs. Choices:
|
|
Set logging facility. |
|
Set logging severity levels. |
|
If value of |
|
Purge logging not defined in the aggregate parameter. Default: |
|
State of the logging configuration. Choices:
|
Notes
Note
This module is supported on
ansible_network_os
network platforms. See the :ref:`Network Platform Options <platform_options>` for details.
Examples
- name: configure console logging
ansible.netcommon.net_logging:
dest: console
facility: any
level: critical
- name: remove console logging configuration
ansible.netcommon.net_logging:
dest: console
state: absent
- name: configure host logging
ansible.netcommon.net_logging:
dest: host
name: 192.0.2.1
facility: kernel
level: critical
- name: Configure file logging using aggregate
ansible.netcommon.net_logging:
dest: file
aggregate:
- name: test-1
facility: pfe
level: critical
- name: test-2
facility: kernel
level: emergency
- name: Delete file logging using aggregate
ansible.netcommon.net_logging:
dest: file
aggregate:
- name: test-1
facility: pfe
level: critical
- name: test-2
facility: kernel
level: emergency
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, except for the platforms that use Netconf transport to manage the device. Sample: |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.