everpure.flasharray.purefa_sessions module – List FlashArray Sessions
Note
This module is part of the everpure.flasharray collection (version 1.46.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 everpure.flasharray.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: everpure.flasharray.purefa_sessions.
New in everpure.flasharray 1.29.0
Synopsis
List sessions based on filters provided
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.3
purestorage >= 1.19
py-pure-client >= 1.88.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:
|
|
End date and time (based on array local time) If not provided epoch is assumed Expected format “YYYY-MM-DD hh:mm:ss” |
|
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 everpure.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. |
|
Start date and time (based on array local time) If not provided epoch is assumed Expected format “YYYY-MM-DD hh:mm:ss” Besides the sessions that started at or after this time, the array also returns the sessions that carry no start time, such as failed login attempts. |
|
The timezone of the FlashArray If not provided, the module will attempt to get the current local timezone from the server however from Purity//FA 6.5.3 this value will calculated automatically from the FlashArray |
|
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
py-pure-clientPython library.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 everpure.flasharray.purefa_apiclient.
Examples
- name: Show all sessions that started after the specified date/time
purefa_sessions:
start: "2024-06-29 12:31:34"
fa_url: 10.10.10.2
api_token: 89a9356f-c203-d263-8a89-c229486a13ba
- name: Show all sessions that started and ended between specified dates/times
purefa_sessions:
start: "2024-06-29 12:31:34"
end: "2024-06-30 04:23:34"
fa_url: 10.10.10.2
api_token: 89a9356f-c203-d263-8a89-c229486a13ba
- name: Show all sessions that ended after the specified date/time
purefa_sessions:
end: "2024-06-30 04:23:34"
fa_url: 10.10.10.2
api_token: 89a9356f-c203-d263-8a89-c229486a13ba
- name: Show all sessions that have been logged by the array (to the internal limit of the array)
purefa_sessions:
fa_url: 10.10.10.2
api_token: 89a9356f-c203-d263-8a89-c229486a13ba