ansible.builtin.vyos_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 Vyatta Vyos devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure console logging
  vyos_logging:
    dest: console
    facility: all
    level: crit
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove console logging configuration
  vyos_logging:
    dest: console
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure file logging
  vyos_logging:
    dest: file
    name: test
    facility: local3
    level: err
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add logging aggregate
  vyos_logging:
    aggregate:
      - { dest: file, name: test1, facility: all, level: info }
      - { dest: file, name: test2, facility: news, level: debug }
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove logging aggregate
  vyos_logging:
    aggregate:
      - { dest: console, facility: all, level: info }
      - { dest: console, facility: daemon, level: warning }
      - { dest: file, name: test2, facility: news, level: debug }
    state: absent

Inputs

    
dest:
    choices:
    - console
    - file
    - global
    - host
    - user
    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.

level:
    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:
  - set system syslog global facility all level notice
  type: list