mellanox.onyx.onyx_syslog_remote – Configure remote syslog module

Note

This plugin is part of the mellanox.onyx collection (version 1.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 mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_syslog_remote.

New in version 0.2.0: of mellanox.onyx

Synopsis
Parameters
Examples
Return Values

Synopsis

This module provides declarative management of syslog on Mellanox ONYX network devices.

Parameters

Parameter		Choices/Defaults	Comments
enabled boolean		Choices: no yes ←	Disable/Enable logging to given remote host
filter string		Choices: include exclude	Specify a filter type
filter_str string			Specify a regex filter string
host string / required			<IP4/IP6 Hostname> Send event logs to this server using the syslog protocol
port integer			Set remote server destination port for log messages
trap string		Choices: none debug info notice alert warning err emerg crit	Minimum severity level for messages to this syslog server
trap_override list / elements=string			Override log levels for this sink on a per-class basis
	override_class string / required	Choices: mgmt-front mgmt-back mgmt-core events debug-module sx-sdk mlx-daemons protocol-stack	Specify a class whose log level to override
	override_enabled boolean	Choices: no yes ←	disable override priorities for specific class.
	override_priority string	Choices: none debug info notice alert warning err emerg crit	-Specify a priority whose log level to override

Examples

- name: Remote logging port 8080
- onyx_syslog_remote:
    host: 10.10.10.10
    port: 8080

- name: Remote logging trap override
- onyx_syslog_remote:
    host: 10.10.10.10
    trap_override:
        - override_class: events
          override_priority: emerg

- name: Remote logging trap emerg
- onyx_syslog_remote:
    host: 10.10.10.10
    trap: emerg

- name: Remote logging filter include 'ERR'
- onyx_syslog_remote:
    host: 10.10.10.10
    filter: include
    filter_str: /ERR/

- name: Disable remote logging with class events
- onyx_syslog_remote:
    enabled: False
    host: 10.10.10.10
    class: events
- name : disable remote logging
- onyx_syslog_remote:
    enabled: False
    host: 10.10.10.10

- name : enable/disable override class
- onyx_syslog_remote:
    host: 10.7.144.71
    trap_override:
        - override_class: events
          override_priority: emerg
          override_enabled: False
        - override_class: mgmt-front
          override_priority: alert

Return Values

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

Key	Returned	Description
commands list / elements=string	always	The list of configuration mode commands to send to the device. Sample: ['logging x port 8080', 'logging 10.10.10.10 trap override class events priority emerg', 'no logging 10.10.10.10 trap override class events', 'logging 10.10.10.10 trap emerg', 'logging 10.10.10.10 filter [include \| exclude] ERR']

Authors

Anas Shami (@anass)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/mellanox/onyx/onyx_syslog_remote_module.html