Documentation

vyos_logging - Manage logging on network devices

New in version 2.4.

Synopsis

  • This module provides declarative management of logging on Vyatta Vyos devices.

Options

parameter required default choices comments
aggregate
 no
List of logging definitions.
dest
 no
  • console
  • file
  • global
  • host
  • user
Destination of the logs.
facility
 no
Set logging facility.
level
 no
Set logging severity levels.
name
 no
If value of dest is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified.
state
 no present
  • present
  • absent
State of the logging configuration.

Examples

- name: configure console logging
  vyos_logging:
    dest: console
    facility: all
    level: crit

- name: remove console logging configuration
  vyos_logging:
    dest: console
    state: absent

- name: configure file logging
  vyos_logging:
    dest: file
    name: test
    facility: local3
    level: err

- 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

- 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

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
commands
The list of configuration mode commands to send to the device
 always list ['set system syslog global facility all level notice']


Notes

Note

  • Tested against VYOS 1.1.7

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.