ansible.netcommon.net_logging – (deprecated, removed after 2022-06-01) Manage logging on network devices

Note

This plugin is part of the ansible.netcommon collection (version 1.4.1).

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

DEPRECATED
Synopsis
Parameters
Notes
Examples
Return Values
Status

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	Choices/Defaults	Comments
aggregate string		List of logging definitions.
dest string	console host	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	present ← absent	State of the logging configuration.

Notes

Note

This module is supported on ansible_network_os network platforms. See the Network 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	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']

Status

This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.

Authors

Ganesh Nalawade (@ganeshrn)

© 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