You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

junipernetworks.junos.junos_logging – Manage logging on network devices

Note

This plugin is part of the junipernetworks.junos collection (version 2.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install junipernetworks.junos.

To use it in a playbook, specify: junipernetworks.junos.junos_logging.

New in version 1.0.0: of junipernetworks.junos

DEPRECATED
Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

DEPRECATED 

Removed in: major release after 2023-08-01
Why: Updated module released with more functionality.
Alternative: junos_logging_global

Synopsis 

This module provides declarative management of logging on Juniper JUNOS devices.

Note

This module has a corresponding action plugin.

Requirements 

The below requirements are needed on the host that executes this module.

ncclient (>=v0.5.2)

Parameters 

Parameter	Comments
active boolean	Specifies whether or not the configuration is active or deactivated Choices: no yes ← (default)
aggregate list / elements=dictionary	List of logging definitions.
active boolean	Specifies whether or not the configuration is active or deactivated Choices: no yes
dest string	Destination of the logs. Choices: console host file user
facility string	Set logging facility.
files integer	Number of files to be archived, this is applicable if value of dest is `file`. The acceptable value is in range from 1 to 1000.
level string	Set logging severity levels.
name string	If value of `dest` is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified.
rotate_frequency integer	Rotate log frequency in minutes, this is applicable if value of dest is `file`. The acceptable value is in range of 1 to 59. This controls the frequency after which log file is rotated.
size integer	Size of the file in archive, this is applicable if value of dest is `file`. The acceptable value is in range from 65536 to 1073741824 bytes.
state string	State of the logging configuration. Choices: present absent
dest string	Destination of the logs. Choices: console host file user
facility string	Set logging facility.
files integer	Number of files to be archived, this is applicable if value of dest is `file`. The acceptable value is in range from 1 to 1000.
level string	Set logging severity levels.
name string	If value of `dest` is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified.
provider dictionary	Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli` or `connection: netconf`. For more information please see the Junos OS Platform Options 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 `ANSIBLE_NET_PASSWORD` will be used instead.
port integer	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 `transport=cli`) or port 830 (for `transport=netconf`) 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 `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	Configures the transport connection to use when connecting to the remote device. Choices: cli netconf ← (default)
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 `ANSIBLE_NET_USERNAME` will be used instead.
rotate_frequency integer	Rotate log frequency in minutes, this is applicable if value of dest is `file`. The acceptable value is in range of 1 to 59. This controls the frequency after which log file is rotated.
size integer	Size of the file in archive, this is applicable if value of dest is `file`. The acceptable value is in range from 65536 to 1073741824 bytes.
state string	State of the logging configuration. Choices: present ← (default) absent

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
  junipernetworks.junos.junos_logging:
    dest: console
    facility: any
    level: critical

- name: remove console logging configuration
  junipernetworks.junos.junos_logging:
    dest: console
    state: absent

- name: configure file logging
  junipernetworks.junos.junos_logging:
    dest: file
    name: test
    facility: pfe
    level: error

- name: configure logging parameter
  junipernetworks.junos.junos_logging:
    files: 30
    size: 65536
    rotate_frequency: 10

- name: Configure file logging using aggregate
  junipernetworks.junos.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
  junipernetworks.junos.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	Description
diff.prepared string	Configuration difference before and after applying change. Returned: when configuration is changed and diff option is enabled. Sample: “[edit system syslog] + [edit system syslog]\n file interactive-commands { … }\n+ file test { + pfe critical; + }\n”

Status 

This module will be removed in a major release after 2023-08-01. [deprecated]
For more information see DEPRECATED.

Authors

Ganesh Nalawade (@ganeshrn)