purestorage.flashblade.purefb_s3acc module – Create or delete FlashBlade Object Store accounts

Note

This module is part of the purestorage.flashblade collection (version 1.19.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.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_s3acc.

New in purestorage.flashblade 1.0.0

Synopsis

  • Create or delete object store accounts on a Pure Stoage FlashBlade.

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

api_token

string

FlashBlade API token for admin privileged user.

block_new_public_policies

boolean

added in purestorage.flashblade 1.15.0

If set to true, adding bucket policies that grant public access to a bucket is not allowed.

Choices:

  • false

  • true

block_public_access

boolean

added in purestorage.flashblade 1.15.0

If set to true, access to a bucket with a public policy is restricted to only authenticated users within the account that bucket belongs to.

Choices:

  • false

  • true

default_hard_limit

boolean

added in purestorage.flashblade 1.11.0

The value of this field will be used to configure the hard_limit field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value.

Choices:

  • false

  • true

default_quota

string

added in purestorage.flashblade 1.11.0

The value of this field will be used to configure the quota_limit field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value.

Values can be entered as K, M, T or P

If set to ‘’ (empty string), the bucket default is unlimited in size.

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.

hard_limit

boolean

added in purestorage.flashblade 1.11.0

If set to true, the account size, as defined by quota_limit, is used as a hard limit quota.

If set to false, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for quota_limit.

Choices:

  • false

  • true

name

string / required

The name of object store account

quota

string

added in purestorage.flashblade 1.11.0

The effective quota limit to be applied against the size of the account in bytes.

Values can be entered as K, M, T or P

If set to ‘’ (empty string), the account is unlimited in size.

state

string

Create or delete object store account

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: Create object store account foo (with no quotas)
  purestorage.flashblade.purefb_s3acc:
    name: foo
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create object store account foo (with quotas)
  purestorage.flashblade.purefb_s3acc:
    name: foo
    quota: 20480000
    hard_limit: true
    default_quota: 1024000
    default_hard_limit: false
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete object store account foo
  purestorage.flashblade.purefb_s3acc:
    name: foo
    state: absent
    fb_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

  • Pure Storage Ansible Team (@sdodsley)