alliedtelesis.awplus.awplus_logging (1.2.2) — module

Manages the attributes of AlliedWare Plus logging

| "added in version" 2.10.4 of alliedtelesis.awplus"

Authors: Darryl Alang

preview | supported by network

Install collection

Install with ansible-galaxy collection install alliedtelesis.awplus:==1.2.2


Add to requirements.yml

  collections:
    - name: alliedtelesis.awplus
      version: 1.2.2

Description

This module manages logging configuration of AlliedWare Plus devices.

Usage examples

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

# Before state:
# -------------
# awplus(config)#show running-config | include log
# log buffered size 51
# log console level alerts facility ftp

- name: Merge provided configuration with device configuration
  alliedtelesis.awplus.awplus_logging:
    config:
      - dest: console
        facility: ftp
    state: merged
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# After state:
# -------------
# awplus(config)#show running-config | include log
# log buffered size 51
# log console facility ftp
# log console level alerts facility ftp


# Using replaced

# Before state:
# -------------
# awplus(config)#show running-config | include log
# log buffered size 51
# log console level alerts facility ftp

- name: Replace device configuration with provided configuration
  alliedtelesis.awplus.awplus_logging:
    config:
      - dest: console
        facility: ftp
    state: replaced
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# After state:
# -------------
# awplus(config)#show running-config | include log
# log buffered size 51
# log console facility ftp


# Using overridden

# Before state:
# -------------
# awplus(config)#show running-config | include log
# log buffered size 51
# log console level alerts facility ftp

- name: Override device configuration with provided configuration
  alliedtelesis.awplus.awplus_logging:
    config:
      - dest: console
        facility: ftp
    state: overridden
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# After state:
# -------------
# awplus(config)#show running-config | include log
# log console facility ftp


# Using deleted

# Before state:
# -------------
# awplus(config)#show running-config | include log
# log buffered size 51
# log console facility ftp
# log console level alerts facility ftp

- name: Delete all logging configurations
  alliedtelesis.awplus.awplus_logging:
    state: deleted

Inputs

    
state:
    choices:
    - merged
    - replaced
    - overridden
    - deleted
    default: merged
    description:
    - The state the configuration should be left in.
    type: str

config:
    description: A dictionary of interface options.
    elements: dict
    suboptions:
      dest:
        choices:
        - buffered
        - console
        - external
        - facility
        - host
        - monitor
        - permanent
        description:
        - Destination of the logs.
        required: true
        type: str
      facility:
        description:
        - Filter messages by syslog facility.
        - This is mutually exclusive to I(size).
        type: str
      level:
        choices:
        - alerts
        - critical
        - debugging
        - emergencies
        - errors
        - informational
        - notices
        - warnings
        description:
        - Filter messages by severity level.
        - This is mutually exclusive to I(size).
        type: str
      name:
        description:
        - The remote syslog server the device sends log messages to via UDP port 514.
        - Required when I(dest=host).
        type: str
      size:
        description:
        - Size of the RAM log in kilobytes. The acceptable value is in range from 50 to
          250.
        - This is mutually exclusive to I(level) and I(facility).
        type: int
    type: list

Outputs

after:
  description: The resulting configuration model invocation.
  returned: when changed
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
before:
  description: The configuration prior to the model invocation.
  returned: always
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
commands:
  description: The set of commands pushed to the remote device.
  returned: always
  sample:
  - log facility cron
  type: list