ansible.builtin.junos_logging (v2.4.6.0-1) — module

Manage logging on network devices

| "added in version" 2.4 of ansible.builtin"

Authors: Ganesh Nalawade (@ganeshrn)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure console logging
  junos_logging:
    dest: console
    facility: any
    level: critical
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove console logging configuration
  junos_logging:
    dest: console
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure file logging
  junos_logging:
    dest: file
    name: test
    facility: pfe
    level: error
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure logging parameter
  junos_logging:
    files: 30
    size: 65536
    rotate_frequency: 10
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
dest:
    choices:
    - console
    - host
    - file
    - user
    description:
    - Destination of the logs.

name:
    description:
    - If value of C(dest) is I(file) it indicates file-name, for I(user) it indicates
      username and for I(host) indicates the host name to be notified.

size:
    description:
    - Size of the file in archive, this is applicable if value of I(dest) is C(file).
      The acceptable value is in range from 65536 to 1073741824 bytes.
    required: false

files:
    description:
    - Number of files to be archived, this is applicable if value of I(dest) is C(file).
      The acceptable value is in range from 1 to 1000.
    required: false

level:
    description:
    - Set logging severity levels.

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the logging configuration.

active:
    choices:
    - true
    - false
    default: true
    description:
    - Specifies whether or not the configuration is active or deactivated

facility:
    description:
    - Set logging facility.

aggregate:
    description: List of logging definitions.

rotate_frequency:
    description:
    - Rotate log frequency in minutes, this is applicable if value of I(dest) is C(file).
      The acceptable value is in range of 1 to 59. This controls the frequency after which
      log file is rotated.
    required: false

Outputs

diff.prepared:
  description: 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"
  type: string