purestorage.flasharray.purefa_eradication module – Configure Pure Storage FlashArray Eradication Timer

Note

This module is part of the purestorage.flasharray collection (version 1.31.1).

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.flasharray. You need further requirements to be able to use this module, see Requirements for details.

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

New in purestorage.flasharray 1.9.0

Synopsis

  • Configure the eradication timer for destroyed items on a FlashArray.

  • Valid values are integer days from 1 to 30. Default is 1.

Requirements

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

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.26.0

  • netaddr

  • requests

  • pycountry

  • urllib3

Parameters

Parameter

Comments

api_token

string

FlashArray API token for admin privileged user.

disable_warnings

boolean

added in purestorage.flasharray 1.29.0

Disable insecure certificate warnings in debug logs

Choices:

  • false ← (default)

  • true

disabled_delay

integer

added in purestorage.flasharray 1.22.0

Configures the eradication delay for destroyed objects that are protected by SafeMode (objects for which eradication is disabled)

Allowed values are integers from 1 to 30. Default is 1

Default: 1

enabled_delay

integer

added in purestorage.flasharray 1.22.0

Configures the eradication delay for destroyed objects that are not protected by SafeMode (objects for which eradication is disabled)

Allowed values are integers from 1 to 30. Default is 1

Default: 1

fa_url

string

FlashArray management IPv4 address or Hostname.

timer

integer

Set the eradication timer for the FlashArray

Allowed values are integers from 1 to 30. Default is 1

Default: 1

Notes

Note

  • This module requires the purestorage and py-pure-client Python libraries

  • Additional Python librarues may be required for specific modules.

  • 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: Set eradication timer to 30 days
  purestorage.flasharray.purefa_eradication:
    timer: 30
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Set eradication timer to 1 day
  purestorage.flasharray.purefa_eradication:
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Pure Storage Ansible Team (@sdodsley)