eos_logging – Manage logging on network devices
eos_logging – Manage logging on network devices
New in version 2.4.
Synopsis
- This module provides declarative management of logging on Arista Eos devices.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate - |
List of logging definitions. | ||
auth_pass - |
Deprecated Starting with Ansible 2.5 we recommend using This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. 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 | ||
authorize boolean |
|
Deprecated Starting with Ansible 2.5 we recommend using This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. 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 | |
dest - |
|
Destination of the logs. | |
facility - |
Set logging facility. | ||
level - |
|
Set logging severity levels. | |
name - |
If value of | ||
provider - |
Deprecated Starting with Ansible 2.5 we recommend using 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 - |
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 | ||
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 | |
host - / 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 - |
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 | ||
port - |
Default: "0 (use common port)" |
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 - |
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 | ||
timeout - |
Default: 10 |
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 - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
use_proxy boolean added in 2.5 |
|
If | |
use_ssl boolean |
|
Configures the transport to use SSL if set to true only when the | |
username - |
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 | ||
validate_certs boolean |
|
If | |
size - |
Size of buffer. The acceptable value is in range from 10 to 2147483647 bytes. | ||
state - |
|
State of the logging configuration. |
Notes
Note
- Tested against EOS 4.15
- For information on using CLI, eAPI and privileged mode see the EOS Platform Options guide
- For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Arista EOS devices see the Arista integration page.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
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'] |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Trishna Guha (@trishnaguha)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/eos_logging_module.html