dellemc.enterprise_sonic.sonic_logging module – Manage logging configuration on SONiC.
Note
This module is part of the dellemc.enterprise_sonic collection (version 3.2.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 dellemc.enterprise_sonic.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_logging.
New in dellemc.enterprise_sonic 2.1.0
Synopsis
- This module provides configuration management of logging for devices running SONiC.
Parameters
Parameter | Comments |
|---|---|
config dictionary | Specifies logging related configurations. |
|
remote_servers list / elements=dictionary |
Remote logging sever configuration. |
|
host string / required |
IPv4/IPv6 address or host name of the remote logging server. |
|
message_type string |
Type of messages that remote server receives. Defaults to “log” value. Choices:
|
|
protocol string |
Type of the protocol for sending the messages. Defaults to “UDP” value. Choices:
|
|
remote_port integer |
Destination port number for logging messages sent to the server. |
|
severity string added in dellemc.enterprise_sonic 3.1.0 |
The log severity filter for remote syslog server. Defaults to “notice” value. Choices:
|
|
source_interface string |
Source interface used as source ip for sending logging packets. |
|
vrf string |
VRF name used by remote logging server. |
|
security_profile string added in dellemc.enterprise_sonic 3.1.0 |
Specifies the security profile name for the global syslog settings. |
state string | The state of the configuration after module completion. Choices:
|
Notes
Note
- Supports
check_mode.
Examples
# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST PORT SOURCE-INTERFACE VRF MESSAGE-TYPE SEVERITY PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.0.2 5 Ethernet24 - event notice udp
# 10.11.1.1 616 Ethernet8 - log alert tcp
# log1.dell.com 6 Ethernet28 - audit notice udp
# 10.11.1.2 116 Ethernet6 - log notice tls
#
# sonic# show running-configuration | grep logging
# !
# logging security-profile default
# !
- name: Delete logging server configuration
sonic_logging:
config:
remote_servers:
- host: 10.11.0.2
- host: log1.dell.com
- host: 10.11.1.1
message_type: log
protocol: tcp
source_interface: Ethernet8
severity: alert
security_profile: "default"
state: deleted
# After state:
# ------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST PORT SOURCE-INTERFACE VRF MESSAGE-TYPE SEVERITY PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1 616 - - log notice udp
# 10.11.1.2 116 Ethernet6 - log notice tls
#
# sonic# show running-configuration | grep logging
# sonic#
#
# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST PORT SOURCE-INTERFACE VRF MESSAGE-TYPE SEVERITY PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1 616 Ethernet8 - log notice tcp
#
# sonic# show running-configuration | grep logging
# sonic#
- name: Merge logging server configuration
sonic_logging:
config:
remote_servers:
- host: 10.11.0.2
remote_port: 5
protocol: TCP
source_interface: Ethernet24
message_type: event
- host: 10.11.0.1
remote_port: 4
protocol: TLS
source_interface: Ethernet2
- host: 10.11.1.1
severity: error
- host: log1.dell.com
remote_port: 6
protocol: udp
source_interface: Ethernet28
message_type: audit
security_profile: "default"
state: merged
# After state:
# ------------
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST PORT SOURCE-INTERFACE VRF MESSAGE-TYPE SEVERITY PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.0.2 5 Ethernet24 - event notice udp
# 10.11.0.1 4 Ethernet2 - log notice tls
# 10.11.1.1 616 Ethernet8 - log error tcp
# log1.dell.com 6 Ethernet28 - audit notice udp
# sonic# show running-configuration | grep logging
# !
# logging security-profile default
# !
#
#
# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST PORT SOURCE-INTERFACE VRF MESSAGE-TYPE SEVERITY PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1 616 Ethernet8 - log notice tcp
# 10.11.1.2 626 Ethernet16 - event emergency udp
# 10.11.1.3 626 Ethernet14 - log notice tls
#
# sonic# show running-configuration | grep logging
# !
# logging security-profile default
# !
- name: Override logging server configuration
sonic_logging:
config:
remote_servers:
- host: 10.11.1.2
remote_port: 622
protocol: TCP
source_interface: Ethernet24
message_type: audit
severity: alert
state: overridden
#
# After state:
# ------------
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST PORT SOURCE-INTERFACE VRF MESSAGE-TYPE SEVERITY PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.2 622 Ethernet24 - audit alert tcp
# sonic# show running-configuration | grep logging
# sonic#
#
# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST PORT SOURCE-INTERFACE VRF MESSAGE-TYPE SEVERITY PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1 616 Ethernet8 - log notice tcp
# 10.11.1.2 626 Ethernet16 - event notice udp
#
# sonic# show running-configuration | grep logging
# sonic#
- name: Replace logging server configuration
sonic_logging:
config:
remote_servers:
- host: 10.11.1.2
remote_port: 622
protocol: UDP
message_type: audit
severity: debug
security_profile: "default"
state: replaced
#
# After state:
# ------------
#
# "MESSAGE-TYPE" has default value of "log"
#
# ----------------------------------------------------------------------------------------------------------
# HOST PORT SOURCE-INTERFACE VRF MESSAGE-TYPE SEVERITY PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1 616 Ethernet8 - log notice tcp
# 10.11.1.2 622 - - audit debug udp
# sonic# show running-configuration | grep logging
# !
# logging security-profile default
# !
#
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
after list / elements=string | The resulting configuration module invocation. Returned: when changed Sample: |
after(generated) list / elements=string | The generated configuration module invocation. Returned: when Sample: |
before list / elements=string | The configuration prior to the module invocation. Returned: always Sample: |
commands list / elements=string | The set of commands pushed to the remote device. Returned: always Sample: |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/enterprise_sonic/sonic_logging_module.html
