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

Note

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

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

New in version 1.4.0: of purestorage.flashblade

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 >= 2.7
  • purity_fb >= 1.9
  • netaddr
  • pytz

Parameters

Parameter Choices/Defaults 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.
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
    Choices:
  • tcp
  • tls
  • udp
Protocol which server uses
state
string
    Choices:
  • absent
  • present ←
Create or delete syslog servers configuration

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
  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
  purefb_syslog:
    state: present
    name: syslog1
    address: syslog1.com
    protocol: udp
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

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/flashblade/purefb_syslog_module.html