infinidat.infinibox.infini_notification_target module – Config notification target

Note

This module is part of the infinidat.infinibox collection (version 1.6.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install infinidat.infinibox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: infinidat.infinibox.infini_notification_target.

New in infinidat.infinibox 2.13.0

Synopsis

  • This module configures syslog notification targets on an Infinibox

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

facility

string

Facility

Choices:

  • "LOCAL0"

  • "LOCAL1"

  • "LOCAL2"

  • "LOCAL3"

  • "LOCAL4"

  • "LOCAL5"

  • "LOCAL6"

  • "LOCAL7" ← (default)

host

string

Host name or IP address of the target

name

string / required

Name of the syslog target

password

string / required

Infinibox User password.

port

integer

Port of the target

Default: 514

post_test

boolean

Run a test after new target is created

Choices:

  • false

  • true ← (default)

protocol

string

Protocol used for this target. Currently, the only valid value is SYSLOG.

Choices:

  • "SYSLOG" ← (default)

state

string

Query or modifies target

Choices:

  • "stat"

  • "present" ← (default)

  • "absent"

stay_logged_in

boolean

If True, persist API session to disk.

Load the session on subsequent module calls.

Persisted sessions are only usable for stay_logged_in_minutes.

Choices:

  • false ← (default)

  • true

stay_logged_in_minutes

integer

Number of minutes for which a persisted session may be reused.

After this time, the session data will be deleted.

The time should be shorter than the IBOX session timeout time.

Default: 5

system

string / required

Infinibox Hostname or IPv4 Address.

transport

string

TCP or UDP

Choices:

  • "UDP" ← (default)

  • "TCP"

user

string / required

Infinibox User username with sufficient priveledges ( see notes ).

visibility

string

Visibility

Choices:

  • "CUSTOMER" ← (default)

  • "INFINIDAT"

Notes

Note

  • This module requires infinisdk python library

  • You must set INFINIBOX_USER and INFINIBOX_PASSWORD environment variables if user and password arguments are not passed to the module directly

  • Ansible uses the infinisdk configuration file ~/.infinidat/infinisdk.ini if no credentials are provided. See http://infinisdk.readthedocs.io/en/latest/getting_started.html

  • All Infinidat modules support check mode (--check). However, a dryrun that creates resources may fail if the resource dependencies are not met for a task. For example, consider a task that creates a volume in a pool. If the pool does not exist, the volume creation task will fail. It will fail even if there was a previous task in the playbook that would have created the pool but did not because the pool creation was also part of the dry run.

Examples

- name: Create notification targets
  infini_notification_target:
    state: present
    name: testgraylog1
    protocol: SYSLOG
    host: 172.31.77.214
    port: 8067
    facility: LOCAL7
    transport: TCP
    visibility: CUSTOMER
    post_test: true
    user: "{{ user }}"
    password: "{{ password }}"
    system: "{{ system }}"
- name: Create a new notification rule to a target
  infini_notification_rule:
    name: "test-rule-to-target" # this need to be uniq
    event_level:
      - ERROR
      - CRITICAL
    include_events:
      - ACTIVATION_PAUSED
    exclude_events:
      - ACTIVE_DIRECTORY_ALL_DOMAIN_CONTROLLERS_DOWN
      - ACTIVE_DIRECTORY_LEFT
    target: testgraylog1
    state: "present"
    user: "{{ user }}"
    password: "{{ password }}"
    system: "{{ system }}"

Authors

  • Wei Wang (@wwang)