Docs4dev
Docs
ansible / latest / collections / purestorage / flashblade / purefb_alert_module.html

purestorage.flashblade.purefb_alert – Configure Pure Storage FlashBlade alert email settings

Note

This plugin is part of the purestorage.flashblade collection (version 1.7.0).

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 purestorage.flashblade.

To use it in a playbook, specify: purestorage.flashblade.purefb_alert.

New in version 1.0.0: of purestorage.flashblade

Synopsis

  • Configure alert email configuration for Pure Storage FlashArrays.
  • Add or delete an individual syslog server to the existing list of serves.

Requirements

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

  • python >= 2.7
  • purity_fb >= 1.9
  • netaddr
  • pytz

Parameters

Parameter Choices/Defaults Comments
address
string / required
Email address (valid format required)
api_token
string
FlashBlade API token for admin privileged user.
enabled
boolean
    Choices:
  • no
  • yes ←
Set specified email address to be enabled or disabled
fb_url
string
FlashBlade management IP address or Hostname.
severity
string
    Choices:
  • info ←
  • warning
  • critical
The minimum severity that an alert must have in order for emails to be sent to the array's alert watchers
state
string
    Choices:
  • absent
  • present ←
Create or delete alert email

Notes

Note

  • This module requires the purity_fb Python library
  • You must set PUREFB_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

Examples

- name: Add new email recipient and enable, or enable existing email
  purefb_alert:
    address: "user@domain.com"
    enabled: true
    state: present
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Delete existing email recipient
  purefb_alert:
    state: absent
    address: "user@domain.com"
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/purestorage/flashblade/purefb_alert_module.html