community.general.icx_logging (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module provides declarative management of logging on Ruckus ICX 7000 series switches.

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure host logging.
  icx_logging:
    dest: host
    name: 172.16.0.1
    udp_port: 5555

Scanned by Steampunk Spotter

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

- name: Remove host logging configuration.
  icx_logging:
    dest: host
    name: 172.16.0.1
    udp_port: 5555
    state: absent

Scanned by Steampunk Spotter

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

- name: Disables the real-time display of syslog messages.
  icx_logging:
    dest: console
    state: absent

Scanned by Steampunk Spotter

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

- name: Enables local syslog logging.
  icx_logging:
    dest : on
    state: present

Scanned by Steampunk Spotter

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

- name: configure buffer level.
  icx_logging:
    dest: buffered
    level: critical

Scanned by Steampunk Spotter

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

- name: Configure logging using aggregate
  icx_logging:
    aggregate:
      - { dest: buffered, level: ['notifications','errors'] }

Scanned by Steampunk Spotter

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

- name: remove logging using aggregate
  icx_logging:
    aggregate:
      - { dest: console }
      - { dest: host, name: 172.16.0.1, udp_port: 5555 }
    state: absent

Inputs

    
dest:
    choices:
    - 'on'
    - host
    - console
    - buffered
    - persistence
    - rfc5424
    description:
    - Destination of the logs.
    type: str

name:
    description:
    - ipv4 address/ipv6 address/name of  syslog server.
    type: str

level:
    choices:
    - alerts
    - critical
    - debugging
    - emergencies
    - errors
    - informational
    - notifications
    - warnings
    description:
    - Specifies the message level.
    type: list

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

facility:
    choices:
    - auth
    - cron
    - daemon
    - kern
    - local0
    - local1
    - local2
    - local3
    - local4
    - local5
    - local6
    - local7
    - user
    - lpr
    - mail
    - news
    - syslog
    - sys9
    - sys10
    - sys11
    - sys12
    - sys13
    - sys14
    - user
    - uucp
    description:
    - Specifies log facility to log messages from the device.
    type: str

udp_port:
    description:
    - UDP port of destination host(syslog server).
    type: str

aggregate:
    description:
    - List of logging definitions.
    suboptions:
      check_running_config:
        description:
        - Check running configuration. This can be set as environment variable. Module
          will use environment variable value(default:True), unless it is overridden,
          by specifying it as module parameter.
        type: bool
      dest:
        choices:
        - 'on'
        - host
        - console
        - buffered
        - persistence
        - rfc5424
        description:
        - Destination of the logs.
        type: str
      facility:
        choices:
        - auth
        - cron
        - daemon
        - kern
        - local0
        - local1
        - local2
        - local3
        - local4
        - local5
        - local6
        - local7
        - user
        - lpr
        - mail
        - news
        - syslog
        - sys9
        - sys10
        - sys11
        - sys12
        - sys13
        - sys14
        - user
        - uucp
        description:
        - Specifies log facility to log messages from the device.
        type: str
      level:
        choices:
        - alerts
        - critical
        - debugging
        - emergencies
        - errors
        - informational
        - notifications
        - warnings
        description:
        - Specifies the message level.
        type: list
      name:
        description:
        - ipv4 address/ipv6 address/name of  syslog server.
        type: str
      state:
        choices:
        - present
        - absent
        description:
        - State of the logging configuration.
        type: str
      udp_port:
        description:
        - UDP port of destination host(syslog server).
        type: str
    type: list

check_running_config:
    default: true
    description:
    - Check running configuration. This can be set as environment variable. Module will
      use environment variable value(default:True), unless it is overridden, by specifying
      it as module parameter.
    type: bool

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  sample:
  - logging host 172.16.0.1
  - logging console
  type: list