| source: |
|---|
- This module provides declarative management of logging on Arista Eos devices.
| Parameter | Choices/Defaults | Configuration | Comments | |
|---|---|---|---|---|
|
aggregate
-
|
List of logging definitions.
|
|||
|
dest
-
|
|
Destination of the logs.
|
||
|
facility
-
|
Set logging facility.
|
|||
|
level
-
|
|
Set logging severity levels.
|
||
|
name
-
|
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.This option is only required if you are using eAPI.
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. |
||
|
host
string
/ required
|
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
/ required
|
|
Configures the transport connection to use when connecting to the remote device.
|
||
|
use_proxy
boolean
added in 2.5 |
|
If
no, the environment variables http_proxy and https_proxy will be ignored. |
||
|
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. |
||
|
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. |
||
|
size
-
|
Size of buffer. The acceptable value is in range from 10 to 2147483647 bytes.
|
|||
|
state
-
|
|
State of the logging configuration.
|
||
Note
- Tested against EOS 4.15
- For information on using CLI, eAPI and privileged mode see the :ref:`EOS Platform Options guide <eos_platform_options>`
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- For more information on using Ansible to manage Arista EOS devices see the Arista integration page.
- name: configure host logging
eos_logging:
dest: host
name: 172.16.0.1
state: present
- name: remove host logging configuration
eos_logging:
dest: host
name: 172.16.0.1
state: absent
- name: configure console logging level and facility
eos_logging:
dest: console
facility: local7
level: debugging
state: present
- name: enable logging to all
eos_logging:
dest : on
- name: configure buffer size
eos_logging:
dest: buffered
size: 5000
- name: Configure logging using aggregate
eos_logging:
aggregate:
- { dest: console, level: warnings }
- { dest: buffered, size: 480000 }
state: present
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this :
| Key | Returned | Description |
|---|---|---|
|
commands
list
|
always |
The list of configuration mode commands to send to the device
Sample:
['logging facility local7', 'logging host 172.16.0.1']
|
- This is not guaranteed to have a backwards compatible interface. [preview]
- This is :ref:`maintained by the Ansible Network Team <modules_support>`. [network]
More information about Red Hat's support of this is available from this Red Hat Knowledge Base article.
- Trishna Guha (@trishnaguha)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
Hint
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.