eos_logging_global¶
Collection Note
This module is part of the arista.eos collection. To install the collection, use:
Added in version3.0.0.
Synopsis¶
- This module configures and manages the attributes of logging on Arista EOS platforms.
Parameters¶
| Parameter | Defaults / Choices | Comments |
|---|---|---|
| config dict |
A dictionary of logging options | |
| config.buffered | Set buffered logging parameters. | |
| config.console | Set console logging parameters. | |
| config.event | Choices: link-status, port-channel, spanning-tree | Global events |
| config.facility | Choices: auth, cron, daemon, kern, local0, local1, local2, local3, local4, local5, local6, local7, lpr, mail, news, sys10, sys11, sys12, sys13, sys14, sys9, syslog, user, uucp | Set logging facility. |
| config.format | Set logging format parameters | |
| config.hosts | Set syslog server IP address and parameters. | |
| config.level | Configure logging severity | |
| config.monitor | Set terminal monitor severity | |
| config.persistent | Save logging messages to the flash disk. | |
| config.policy | Configure logging policies. | |
| config.qos | Set DSCP value in IP header. | |
| config.relogging_interval | Configure relogging-interval for critical log messages | |
| config.repeat_messages | Repeat messages instead of summarizing number of repeats | |
| config.source_interface | Use IP Address of interface as source IP of log messages. | |
| config.synchronous | Set synchronizing unsolicited with solicited messages | |
| config.trap | Severity of messages sent to the syslog server. | |
| config.turn_on | Turn on logging. | |
| config.vrfs | Specify vrf | |
| running_config str |
This option is used only with state I(parsed). The value of this option should be the output received from the EOS device by executing the command B(show running-config | section access-list). The states I(replaced) and I(overridden) have identical behaviour for this module. The state I(parsed) reads the configuration from C(running_config) option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the I(parsed) key within the result. |
|
| state str |
Default: merged Choices: deleted, merged, overridden, replaced, gathered, rendered, parsed |
The state the configuration should be left in. |
Notes¶
Note
- Tested against Arista EOS 4.24.6M
- This module works with connection C(network_cli). See the L(EOS Platform Options,eos_platform_options).
Examples¶
# Using merged
# Before state
# test(config)#show running-config | section logging
# test(config)#
- name: Merge provided configuration with device configuration
arista.eos.eos_logging_global:
config:
hosts:
- name: "host01"
protocol: "tcp"
- name: "11.11.11.1"
port: 25
vrfs:
- name: "vrf01"
source_interface: "Ethernet1"
- name: "vrf02"
hosts:
- name: "hostvrf1"
protocol: "tcp"
- name: "24.1.1.1"
port: "33"
# After State:
# test(config)#show running-config | section logging
# logging host 11.11.11.1 25
# logging host host01 514 protocol tcp
# logging vrf vrf02 host 24.1.1.1 33
# logging vrf vrf02 host hostvrf1 514 protocol tcp
# logging vrf vrf01 source-interface Ethernet1
# test(config)#
#
#
# Module Execution:
# "after": {
# "hosts": [
# {
# "name": "11.11.11.1",
# "port": 25
# },
# {
# "name": "host01",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "vrfs": [
# {
# "name": "vrf01",
# "source_interface": "Ethernet1"
# },
# {
# "hosts": [
# {
# "name": "24.1.1.1",
# "port": 33
# },
# {
# "name": "hostvrf1",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "name": "vrf02"
# }
# ]
# },
# "before": {},
# "changed": true,
# "commands": [
# "logging host host01 protocol tcp",
# "logging host 11.11.11.1 25",
# "logging vrf vrf01 source-interface Ethernet1",
# "logging vrf vrf02 host hostvrf1 protocol tcp",
# "logging vrf vrf02 host 24.1.1.1 33"
# ],
#
# Using replaced:
# Before State:
# test(config)#show running-config | section logging
# logging host 11.11.11.1 25
# logging host host01 514 protocol tcp
# logging vrf vrf02 host 24.1.1.1 33
# logging vrf vrf02 host hostvrf1 514 protocol tcp
# logging format timestamp traditional timezone
# logging vrf vrf01 source-interface Ethernet1
# logging policy match inverse-result match-list list01 discard
# logging persistent 4096
# !
# logging level AAA alerts
# test(config)#
- name: Repalce
arista.eos.eos_logging_global:
config:
synchronous:
set: true
trap:
severity: "critical"
hosts:
- name: "host02"
protocol: "tcp"
vrfs:
- name: "vrf03"
source_interface: "Vlan100"
- name: "vrf04"
hosts:
- name: "hostvrf1"
protocol: "tcp"
state: replaced
# After State:
# test(config)#show running-config | section logging
# logging synchronous
# logging trap critical
# logging host host02 514 protocol tcp
# logging vrf vrf04 host hostvrf1 514 protocol tcp
# logging vrf vrf03 source-interface Vlan100
# test(config)#
#
# Module Execution:
# "after": {
# "hosts": [
# {
# "name": "host02",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "synchronous": {
# "set": true
# },
# "trap": {
# "severity": "critical"
# },
# "vrfs": [
# {
# "name": "vrf03",
# "source_interface": "Vlan100"
# },
# {
# "hosts": [
# {
# "name": "hostvrf1",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "name": "vrf04"
# }
# ]
# },
# "before": {
# "format": {
# "timestamp": {
# "traditional": {
# "timezone": true
# }
# }
# },
# "hosts": [
# {
# "name": "11.11.11.1",
# "port": 25
# },
# {
# "name": "host01",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "level": {
# "facility": "AAA",
# "severity": "alerts"
# },
# "persistent": {
# "size": 4096
# },
# "policy": {
# "invert_result": true,
# "match_list": "list01"
# },
# "vrfs": [
# {
# "name": "vrf01",
# "source_interface": "Ethernet1"
# },
# {
# "hosts": [
# {
# "name": "24.1.1.1",
# "port": 33
# },
# {
# "name": "hostvrf1",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "name": "vrf02"
# }
# ]
# },
# "changed": true,
# "commands": [
# "logging host host02 protocol tcp",
# "no logging host 11.11.11.1 25",
# "no logging host host01 514 protocol tcp",
# "logging vrf vrf03 source-interface Vlan100",
# "logging vrf vrf04 host hostvrf1 protocol tcp",
# "no logging vrf vrf01 source-interface Ethernet1",
# "no logging vrf vrf02 host 24.1.1.1 33",
# "no logging vrf vrf02 host hostvrf1 514 protocol tcp",
# "no logging format timestamp traditional timezone",
# "no logging level AAA alerts",
# "no logging persistent 4096",
# "no logging policy match invert-result match-list list01 discard",
# "logging synchronous",
# "logging trap critical"
# ],
#
#
# Using overridden:
# Before State:
# test(config)#show running-config | section logging
# logging host 11.11.11.1 25
# logging host host01 514 protocol tcp
# logging vrf vrf02 host 24.1.1.1 33
# logging vrf vrf02 host hostvrf1 514 protocol tcp
# logging format timestamp traditional timezone
# logging vrf vrf01 source-interface Ethernet1
# logging policy match inverse-result match-list list01 discard
# logging persistent 4096
# !
# logging level AAA alerts
# test(config)#
- name: Repalce
arista.eos.eos_logging_global:
config:
synchronous:
set: true
trap:
severity: "critical"
hosts:
- name: "host02"
protocol: "tcp"
vrfs:
- name: "vrf03"
source_interface: "Vlan100"
- name: "vrf04"
hosts:
- name: "hostvrf1"
protocol: "tcp"
state: overridden
# After State:
# test(config)#show running-config | section logging
# logging synchronous
# logging trap critical
# logging host host02 514 protocol tcp
# logging vrf vrf04 host hostvrf1 514 protocol tcp
# logging vrf vrf03 source-interface Vlan100
# test(config)#
#
# Module Execution:
# "after": {
# "hosts": [
# {
# "name": "host02",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "synchronous": {
# "set": true
# },
# "trap": {
# "severity": "critical"
# },
# "vrfs": [
# {
# "name": "vrf03",
# "source_interface": "Vlan100"
# },
# {
# "hosts": [
# {
# "name": "hostvrf1",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "name": "vrf04"
# }
# ]
# },
# "before": {
# "format": {
# "timestamp": {
# "traditional": {
# "timezone": true
# }
# }
# },
# "hosts": [
# {
# "name": "11.11.11.1",
# "port": 25
# },
# {
# "name": "host01",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "level": {
# "facility": "AAA",
# "severity": "alerts"
# },
# "persistent": {
# "size": 4096
# },
# "policy": {
# "invert_result": true,
# "match_list": "list01"
# },
# "vrfs": [
# {
# "name": "vrf01",
# "source_interface": "Ethernet1"
# },
# {
# "hosts": [
# {
# "name": "24.1.1.1",
# "port": 33
# },
# {
# "name": "hostvrf1",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "name": "vrf02"
# }
# ]
# },
# "changed": true,
# "commands": [
# "logging host host02 protocol tcp",
# "no logging host 11.11.11.1 25",
# "no logging host host01 514 protocol tcp",
# "logging vrf vrf03 source-interface Vlan100",
# "logging vrf vrf04 host hostvrf1 protocol tcp",
# "no logging vrf vrf01 source-interface Ethernet1",
# "no logging vrf vrf02 host 24.1.1.1 33",
# "no logging vrf vrf02 host hostvrf1 514 protocol tcp",
# "no logging format timestamp traditional timezone",
# "no logging level AAA alerts",
# "no logging persistent 4096",
# "no logging policy match invert-result match-list list01 discard",
# "logging synchronous",
# "logging trap critical"
# ],
#
#
# Using deleted:
# Before State:
# test(config)#show running-config | section logging
# logging synchronous level critical
# logging host 11.11.11.1 25
# logging host host01 514 protocol tcp
# logging host host02 514 protocol tcp
# logging vrf vrf02 host 24.1.1.1 33
# logging vrf vrf02 host hostvrf1 514 protocol tcp
# logging vrf vrf04 host hostvrf1 514 protocol tcp
# logging vrf vrf01 source-interface Ethernet1
# logging vrf vrf03 source-interface Vlan100
# test(config)#
- name: Delete all logging configs
arista.eos.eos_logging_global:
state: deleted
become: true
# After state:
# test(config)#show running-config | section logging
# test(config)#
#
# "after": {},
# "before": {
# "hosts": [
# {
# "name": "11.11.11.1",
# "port": 25
# },
# {
# "name": "host01",
# "port": 514,
# "protocol": "tcp"
# },
# {
# "name": "host02",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "synchronous": {
# "level": "critical"
# },
# "vrfs": [
# {
# "name": "vrf01",
# "source_interface": "Ethernet1"
# },
# {
# "hosts": [
# {
# "name": "24.1.1.1",
# "port": 33
# },
# {
# "name": "hostvrf1",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "name": "vrf02"
# },
# {
# "name": "vrf03",
# "source_interface": "Vlan100"
# },
# {
# "hosts": [
# {
# "name": "hostvrf1",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "name": "vrf04"
# }
# ]
# },
# "changed": true,
# "commands": [
# "no logging host 11.11.11.1 25",
# "no logging host host01 514 protocol tcp",
# "no logging host host02 514 protocol tcp",
# "no logging vrf vrf01 source-interface Ethernet1",
# "no logging vrf vrf02 host 24.1.1.1 33",
# "no logging vrf vrf02 host hostvrf1 514 protocol tcp",
# "no logging vrf vrf03 source-interface Vlan100",
# "no logging vrf vrf04 host hostvrf1 514 protocol tcp",
# "no logging synchronous level critical"
# ],
# Using parsed:
# parsed.cfg
# logging host 11.11.11.1 25
# logging host host01 514 protocol tcp
# logging vrf vrf02 host 24.1.1.1 33
# logging vrf vrf02 host hostvrf1 514 protocol tcp
# logging format timestamp traditional timezone
# logging vrf vrf01 source-interface Ethernet1
# logging policy match inverse-result match-list list01 discard
# logging persistent 4096
# !
# logging level AAA alerts
- name: parse configs
arista.eos.eos_logging_global:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
# Module Execution
# "parsed": {
# "format": {
# "timestamp": {
# "traditional": {
# "timezone": true
# }
# }
# },
# "hosts": [
# {
# "name": "11.11.11.1",
# "port": 25
# },
# {
# "name": "host01",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "level": {
# "facility": "AAA",
# "severity": "alerts"
# },
# "persistent": {
# "size": 4096
# },
# "policy": {
# "invert_result": true,
# "match_list": "list01"
# },
# "vrfs": [
# {
# "name": "vrf01",
# "source_interface": "Ethernet1"
# },
# {
# "hosts": [
# {
# "name": "24.1.1.1",
# "port": 33
# },
# {
# "name": "hostvrf1",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "name": "vrf02"
# }
# ]
# }
#
# Using gathered:
# Before State:
# test(config)#show running-config | section logging
# logging host 11.11.11.1 25
# logging host host01 514 protocol tcp
# logging vrf vrf02 host 24.1.1.1 33
# logging vrf vrf02 host hostvrf1 514 protocol tcp
# logging format timestamp traditional timezone
# logging vrf vrf01 source-interface Ethernet1
# logging policy match inverse-result match-list list01 discard
# logging persistent 4096
# !
# logging level AAA alerts
# test(config)#
- name: gather configs
arista.eos.eos_logging_global:
state: gathered
# Module Execution:
# "gathered": {
# "format": {
# "timestamp": {
# "traditional": {
# "timezone": true
# }
# }
# },
# "hosts": [
# {
# "name": "11.11.11.1",
# "port": 25
# },
# {
# "name": "host01",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "level": {
# "facility": "AAA",
# "severity": "alerts"
# },
# "persistent": {
# "size": 4096
# },
# "policy": {
# "invert_result": true,
# "match_list": "list01"
# },
# "vrfs": [
# {
# "name": "vrf01",
# "source_interface": "Ethernet1"
# },
# {
# "hosts": [
# {
# "name": "24.1.1.1",
# "port": 33
# },
# {
# "name": "hostvrf1",
# "port": 514,
# "protocol": "tcp"
# }
# ],
# "name": "vrf02"
# }
# ]
# },
#
# Using rendered:
- name: Render provided configuration
arista.eos.eos_logging_global:
config:
format:
timestamp:
traditional:
timezone: true
level:
facility: "AAA"
severity: "alerts"
persistent:
size: 4096
policy:
invert_result: true
match_list: "list01"
hosts:
- name: "host01"
protocol: "tcp"
- name: "11.11.11.1"
port: 25
vrfs:
- name: "vrf01"
source_interface: "Ethernet1"
- name: "vrf02"
hosts:
- name: "hostvrf1"
protocol: "tcp"
- name: "24.1.1.1"
port: "33"
# Module Execution:
# "rendered": [
# "logging host host01 protocol tcp",
# "logging host 11.11.11.1 25",
# "logging vrf vrf01 source-interface Ethernet1",
# "logging vrf vrf02 host hostvrf1 protocol tcp",
# "logging vrf vrf02 host 24.1.1.1 33",
# "logging format timestamp traditional timezone",
# "logging level AAA alerts",
# "logging persistent 4096",
# "logging policy match invert-result match-list list01 discard"
# ]
#
Authors¶
- Gomathi Selvi Srinivasan (@gomathiselvis)