vyos.vyos.vyos_logging – Manage logging on network devices
vyos.vyos.vyos_logging – Manage logging on network devices
Note
This plugin is part of the vyos.vyos collection (version 1.1.0).
To install it use: ansible-galaxy collection install vyos.vyos
.
To use it in a playbook, specify: vyos.vyos.vyos_logging
.
New in version 1.0.0: of vyos.vyos
Synopsis
- This module provides declarative management of logging on Vyatta Vyos devices.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate list / elements=dictionary |
List of logging definitions. | ||
dest string |
|
Destination of the logs. | |
facility string |
Set logging facility. | ||
level string |
Set logging severity levels. | ||
name string |
If value of | ||
state string |
|
State of the logging configuration. | |
dest string |
|
Destination of the logs. | |
facility string |
Set logging facility. | ||
level string |
Set logging severity levels. | ||
name string |
If value of | ||
provider dictionary |
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the Network Guide. A dict object containing connection details. | ||
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 value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
port integer |
Specifies the port to use when building the connection to the remote device. | ||
ssh_keyfile path |
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
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. | ||
username string |
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
state string |
|
State of the logging configuration. |
Notes
Note
- Tested against VyOS 1.1.8 (helium).
- This module works with connection
network_cli
. See the VyOS OS Platform Options. - For more information on using Ansible to manage network devices see the Ansible Network Guide
Examples
- name: configure console logging
vyos.vyos.vyos_logging:
dest: console
facility: all
level: crit
- name: remove console logging configuration
vyos.vyos.vyos_logging:
dest: console
state: absent
- name: configure file logging
vyos.vyos.vyos_logging:
dest: file
name: test
facility: local3
level: err
- name: Add logging aggregate
vyos.vyos.vyos_logging:
aggregate:
- {dest: file, name: test1, facility: all, level: info}
- {dest: file, name: test2, facility: news, level: debug}
state: present
- name: Remove logging aggregate
vyos.vyos.vyos_logging:
aggregate:
- {dest: console, facility: all, level: info}
- {dest: console, facility: daemon, level: warning}
- {dest: file, name: test2, facility: news, level: debug}
state: absent
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: ['set system syslog global facility all level notice'] |
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.10/collections/vyos/vyos/vyos_logging_module.html