arista.eos.eos_logging – Manage logging on network devices

Note

This plugin is part of the arista.eos collection (version 1.3.0).

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

Synopsis

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

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
aggregate
list / elements=dictionary
List of logging definitions.
dest
string
    Choices:
  • on
  • host
  • console
  • monitor
  • buffered
Destination of the logs.
facility
string
Set logging facility.
level
string
    Choices:
  • emergencies
  • alerts
  • critical
  • errors
  • warnings
  • notifications
  • informational
  • debugging
Set logging severity levels.
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
    Choices:
  • present ←
  • absent
State of the logging configuration.
dest
string
    Choices:
  • on
  • host
  • console
  • monitor
  • buffered
Destination of the logs.
facility
string
Set logging facility.
level
string
    Choices:
  • emergencies
  • alerts
  • critical
  • errors
  • warnings
  • notifications
  • informational
  • debugging
Set logging severity levels.
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
    Choices:
  • no ←
  • yes
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.
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
Default:
0
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).
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
    Choices:
  • cli ←
  • eapi
Configures the transport connection to use when connecting to the remote device.
use_proxy
boolean
    Choices:
  • no
  • yes ←
If no, the environment variables http_proxy and https_proxy will be ignored.
use_ssl
boolean
    Choices:
  • no
  • yes ←
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.
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
    Choices:
  • no
  • yes ←
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.
size
integer
Size of buffer. The acceptable value is in range from 10 to 2147483647 bytes.
state
string
    Choices:
  • present ←
  • absent
State of the logging configuration.

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 Returned Description
commands
list / elements=string
always
The list of configuration mode commands to send to the device

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


Authors

  • Trishna Guha (@trishnaguha)