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 2.6.1).

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 version 1.0.0: of ansible.netcommon

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

aggregate

string

List of logging definitions.

dest

string

Destination of the logs.

Choices:

  • console

  • host

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

Purge logging not defined in the aggregate parameter.

Default: “no”

state

string

State of the logging configuration.

Choices:

  • present ← (default)

  • absent

Notes

Note

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

commands

list / elements=string

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: [“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)