purestorage.flasharray.purefa_ra module – Enable or Disable Everpure FlashArray Remote Assist
Note
This module is part of the purestorage.flasharray collection (version 1.43.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.
Note
The purestorage.flasharray collection has been renamed to everpure.flasharray and will be removed from Ansible 17. The content of purestorage.flasharray will be replaced by redirects to everpure.flasharray in Ansible 15. If you use content from purestorage.flasharray, please update FQCNs in your playbooks and roles! When creating new playbooks or roles, directly use content from everpure.flasharray instead. See the discussion thread for more information.
New in purestorage.flasharray 1.0.0
Synopsis
Enable or Disable Remote Assist for a Everpure 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 |
|---|---|
FlashArray API token for admin privileged user. |
|
ID of the API Client that issues the identity token. Used with private_key_file. |
|
Disable insecure certificate warnings in debug logs Choices:
|
|
Number of hours Remote Assist port stays open for. Must be an integer between 4 and 48 Default: |
|
FlashArray management IPv4 address or Hostname. |
|
A pre-signed JWT to authenticate with, as an alternative to api_token. The token is exchanged by the array for a short-lived access token. Requires a matching API Client to be registered on the array (see purestorage.flasharray.purefa_apiclient). |
|
The API Client’s trusted identity issuer registered on the array. Used with private_key_file. |
|
Key ID of the API Client that issues the identity token. Used with private_key_file. |
|
Path to the PEM RSA private key used to sign an identity token, as an alternative to api_token. Requires client_id, key_id, issuer and username. |
|
Password protecting private_key_file, if encrypted. |
|
Define state of remote assist When set to enable the RA port can be exposed using the debug module. Choices:
|
|
Username the issued token should be granted to. Must be a valid user on the array. Used with private_key_file. |
Notes
Note
This module requires the
purestorageandpy-pure-clientPython libraries.Additional Python libraries may be required for specific modules.
You must set
PUREFA_URLandPUREFA_APIenvironment variables if fa_url and api_token arguments are not passed to the module directly.Token-based authentication (id_token, or private_key_file with client_id, key_id, issuer and username) may be used as an alternative to api_token, and requires a matching API Client registered on the array via purestorage.flasharray.purefa_apiclient.
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