Try SpotterManage Object Store Buckets on a Pure Storage FlashBlade.
| "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 with ansible-galaxy collection install purestorage.flashblade:==1.17.0
collections:
- name: purestorage.flashblade
version: 1.17.0This module managess object store (s3) buckets on Pure Storage FlashBlade.
- name: Create new bucket named foo in account bar
purestorage.flashblade.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
purestorage.flashblade.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
purestorage.flashblade.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
purestorage.flashblade.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
purestorage.flashblade.purefb_bucket:
name: foo
account: bar
state: absent
eradicate: true
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
mode:
choices:
- classic
- multi-site-writable
description:
- The type of bucket to be created. Also referred to a VSO Mode.
- Requires Purity//FB 3.3.3 or higher
- I(multi-site-writable) type can only be used after feature is enabled by Pure Technical
Support
type: str
version_added: 1.10.0
version_added_collection: purestorage.flashblade
name:
description:
- Bucket Name.
required: true
type: str
quota:
description:
- User quota in M, G, T or P units. This cannot be 0.
- This value will override the object store account's default bucket quota.
type: str
version_added: 1.12.0
version_added_collection: purestorage.flashblade
state:
choices:
- present
- absent
default: present
description:
- Create, delete or modifies a bucket.
required: false
type: str
fb_url:
description:
- FlashBlade management IP address or Hostname.
type: str
account:
description:
- Object Store Account for Bucket.
required: true
type: str
api_token:
description:
- FlashBlade API token for admin privileged user.
type: str
eradicate:
default: false
description:
- Define whether to eradicate the bucket on delete or leave in trash.
required: false
type: bool
hard_limit:
description:
- Whether the I(quota) value is enforced or not.
- If not provided the object store account default value will be used.
type: bool
version_added: 1.12.0
version_added_collection: purestorage.flashblade
versioning:
choices:
- enabled
- suspended
- absent
default: absent
description:
- State of S3 bucket versioning
required: false
type: str
retention_lock:
choices:
- ratcheted
- unlocked
default: unlocked
description:
- Set retention lock level for the bucket
- Once set to I(ratcheted) can only be lowered by Pure Technical Services
type: str
version_added: 1.12.0
version_added_collection: purestorage.flashblade
retention_mode:
choices:
- compliance
- governance
- ''
description:
- The retention mode used to apply locks on new objects if none is specified by the
S3 client
- Use "" to clear
- Once set to I(compliance) this can only be changed by contacting Pure Technical
Services
type: str
version_added: 1.12.0
version_added_collection: purestorage.flashblade
eradication_mode:
choices:
- permission-based
- retention-based
description:
- The eradication mode of the bucket.
type: str
version_added: 1.17.0
version_added_collection: purestorage.flashblade
default_retention:
description:
- The retention period, in days, used to apply locks on new objects if none is specified
by the S3 client
- Valid values between 1 and 365000
- Use "" to clear
type: str
version_added: 1.12.0
version_added_collection: purestorage.flashblade
eradication_delay:
description:
- Minimum eradication delay in days. Automatically eradicate destroyed buckets after
the delay time passes unless automatic eradication is delayed due to other configuration
values.
- Valid values are integer days from 1 to 30. Default is 1.
type: int
version_added: 1.17.0
version_added_collection: purestorage.flashblade
manual_eradication:
description:
- The manual eradication status of the bucket. If false, the bucket cannot be eradicated
after it has been destroyed, unless it is empty. If true, the bucket can be eradicated.
type: bool
version_added: 1.17.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
object_lock_enabled:
default: false
description:
- If set to true, then S3 APIs relating to object lock may be used
type: bool
version_added: 1.12.0
version_added_collection: purestorage.flashblade
freeze_locked_objects:
default: false
description:
- If set to true, a locked object will be read-only and no new versions of the object
may be created due to modifications
- After enabling, can be disabled only by contacting Pure Technical Services
type: bool
version_added: 1.12.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