W3cubDocs

/Ansible

purestorage.flashblade.purefb_syslog module – Configure Pure Storage FlashBlade syslog settings

Note

This module is part of the purestorage.flashblade collection (version 1.20.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.flashblade. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.flashblade.purefb_syslog.

New in purestorage.flashblade 1.4.0

Synopsis

  • Configure syslog configuration for Pure Storage FlashBlades.
  • Add or delete an individual syslog server to the existing list of serves.

Requirements

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

  • python >= 3.9
  • py-pure-client
  • purity_fb >= 1.12.2
  • netaddr
  • datetime
  • pytz
  • distro
  • pycountry
  • urllib3

Parameters

Parameter

Comments

address

string

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

api_token

string

FlashBlade API token for admin privileged user.

disable_warnings

boolean

added in purestorage.flashblade 1.18.0

Disable insecure certificate warnings

Choices:

  • false ← (default)
  • true

fb_url

string

FlashBlade management IP address or Hostname.

name

string / required

Unique identifier for the syslog server address

port

string

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

protocol

string

Protocol which server uses

Choices:

  • "tcp"
  • "tls"
  • "udp"

services

list / elements=string

Syslog service type(s)

Choices:

  • "management" ← (default)
  • "data-audit"

Default: ["management"]

state

string

Create or delete syslog servers configuration

Choices:

  • "absent"
  • "present" ← (default)

Notes

Note

  • This module requires the purity_fb Python library
  • You must set PUREFB_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

Examples

- name: Delete exisitng syslog server entries
  purestorage.flashblade.purefb_syslog:
    name: syslog1
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Set array syslog servers
  purestorage.flashblade.purefb_syslog:
    state: present
    name: syslog1
    services:
    - data-audit
    address: syslog1.com
    protocol: udp
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Authors

  • Pure Storage Ansible Team (@sdodsley)

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