ansible.builtin.ios_logging (v2.9.24) — module

Manage logging on network devices

| "added in version" 2.4 of ansible.builtin"

Authors: Trishna Guha (@trishnaguha)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

This module provides declarative management of logging on Cisco Ios devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure host logging
  ios_logging:
    dest: host
    name: 172.16.0.1
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove host logging configuration
  ios_logging:
    dest: host
    name: 172.16.0.1
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure console logging level and facility
  ios_logging:
    dest: console
    facility: local7
    level: debugging
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: enable logging to all
  ios_logging:
    dest : on
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure buffer size
  ios_logging:
    dest: buffered
    size: 5000
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure logging using aggregate
  ios_logging:
    aggregate:
      - { dest: console, level: notifications }
      - { dest: buffered, size: 9000 }
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove logging using aggregate
  ios_logging:
    aggregate:
      - { dest: console, level: notifications }
      - { dest: buffered, size: 9000 }
    state: absent

Inputs

    
dest:
    choices:
    - 'on'
    - host
    - console
    - monitor
    - buffered
    - trap
    description:
    - Destination of the logs.

name:
    description:
    - The hostname or IP address of the destination.
    - Required when I(dest=host).

size:
    default: 4096
    description:
    - Size of buffer. The acceptable value is in range from 4096 to 4294967295 bytes.

level:
    choices:
    - emergencies
    - alerts
    - critical
    - errors
    - warnings
    - notifications
    - informational
    - debugging
    default: debugging
    description:
    - Set logging severity levels.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the logging configuration.

facility:
    description:
    - Set logging facility.

aggregate:
    description: List of logging definitions.

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  sample:
  - logging facility local7
  - logging host 172.16.0.1
  type: list