W3cubDocs

/Ansible

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

Note

This module is part of the purestorage.flashblade collection (version 1.20.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in purestorage.flashblade 1.0.0

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 >= 3.9
  • py-pure-client
  • purity_fb >= 1.12.2
  • netaddr
  • datetime
  • pytz
  • distro
  • pycountry
  • urllib3

Parameters

Parameter

Comments

address

string / required

Email address (valid format required)

api_token

string

FlashBlade API token for admin privileged user.

disable_warnings

boolean

added in purestorage.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)
  • true

enabled

boolean

Set specified email address to be enabled or disabled

Choices:

  • false
  • true ← (default)

fb_url

string

FlashBlade management IP address or Hostname.

severity

string

The minimum severity that an alert must have in order for emails to be sent to the array’s alert watchers

Choices:

  • "info" ← (default)
  • "warning"
  • "critical"

state

string

Create or delete alert email

Choices:

  • "absent"
  • "present" ← (default)

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
  purestorage.flashblade.purefb_alert:
    address: "[email protected]"
    enabled: true
    state: present
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Delete existing email recipient
  purestorage.flashblade.purefb_alert:
    state: absent
    address: "[email protected]"
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Pure Storage Ansible Team (@sdodsley)

© 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/purestorage/flashblade/purefb_alert_module.html