ubika.waap.alerting_destination (1.0.3) — module

Manage alerting destination

| "added in version" 1.0.0 of ubika.waap"

Authors: UBIKA team (@ubika_team)

Install collection

Install with ansible-galaxy collection install ubika.waap:==1.0.3


Add to requirements.yml

  collections:
    - name: ubika.waap
      version: 1.0.3

Description

Manage alerting destination.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Have test syslog destination
  ubika.waap.alerting_destination:
    credentials:
      host: ubikawaap.local:3001
      password: Denyall@0
      username: superadmin
      verify_ssl: false
    name: test
    type: syslog
    syslog_config:
      ip: 192.168.0.191
      port: 5008
      protocol: tcp
      severity: 5
      facility: 1
      format: rfc5424

Inputs

    
name:
    description:
    - Name of the alerting destination.
    required: true
    type: str

type:
    choices:
    - smtp
    - syslog
    - snmp
    default: syslog
    description:
    - Type of the alerting destination
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the alerting destination.
    type: str

credentials:
    description:
    - Credentials for UBIKA WAAP Gateway
    required: true
    suboptions:
      host:
        description:
        - UBIKA WAAP Gateway host
        required: true
        type: str
      password:
        description:
        - Administrator password
        required: true
        type: str
      username:
        description:
        - Administrator user name
        required: true
        type: str
      verify_ssl:
        default: true
        description:
        - Set to false to disable SSL verification
        type: bool
    type: dict

syslog_config:
    description:
    - The syslog configuration
    suboptions:
      facility:
        description:
        - facility of the syslog configuration.
        required: true
        type: int
      format:
        choices:
        - legacyV5
        - rfc5424
        - rfc3164
        default: legacyV5
        description:
        - format of the syslog configuration.
        type: str
      ip:
        description:
        - ip of the syslog configuration.
        required: true
        type: str
      port:
        description:
        - port of the syslog configuration.
        required: true
        type: int
      protocol:
        description:
        - protocol of the syslog configuration.
        required: true
        type: str
      severity:
        description:
        - severity of the syslog configuration.
        required: true
        type: int
    type: dict