W3cubDocs

/Ansible 2.11

purestorage.flashblade.purefb_bucket – Manage Object Store Buckets on a Pure Storage FlashBlade.

Note

This plugin is part of the purestorage.flashblade collection (version 1.4.0).

To install it use: ansible-galaxy collection install purestorage.flashblade.

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

New in version 1.0.0: of purestorage.flashblade

Synopsis

  • This module managess object store (s3) buckets on Pure Storage FlashBlade.

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
account
string / required
Object Store Account for Bucket.
api_token
string
FlashBlade API token for admin privileged user.
eradicate
boolean
    Choices:
  • no
  • yes
Define whether to eradicate the bucket on delete or leave in trash.
fb_url
string
FlashBlade management IP address or Hostname.
name
string / required
Bucket Name.
state
string
    Choices:
  • present
  • absent
Create, delete or modifies a bucket.
versioning
string
    Choices:
  • enabled
  • suspended
  • absent
State of S3 bucket versioning

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: Create new bucket named foo in account bar
  purefb_bucket:
    name: foo
    account: bar
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete bucket named foo in account bar
  purefb_bucket:
    name: foo
    account: bar
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Change bucket versioning state
  purefb_bucket:
    name: foo
    account: bar
    versioning: enabled
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Recover deleted bucket named foo in account bar
  purefb_bucket:
    name: foo
    account: bar
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Eradicate bucket named foo in account bar
  purefb_bucket:
    name: foo
    account: bar
    state: absent
    eradicate: true
    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/2.11/collections/purestorage/flashblade/purefb_bucket_module.html