purestorage.flashblade.purefb_s3acc (1.17.0) — module

Create or delete FlashBlade Object Store accounts

| "added in version" 1.0.0 of purestorage.flashblade"

Authors: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install collection

Install with ansible-galaxy collection install purestorage.flashblade:==1.17.0


Add to requirements.yml

  collections:
    - name: purestorage.flashblade
      version: 1.17.0

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
name:
    description:
    - The name of object store account
    required: true
    type: str

quota:
    description:
    - 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.
    type: str
    version_added: 1.11.0
    version_added_collection: purestorage.flashblade

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Create or delete object store account
    type: str

fb_url:
    description:
    - FlashBlade management IP address or Hostname.
    type: str

api_token:
    description:
    - FlashBlade API token for admin privileged user.
    type: str

hard_limit:
    description:
    - If set to true, the account size, as defined by I(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 I(quota_limit).
    type: bool
    version_added: 1.11.0
    version_added_collection: purestorage.flashblade

default_quota:
    description:
    - The value of this field will be used to configure the I(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.
    type: str
    version_added: 1.11.0
    version_added_collection: purestorage.flashblade

default_hard_limit:
    description:
    - The value of this field will be used to configure the I(hard_limit) field of newly
      created buckets associated with this object store account, if the bucket creation
      does not specify its own value.
    type: bool
    version_added: 1.11.0
    version_added_collection: purestorage.flashblade

block_public_access:
    description:
    - 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.
    type: bool
    version_added: 1.15.0
    version_added_collection: purestorage.flashblade

block_new_public_policies:
    description:
    - If set to true, adding bucket policies that grant public access to a bucket is not
      allowed.
    type: bool
    version_added: 1.15.0
    version_added_collection: purestorage.flashblade