junipernetworks.junos.junos_logging (6.0.2) — module

Install collection

Install with ansible-galaxy collection install junipernetworks.junos:==6.0.2

Add to requirements.yml

  collections:
    - name: junipernetworks.junos
      version: 6.0.2

Description

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

Requirements

• ncclient (>=v0.5.2)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure console logging
  junipernetworks.junos.junos_logging:
    dest: console
    facility: any
    level: critical

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

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

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.
    type: str

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
    type: int

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
    type: int

level:
    description:
    - Set logging severity levels.
    type: str

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

active:
    default: true
    description:
    - Specifies whether or not the configuration is active or deactivated
    type: bool

facility:
    description:
    - Set logging facility.
    type: str

aggregate:
    description:
    - List of logging definitions.
    elements: dict
    suboptions:
      active:
        description:
        - Specifies whether or not the configuration is active or deactivated
        type: bool
      dest:
        choices:
        - console
        - host
        - file
        - user
        description:
        - Destination of the logs.
        type: str
      facility:
        description:
        - Set logging facility.
        type: str
      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
        type: int
      level:
        description:
        - Set logging severity levels.
        type: str
      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.
        type: str
      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
        type: int
      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
        type: int
      state:
        choices:
        - present
        - absent
        description:
        - State of the logging configuration.
        type: str
    type: list

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
    type: int

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: str