ansible.builtin.iosxr_logging (v2.4.6.0-1) — 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.4.6.0.post1

Description

This module provides declarative management of logging on Cisco IOS XR devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure hostnameprefix logging
  iosxr_logging:
    dest: hostnameprefix
    name: 172.16.0.1
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove hostnameprefix logging configuration
  iosxr_logging:
    dest: hostnameprefix
    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
  iosxr_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
  iosxr_logging:
    dest : on
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure buffer size
  iosxr_logging:
    dest: buffered
    size: 5000
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure logging using aggregate
  iosxr_logging:
    aggregate:
      - { dest: console, level: warning }
      - { dest: buffered, size: 4800000 }
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete logging using aggregate
  iosxr_logging:
    aggregate:
      - { dest: console, level: warning }
      - { dest: buffered, size: 4800000 }
    state: absent

Inputs

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

name:
    description:
    - If value of C(dest) is I(file) it indicates file-name, for I(user) it indicates
      username and for I(host) indicates the host name to be notified.

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

level:
    default: debugging
    description:
    - Set logging severity levels.

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

facility:
    default: local7
    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 hostnameprefix 172.16.0.1
  type: list