purestorage.flasharray.purefa_ra module – Enable or Disable Pure Storage FlashArray Remote Assist

Note

This module is part of the purestorage.flasharray collection (version 1.32.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.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_ra.

New in purestorage.flasharray 1.0.0

Synopsis

  • Enablke or Disable Remote Assist for a Pure Storage FlashArray.

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

duration

integer

added in purestorage.flasharray 1.33.0

Number of hours Remote Assist port statys open for.

Must be an integer between 4 and 48

Default: 24

fa_url

string

FlashArray management IPv4 address or Hostname.

state

string

Define state of remote assist

When set to enable the RA port can be exposed using the debug module.

Choices:

  • "enable"

  • "disable"

  • "absent"

  • "present" ← (default)

  • "test"

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: Enable Remote Assist port
  purestorage.flasharray.purefa_ra:
    duration: 12
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  register: result

  debug:
    msg: "Remote Assist: {{ result['ra_info'] }}"

- name: Disable Remote Assist port
  purestorage.flasharray.purefa_ra:
    state: disable
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Pure Storage Ansible Team (@sdodsley)