cisco.nxos.nxos_logging module – Manage logging on network devices

Note

This module is part of the cisco.nxos collection (version 4.0.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 cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_logging.

New in cisco.nxos 1.0.0

DEPRECATED

Removed in

major release after 2023-08-01

Why

Updated module released with more functionality.

Alternative

nxos_logging_global

Synopsis

  • This module provides declarative management of logging on Cisco NX-OS devices.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

aggregate

list / elements=dictionary

List of logging definitions.

dest

string

Destination of the logs.

Choices:

  • "console"

  • "logfile"

  • "module"

  • "monitor"

  • "server"

dest_level

aliases: level

integer

Set logging severity levels.

event

string

Link/trunk enable/default interface configuration logging

Choices:

  • "link-enable"

  • "link-default"

  • "trunk-enable"

  • "trunk-default"

facility

string

Facility name for logging.

facility_level

integer

Set logging severity levels for facility based log messages.

string

Set logging facility ethpm link status. Not idempotent with version 6.0 images.

Choices:

  • "link-down-notif"

  • "link-down-error"

  • "link-up-notif"

  • "link-up-error"

file_size

integer

Set logfile size

interface

string

Interface to be used while configuring source-interface for logging (e.g., ‘Ethernet1/2’, ‘mgmt0’)

interface_message

string

Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport.

Choices:

  • "add-interface-description"

name

string

If value of dest is logfile it indicates file-name.

purge

boolean

Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type.

Choices:

  • false ← (default)

  • true

remote_server

string

Hostname or IP Address for remote logging (when dest is ‘server’).

state

string

State of the logging configuration.

Choices:

  • "present" ← (default)

  • "absent"

timestamp

string

Set logging timestamp format

Choices:

  • "microseconds"

  • "milliseconds"

  • "seconds"

use_vrf

string

VRF to be used while configuring remote logging (when dest is ‘server’).

Notes

Note

  • Limited Support for Cisco MDS

  • For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`

  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

- name: configure console logging with level
  cisco.nxos.nxos_logging:
    dest: console
    level: 2
    state: present
- name: remove console logging configuration
  cisco.nxos.nxos_logging:
    dest: console
    level: 2
    state: absent
- name: configure file logging with level
  cisco.nxos.nxos_logging:
    dest: logfile
    name: testfile
    dest_level: 3
    state: present
- name: Configure logging logfile with size
  cisco.nxos.nxos_logging:
    dest: logfile
    name: testfile
    dest_level: 3
    file_size: 16384
- name: configure facility level logging
  cisco.nxos.nxos_logging:
    facility: daemon
    facility_level: 0
    state: present
- name: remove facility level logging
  cisco.nxos.nxos_logging:
    facility: daemon
    facility_level: 0
    state: absent
- name: Configure Remote Logging
  cisco.nxos.nxos_logging:
    dest: server
    remote_server: test-syslogserver.com
    facility: auth
    facility_level: 1
    use_vrf: management
    state: present
- name: Configure Source Interface for Logging
  cisco.nxos.nxos_logging:
    interface: mgmt0
    state: present
- name: Purge nxos_logging configuration not managed by this playbook
  cisco.nxos.nxos_logging:
    purge: true
- name: Configure logging timestamp
  cisco.nxos.nxos_logging:
    timestamp: milliseconds
    state: present
- name: Configure logging facility ethpm link status
  cisco.nxos.nxos_logging:
    facility: ethpm
    facility_link_status: link-up-notif
    state: present
- name: Configure logging message ethernet description
  cisco.nxos.nxos_logging:
    interface_message: add-interface-description
    state: present
- name: Configure logging event link enable
  cisco.nxos.nxos_logging:
    event: link-enable
    state: present
- name: Configure logging using aggregate
  cisco.nxos.nxos_logging:
    aggregate:
    - {dest: console, dest_level: 2}
    - {dest: logfile, dest_level: 2, name: testfile}
    - {facility: daemon, facility_level: 0}
    state: present

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

Sample: ["logging console 2", "logging logfile testfile 3", "logging level daemon 0"]

Status

  • This module will be removed in a major release after 2023-08-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Trishna Guha (@trishnaguha)