W3cubDocs

/Ansible 2.11

purestorage.flasharray.purefa_alert – Configure Pure Storage FlashArray alert email settings

Note

This plugin is part of the purestorage.flasharray collection (version 1.5.1).

To install it use: ansible-galaxy collection install purestorage.flasharray.

To use it in a playbook, specify: purestorage.flasharray.purefa_alert.

New in version 1.0.0: of purestorage.flasharray

Synopsis

  • Configure alert email configuration for Pure Storage FlashArrays.

Requirements

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

  • python >= 2.7
  • purestorage >= 1.19
  • py-pure-client >= 1.6.0
  • netaddr
  • requests

Parameters

Parameter Choices/Defaults Comments
address
string / required
Email address (valid format required)
api_token
string
FlashArray API token for admin privileged user.
enabled
boolean
    Choices:
  • no
  • yes ←
Set specified email address to be enabled or disabled
fa_url
string
FlashArray management IPv4 address or Hostname.
state
string
    Choices:
  • absent
  • present ←
Create or delete alert email

Notes

Note

  • This module requires the purestorage Python library
  • You must set PUREFA_URL and PUREFA_API environment variables if fa_url and api_token arguments are not passed to the module directly

Examples

- name: Add new email recipient and enable, or enable existing email
  purefa_alert:
    address: "[email protected]"
    enabled: true
    state: present
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Delete existing email recipient
  purefa_alert:
    state: absent
    address: "[email protected]"
    fa_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/2.11/collections/purestorage/flasharray/purefa_alert_module.html