Docs4dev
Docs
ansible / latest / collections / purestorage / flasharray / purefa_syslog_settings_module.html

purestorage.flasharray.purefa_syslog_settings – Manage FlashArray syslog servers settings

Note

This plugin is part of the purestorage.flasharray collection (version 1.11.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.

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

New in version 1.10.0: of purestorage.flasharray

Synopsis

  • Manage FlashArray syslog servers settings

Requirements

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

  • python >= 2.7
  • purestorage >= 1.19
  • py-pure-client >= 1.6.0
  • netaddr
  • requests

Parameters

Parameter Choices/Defaults Comments
api_token
string
FlashArray API token for admin privileged user.
ca_certificate
string
The text of the CA certificate for condifured syslog servers.
Includes the "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----" lines
Does not exceed 3000 characters in length
To delete the existing CA certifcate use the special string `DELETE`
fa_url
string
FlashArray management IPv4 address or Hostname.
severity
string
    Choices:
  • debug
  • info ←
  • notice
Logging severity threshold for which events will be forwarded to the configured syslog servers.
tls_audit
boolean
    Choices:
  • no
  • yes ←
If messages that are necessary in order to audit TLS negotiations performed by the array are forwared to the syslog servers.

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: Change syslog servers settings
  purefa_syslog_servers:
    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 certifcate for syslog servers settings
  purefa_syslog_servers:
    ca_certificate: DELETE
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/purestorage/flasharray/purefa_syslog_settings_module.html