W3cubDocs

/Ansible

infinidat.infinibox.infini_notification_rule module – Config notification rules

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_rule.

New in infinidat.infinibox 2.13.0

Synopsis

  • This module config notification rules on Infinibox

Requirements

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

Parameters

Parameter

Comments

event_level

list / elements=string

Event levels

Default: []

exclude_events

list / elements=string

Exclued events

Default: []

include_events

list / elements=string

Included events

Default: []

name

string / required

Name of the rule

password

string / required

Infinibox User password.

recipient_target_name

string

When creating a rule using recipients, a notification target is required.

Usually, this target is named “customer-smtp”.

If this is not the case, use this variable to specifiy another name.

Default: "customer-smtp"

recipients

list / elements=string

Email list of the recipients

Recipients and target are exclusive to each other, i.e. only recipients or target should be used, don’t use both at the same time.

Default: []

state

string

Query or modifies config.

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.

target

string

Notification target

Recipients and target are exclusive to each other, i.e. only recipients or target should be used, don’t use both at the same time.

user

string / required

Infinibox User username with sufficient priveledges ( see notes ).

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 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)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/infinidat/infinibox/infini_notification_rule_module.html