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

Note

This module is part of the arista.eos collection (version 3.1.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 arista.eos.

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

New in version 1.0.0: of arista.eos

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.

Note

This module has a corresponding action plugin.

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.

provider

dictionary

Deprecated

Starting with Ansible 2.5 we recommend using connection: network_cli.

Starting with Ansible 2.6 we recommend using connection: httpapi for eAPI.

This option will be removed in a release after 2022-06-01.

For more information please see the EOS Platform Options guide.

A dict object containing connection details.

auth_pass

string

Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.

authorize

boolean

Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.

Choices:

  • no ← (default)

  • yes

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

password

string

Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or eapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Specifies the port to use when building the connection to the remote device. This value applies to either cli or eapi.

The port value will default to the appropriate transport common port if none is provided in the task (cli=22, http=80, https=443).

Default: 0

ssh_keyfile

path

Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

timeout

integer

Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.

transport

string

Configures the transport connection to use when connecting to the remote device.

Choices:

  • cli ← (default)

  • eapi

use_proxy

boolean

If no, the environment variables http_proxy and https_proxy will be ignored.

Choices:

  • no

  • yes ← (default)

use_ssl

boolean

Configures the transport to use SSL if set to yes only when the transport=eapi. If the transport argument is not eapi, this value is ignored.

Choices:

  • no

  • yes ← (default)

username

string

Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

validate_certs

boolean

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not eapi, this value is ignored.

Choices:

  • no

  • yes ← (default)

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

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)