purestorage.flasharray.purefa_syslog module – Configure Pure Storage FlashArray syslog settings

Note

This module is part of the purestorage.flasharray collection (version 1.31.1).

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_syslog.

New in purestorage.flasharray 1.0.0

Synopsis

  • Configure syslog configuration for Pure Storage FlashArrays.

  • Manage individual syslog servers.

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

address

string / required

Syslog server address. This field supports IPv4, IPv6 or FQDN. An invalid IP addresses will cause the module to fail. No validation is performed for FQDNs.

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

fa_url

string

FlashArray management IPv4 address or Hostname.

name

string / required

A user-specified name. The name must be locally unique and cannot be changed.

port

string

Port at which the server is listening. If no port is specified the system will use 514

protocol

string / required

Protocol which server uses

Choices:

  • "tcp"

  • "tls"

  • "udp"

state

string

Create, updatee, delete or test syslog servers configuration

Choices:

  • "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: Delete existing syslog server entry
  purestorage.flasharray.purefa_syslog:
    address: syslog1.com
    protocol: tcp
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Add syslog server entry
  purestorage.flasharray.purefa_syslog:
    state: present
    address: syslog1.com
    port: 8081
    protocol: udp
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Update syslog server entry
  purestorage.flasharray.purefa_syslog:
    state: present
    address: syslog1.com
    port: 8081
    protocol: tcp
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Pure Storage Ansible Team (@sdodsley)