Note
This plugin is part of the ansible.netcommon collection.
To install it use: ansible-galaxy collection install ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.net_logging
.
New in version 1.0.0: of ansible.netcommon
major release after 2022-06-01
Updated modules released with more functionality
Use platform-specific “[netos]_logging” module
Note
This module has a corresponding action plugin.
Parameter | Choices/Defaults | Comments |
---|---|---|
aggregate string | List of logging definitions. | |
dest string |
| Destination of the logs. |
facility string | Set logging facility. | |
level string | Set logging severity levels. | |
name string | If value of dest is host it indicates file-name the host name to be notified. | |
purge string | Default: "no" | Purge logging not defined in the aggregate parameter. |
state string |
| State of the logging configuration. |
Note
ansible_network_os
network platforms. See the Network Platform Options for details.- 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
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: ['logging console critical'] |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/netcommon/net_logging_module.html