cisco.ios.ios_logging module – (deprecated, removed after 2023-06-01) Manage logging on network devices

Note

This module is part of the cisco.ios collection (version 4.0.0).

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.ios.

To use it in a playbook, specify: cisco.ios.ios_logging.

New in cisco.ios 1.0.0

DEPRECATED

Removed in

major release after 2023-06-01

Why

Newer and updated modules released with more functionality.

Alternative

ios_logging_global

Synopsis

  • This module provides declarative management of logging on Cisco Ios 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.

On dest has to be quoted as ‘on’ or else pyyaml will convert to True before it gets to Ansible.

Choices:

  • "on"

  • "host"

  • "console"

  • "monitor"

  • "buffered"

  • "trap"

facility

string

Set logging facility.

level

string

Set logging severity levels.

Choices:

  • "emergencies"

  • "alerts"

  • "critical"

  • "errors"

  • "warnings"

  • "notifications"

  • "informational"

  • "debugging"

name

string

The hostname or IP address of the destination.

Required when dest=host.

size

integer

Size of buffer. The acceptable value is in range from 4096 to 4294967295 bytes.

state

string

State of the logging configuration.

Choices:

  • "present"

  • "absent"

dest

string

Destination of the logs.

On dest has to be quoted as ‘on’ or else pyyaml will convert to True before it gets to Ansible.

Choices:

  • "on"

  • "host"

  • "console"

  • "monitor"

  • "buffered"

  • "trap"

facility

string

Set logging facility.

level

string

Set logging severity levels.

Choices:

  • "emergencies"

  • "alerts"

  • "critical"

  • "errors"

  • "warnings"

  • "notifications"

  • "informational"

  • "debugging" ← (default)

name

string

The hostname or IP address of the destination.

Required when dest=host.

size

integer

Size of buffer. The acceptable value is in range from 4096 to 4294967295 bytes.

state

string

State of the logging configuration.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Tested against IOS 15.6

  • The ‘Default System Message Logging Configuration’ of the ios device like facility Local7 or logging on is not subjected to idempotency causes

  • 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 host logging
  cisco.ios.ios_logging:
    dest: host
    name: 172.16.0.1
    state: present

- name: remove host logging configuration
  cisco.ios.ios_logging:
    dest: host
    name: 172.16.0.1
    state: absent

- name: configure console logging level and facility
  cisco.ios.ios_logging:
    dest: console
    facility: local7
    level: debugging
    state: present

- name: enable logging to all
  cisco.ios.ios_logging:
    dest: on

- name: configure buffer size
  cisco.ios.ios_logging:
    dest: buffered
    size: 5000

- name: Configure logging using aggregate
  cisco.ios.ios_logging:
    aggregate:
    - {dest: console, level: notifications}
    - {dest: buffered, size: 9000}

- name: remove logging using aggregate
  cisco.ios.ios_logging:
    aggregate:
    - {dest: console, level: notifications}
    - {dest: buffered, size: 9000}
    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

Sample: ["logging facility local7", "logging host 172.16.0.1"]

Status

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

  • For more information see DEPRECATED.

Authors

  • Trishna Guha (@trishnaguha)