arista.eos.eos_logging module – Manage logging on network devices

Note

This module is part of the arista.eos collection (version 6.2.2).

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 arista.eos.

To use it in a playbook, specify: arista.eos.eos_logging.

New in arista.eos 1.0.0

DEPRECATED

Removed in:

major release after 2024-01-01

Why:

Updated module released with more functionality.

Alternative:

eos_logging_global

Synopsis

  • This module provides declarative management of logging on Arista Eos devices.

Aliases: logging

Parameters

Parameter

Comments

aggregate

list / elements=dictionary

List of logging definitions.

dest

string

Destination of the logs.

Choices:

  • "on"

  • "host"

  • "console"

  • "monitor"

  • "buffered"

facility

string

Set logging facility.

level

string

Set logging severity levels.

Choices:

  • "emergencies"

  • "alerts"

  • "critical"

  • "errors"

  • "warnings"

  • "notifications"

  • "informational"

  • "debugging"

name

string

The hostname or IP address of the destination.

Required when dest=host.

size

integer

Size of buffer. The acceptable value is in range from 10 to 2147483647 bytes.

state

string

State of the logging configuration.

Choices:

  • "present" ← (default)

  • "absent"

dest

string

Destination of the logs.

Choices:

  • "on"

  • "host"

  • "console"

  • "monitor"

  • "buffered"

facility

string

Set logging facility.

level

string

Set logging severity levels.

Choices:

  • "emergencies"

  • "alerts"

  • "critical"

  • "errors"

  • "warnings"

  • "notifications"

  • "informational"

  • "debugging"

name

string

The hostname or IP address of the destination.

Required when dest=host.

size

integer

Size of buffer. The acceptable value is in range from 10 to 2147483647 bytes.

state

string

State of the logging configuration.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Tested against Arista EOS 4.24.6F

Examples

- name: configure host logging
  arista.eos.eos_logging:
    dest: host
    name: 172.16.0.1
    state: present

- name: remove host logging configuration
  arista.eos.eos_logging:
    dest: host
    name: 172.16.0.1
    state: absent

- name: configure console logging level and facility
  arista.eos.eos_logging:
    dest: console
    facility: local7
    level: debugging
    state: present

- name: enable logging to all
  arista.eos.eos_logging:
    dest: on

- name: configure buffer size
  arista.eos.eos_logging:
    dest: buffered
    size: 5000

- name: Configure logging using aggregate
  arista.eos.eos_logging:
    aggregate:
      - {dest: console, level: warnings}
      - {dest: buffered, size: 480000}
    state: present

Return Values

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

Key

Description

commands

list / elements=string

The list of configuration mode commands to send to the device

Returned: always

Sample: ["logging facility local7", "logging host 172.16.0.1"]

Status

  • This module will be removed in a major release after 2024-01-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Trishna Guha (@trishnaguha)