junos_logging – Manage logging on network devices
junos_logging – Manage logging on network devices
New in version 2.4.
Synopsis
- This module provides declarative management of logging on Juniper JUNOS devices.
Requirements
The below requirements are needed on the host that executes this module.
- ncclient (>=v0.5.2)
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
active boolean |
|
Specifies whether or not the configuration is active or deactivated | |
aggregate - |
List of logging definitions. | ||
dest - |
|
Destination of the logs. | |
facility - |
Set logging facility. | ||
files - |
Number of files to be archived, this is applicable if value of dest is | ||
level - |
Set logging severity levels. | ||
name - |
If value of | ||
provider dictionary |
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the Junos OS Platform Options guide. A dict object containing connection details. | ||
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 value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
port integer |
Default: 22 |
Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for | |
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 |
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. | |
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 | ||
rotate_frequency - |
Rotate log frequency in minutes, this is applicable if value of dest is | ||
size - |
Size of the file in archive, this is applicable if value of dest is | ||
state - |
|
State of the logging configuration. |
Notes
Note
- This module requires the netconf system service be enabled on the remote device being managed.
- Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4.
- Recommended connection is
netconf
. See the Junos OS Platform Options. - This module also works with
local
connections for legacy playbooks. - For information on using CLI and netconf see the Junos OS 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 Juniper network devices see https://www.ansible.com/ansible-juniper.
Examples
- name: configure console logging
junos_logging:
dest: console
facility: any
level: critical
- name: remove console logging configuration
junos_logging:
dest: console
state: absent
- name: configure file logging
junos_logging:
dest: file
name: test
facility: pfe
level: error
- name: configure logging parameter
junos_logging:
files: 30
size: 65536
rotate_frequency: 10
- name: Configure file logging using aggregate
junos_logging:
dest: file
aggregate:
- name: test-1
facility: pfe
level: critical
- name: test-2
facility: kernel
level: emergency
active: True
- name: Delete file logging using aggregate
junos_logging:
aggregate:
- { dest: file, name: test-1, facility: pfe, level: critical }
- { dest: file, name: test-2, facility: kernel, level: emergency }
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
diff.prepared string |
when configuration is changed and diff option is enabled. |
Configuration difference before and after applying change.
Sample: [edit system syslog] + [edit system syslog] file interactive-commands { ... } + file test { + pfe critical; + } |
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
- Ganesh Nalawade (@ganeshrn)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/junos_logging_module.html