cisco.nxos.nxos_logging_global module – Logging resource module.
Note
This module is part of the cisco.nxos collection (version 9.2.1).
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 cisco.nxos.
To use it in a playbook, specify: cisco.nxos.nxos_logging_global.
New in cisco.nxos 2.5.0
Synopsis
This module manages logging configuration on devices running Cisco NX-OS.
Aliases: logging_global
Parameters
Parameter |
Comments |
|---|---|
A dictionary of logging configuration. |
|
Set console logging parameters. |
|
Set severity severity for console. Choices:
|
|
Enable or disable monitor logging. Choices:
|
|
Interface events. |
|
UPDOWN and CHANGE messages. |
|
Default logging configuration used by interfaces not explicitly configured. Choices:
|
|
To enable logging overriding port severity configuration. Choices:
|
|
TRUNK status messages. |
|
Default logging configuration used by interfaces not explicitly configured. Choices:
|
|
To enable logging overriding port severity configuration. Choices:
|
|
Facility parameter for syslog messages. |
|
Facility name. |
|
Set severity severity for console. Choices:
|
|
Modifies severity severity or size for history table. |
|
Set severity severity for console. Choices:
|
|
Set history table size. |
|
Enable forwarding to Remote Syslog Servers. |
|
Facility to use when forwarding to server. |
|
Hostname/IPv4/IPv6 address of the Remote Syslog Server. |
|
Destination Port when forwarding to remote server. |
|
Enable secure connection to remote server. |
|
Trustpoint configuration. |
|
Client Identity certificate for mutual authentication. Trustpoint to use for client certificate authentication. |
|
Set severity severity for console. Choices:
|
|
Display per-VRF information. This option is unsupported on MDS switches. |
|
IP configuration. This option is unsupported on MDS switches. |
|
Access-List. |
|
Set caching settings. |
|
Maximum number of log entries cached in software. |
|
Log-update interval (in sec). |
|
Log-update threshold (number of hits) |
|
Detailed ACL information. Choices:
|
|
Include additional fields in syslogs. |
|
Include source group tag info in syslogs. Choices:
|
|
Set file logging. |
|
Logfile name. |
|
Set persistent logging utilization alert threshold in percentage. This option is unsupported on MDS switches. |
|
Set severity severity for console. Choices:
|
|
Enter the logfile size in bytes. |
|
Enable or disable logfile. Choices:
|
|
Set module(linecard) logging. |
|
Set severity severity for console. Choices:
|
|
Enable or disable module logging. Choices:
|
|
Set terminal line(monitor) logging severity. |
|
Set severity severity for console. Choices:
|
|
Enable or disable monitor logging. Choices:
|
|
Enable origin information for Remote Syslog Server. |
|
Use hostname as origin-id of logging messages. This option is mutually exclusive with ip and string. Choices:
|
|
Use ip address as origin-id of logging messages. This option is mutually exclusive with hostname and string. |
|
Use text string as origin-id of logging messages. This option is mutually exclusive with hostname and ip. |
|
Enable or disable rate limit for log messages. Choices:
|
|
Set RFC to which messages should compliant. Syslogs will be compliant to RFC 5424. This option is unsupported on MDS switches. Choices:
|
|
Enable Source-Interface for Remote Syslog Server. This option is unsupported on MDS switches. |
|
Set logging timestamp granularity. Choices:
|
|
This option is used only with state parsed. The value of this option should be the output received from the NX-OS device by executing the command show running-config | include logging. The state parsed reads the configuration from |
|
The state the configuration should be left in. The states replaced and overridden have identical behaviour for this module. Refer to examples for more details. Choices:
|
Notes
Note
Tested against NX-OS 9.3.6 on Cisco Nexus Switches.
Limited Support for Cisco MDS
This module works with connection
network_cliandhttpapi.Tested against Cisco MDS NX-OS 9.2(2) with connection
network_cli.
Examples
# Using merged
# Before state:
# -------------
# nxos-9k-rdo# show running-config | include logging
# nxos-9k-rdo#
- name: Merge the provided configuration with the existing running configuration
cisco.nxos.nxos_logging_global:
config:
console:
severity: error
monitor:
severity: warning
ip:
access_list:
cache:
entries: 16384
interval: 200
threshold: 5000
facilities:
- facility: auth
severity: critical
- facility: ospfv3
severity: alert
- facility: ftp
severity: informational
hosts:
- host: 203.0.113.100
severity: alert
use_vrf: management
- host: 203.0.113.101
severity: error
facility: local6
use_vrf: default
origin_id:
hostname: true
# Task output
# -------------
# before: {}
#
# commands:
# - "logging console 3"
# - "logging monitor 4"
# - "logging ip access-list cache entries 16384"
# - "logging ip access-list cache interval 200"
# - "logging ip access-list cache threshold 5000"
# - "logging severity auth 2"
# - "logging severity ospfv3 1"
# - "logging severity ftp 6"
# - "logging server 203.0.113.100 1 use-vrf management"
# - "logging server 203.0.113.101 3 facility local6 use-vrf default"
# - "logging origin-id hostname"
#
# after:
# console:
# severity: error
# facilities:
# - facility: auth
# severity: critical
# - facility: ftp
# severity: informational
# - facility: ospfv3
# severity: alert
# ip:
# access_list:
# cache:
# entries: 16384
# interval: 200
# threshold: 5000
# monitor:
# severity: warning
# origin_id:
# hostname: true
# hosts:
# - severity: alert
# host: 203.0.113.100
# use_vrf: management
# - facility: local6
# severity: error
# host: 203.0.113.101
# use_vrf: default
# After state:
# ------------
# nxos-9k-rdo# show running-config | include logging
# logging console 3
# logging monitor 4
# logging ip access-list cache entries 16384
# logging ip access-list cache interval 200
# logging ip access-list cache threshold 5000
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id hostname
# logging server 203.0.113.100 1 use-vrf management
# logging server 203.0.113.101 3 use-vrf default facility local6
# Using replaced
# Before state:
# ------------
# nxos-9k-rdo# show running-config | include logging
# logging console 3
# logging monitor 4
# logging ip access-list cache entries 16384
# logging ip access-list cache interval 200
# logging ip access-list cache threshold 5000
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id hostname
# logging server 203.0.113.100 1 use-vrf management
# logging server 203.0.113.101 3 use-vrf default facility local6
- name: Replace logging configurations with provided config
cisco.nxos.nxos_logging_global:
config:
monitor:
severity: warning
ip:
access_list:
cache:
entries: 4096
facilities:
- facility: auth
severity: critical
- facility: ospfv3
severity: alert
- facility: ftp
severity: informational
hosts:
- host: 203.0.113.101
severity: error
facility: local6
use_vrf: default
- host: 198.51.100.101
severity: alert
port: 6538
use_vrf: management
origin_id:
ip: 192.0.2.100
state: replaced
# Task output
# -------------
# before:
# console:
# severity: error
# facilities:
# - facility: auth
# severity: critical
# - facility: ftp
# severity: informational
# - facility: ospfv3
# severity: alert
# ip:
# access_list:
# cache:
# entries: 16384
# interval: 200
# threshold: 5000
# monitor:
# severity: warning
# origin_id:
# hostname: true
# hosts:
# - severity: alert
# host: 203.0.113.100
# use_vrf: management
# - facility: local6
# severity: error
# host: 203.0.113.101
# use_vrf: default
#
# commands:
# - "logging console"
# - "logging ip access-list cache entries 4096"
# - "no logging ip access-list cache interval 200"
# - "no logging ip access-list cache threshold 5000"
# - "no logging origin-id hostname"
# - "logging origin-id ip 192.0.2.100"
# - "logging server 198.51.100.101 1 port 6538 use-vrf management"
# - "no logging server 203.0.113.100 1 use-vrf management"
#
# after:
# facilities:
# - facility: auth
# severity: critical
# - facility: ftp
# severity: informational
# - facility: ospfv3
# severity: alert
# ip:
# access_list:
# cache:
# entries: 4096
# monitor:
# severity: warning
# origin_id:
# ip: 192.0.2.100
# hosts:
# - severity: alert
# port: 6538
# host: 198.51.100.101
# use_vrf: management
# - facility: local6
# severity: error
# host: 203.0.113.101
# use_vrf: default
#
# After state:
# ------------
# nxos-9k-rdo# show running-config | include logging
# logging monitor 4
# logging ip access-list cache entries 4096
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id ip 192.0.2.100
# logging server 203.0.113.101 3 use-vrf default facility local6
# logging server 198.51.100.101 1 port 6538 use-vrf management
# Using deleted to delete all logging configurations
# Before state:
# ------------
# nxos-9k-rdo# show running-config | include logging
# logging console 3
# logging monitor 4
# logging ip access-list cache entries 16384
# logging ip access-list cache interval 200
# logging ip access-list cache threshold 5000
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id hostname
# logging server 203.0.113.100 1 use-vrf management
# logging server 203.0.113.101 3 use-vrf default facility local6
- name: Delete all logging configuration
cisco.nxos.nxos_logging_global:
state: deleted
# Task output
# -------------
# before:
# console:
# severity: error
# facilities:
# - facility: auth
# severity: critical
# - facility: ftp
# severity: informational
# - facility: ospfv3
# severity: alert
# ip:
# access_list:
# cache:
# entries: 16384
# interval: 200
# threshold: 5000
# monitor:
# severity: warning
# origin_id:
# hostname: true
# hosts:
# - severity: alert
# host: 203.0.113.100
# use_vrf: management
# - facility: local6
# severity: error
# host: 203.0.113.101
# use_vrf: default
#
# commands:
# - "logging console"
# - "logging monitor"
# - "no logging ip access-list cache entries 16384"
# - "no logging ip access-list cache interval 200"
# - "no logging ip access-list cache threshold 5000"
# - "no logging origin-id hostname"
# - "no logging severity auth 2"
# - "no logging severity ospfv3 1"
# - "no logging severity ftp 6"
# - "no logging server 203.0.113.100 1 use-vrf management"
# - "no logging server 203.0.113.101 3 facility local6 use-vrf default"
#
# after: {}
# Using rendered
- name: Render platform specific configuration lines with state rendered (without connecting to the device)
cisco.nxos.nxos_logging_global:
config:
console:
severity: error
monitor:
severity: warning
ip:
access_list:
cache:
entries: 16384
interval: 200
threshold: 5000
facilities:
- facility: auth
severity: critical
- facility: ospfv3
severity: alert
- facility: ftp
severity: informational
hosts:
- host: 203.0.113.100
severity: alert
use_vrf: management
- host: 203.0.113.101
severity: error
facility: local6
use_vrf: default
origin_id:
hostname: true
# Task Output (redacted)
# -----------------------
# rendered:
# - "logging console 3"
# - "logging monitor 4"
# - "logging ip access-list cache entries 16384"
# - "logging ip access-list cache interval 200"
# - "logging ip access-list cache threshold 5000"
# - "logging severity auth 2"
# - "logging severity ospfv3 1"
# - "logging severity ftp 6"
# - "logging server 203.0.113.100 1 use-vrf management"
# - "logging server 203.0.113.101 3 facility local6 use-vrf default"
# - "logging origin-id hostname"
# Using parsed
# parsed.cfg
# ------------
# logging console 3
# logging monitor 4
# logging ip access-list cache entries 16384
# logging ip access-list cache interval 200
# logging ip access-list cache threshold 5000
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id hostname
# logging server 203.0.113.100 1 use-vrf management
# logging server 203.0.113.101 3 use-vrf default facility local6
- name: Parse externally provided logging configuration
cisco.nxos.nxos_logging_global:
running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}"
state: parsed
# Task output (redacted)
# -----------------------
# parsed:
# console:
# severity: error
# facilities:
# - facility: auth
# severity: critical
# - facility: ftp
# severity: informational
# - facility: ospfv3
# severity: alert
# ip:
# access_list:
# cache:
# entries: 16384
# interval: 200
# threshold: 5000
# monitor:
# severity: warning
# origin_id:
# hostname: true
# hosts:
# - severity: alert
# host: 203.0.113.100
# use_vrf: management
# - facility: local6
# severity: error
# host: 203.0.113.101
# use_vrf: default
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration after module execution. Returned: when changed Sample: |
|
The configuration prior to the module execution. Returned: when state is merged, replaced, overridden, deleted or purged Sample: |
|
The set of commands pushed to the remote device. Returned: when state is merged, replaced, overridden, deleted or purged Sample: |
|
Facts about the network resource gathered from the remote device as structured data. Returned: when state is gathered Sample: |
|
The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is parsed Sample: |
|
The provided configuration in the task rendered in device-native format (offline). Returned: when state is rendered Sample: |