net_logging - Manage logging on network devices
New in version 2.4.
Synopsis
- This module provides declarative management of logging on network devices.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
aggregate |
no |
List of logging definitions.
|
||
dest |
no |
|
Destination of the logs.
|
|
facility |
no |
Set logging facility.
|
||
level |
no |
Set logging severity levels.
|
||
name |
no |
If value of
dest is
host it indicates file-name the host name to be notified.
|
||
purge |
no |
Purge logging not defined in the
aggregate parameter.
|
||
state |
no | present |
|
State of the logging configuration.
|
Examples
- name: configure console logging net_logging: dest: console facility: any level: critical - name: remove console logging configuration net_logging: dest: console state: absent - name: configure host logging net_logging: dest: host name: 1.1.1.1 facility: kernel level: critical - name: Configure file logging using aggregate 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 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 Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
commands |
The list of configuration mode commands to send to the device
|
always, except for the platforms that use Netconf transport to manage the device. | list | ['logging console critical'] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/net_logging_module.html