everpure.flasharray.purefa_syslog_settings module – Manage FlashArray syslog servers settings
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_syslog_settings.
New in everpure.flasharray 1.10.0
Synopsis
Manage FlashArray syslog servers settings
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. |
|
The text of the CA certificate for configured syslog servers. Includes the “-----BEGIN CERTIFICATE-----” and “-----END CERTIFICATE-----” lines Does not exceed 3000 characters in length To delete the existing CA certificate use the special string `DELETE` |
|
ID of the API Client that issues the identity token. Used with private_key_file. |
|
Name of fleet member on which to perform the operation. This requires the array receiving the request is a member of a fleet and the context name to be a member of the same fleet. Default: |
|
Disable insecure certificate warnings in debug logs Choices:
|
|
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. |
|
Logging severity threshold for which events will be forwarded to the configured syslog servers. Choices:
|
|
If messages that are necessary in order to audit TLS negotiations performed by the array are forwarded to the syslog servers. 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
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: Change syslog servers settings
everpure.flasharray.purefa_syslog_settings:
tls_audit: false
severity: debug
ca_certificate: "{{lookup('file', 'example.crt') }}"
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Delete existing CA certificate for syslog servers settings
everpure.flasharray.purefa_syslog_settings:
ca_certificate: DELETE
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592