purestorage.flashblade.purefb_lifecycle module – Manage FlashBlade object lifecycles
Note
This module is part of the purestorage.flashblade collection (version 1.26.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.
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_lifecycle.
New in purestorage.flashblade 1.4.0
Synopsis
Manage lifecycles for object buckets
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9
py-pure-client
netaddr
datetime
pytz
distro
pycountry
urllib3
Parameters
Parameter |
Comments |
|---|---|
Duration of time after which incomplete multipart uploads will be aborted. Enter as days (d) or weeks (w). Range is 1 - 2147483647 days. |
|
FlashBlade API token for admin privileged user. |
|
Bucket the lifecycle rule applies to |
|
ID of the API Client that issues the identity token. Used with private_key_file. |
|
Name of fleet member on which to perform the operation. This requires the array receiving the request is a member of a fleet and the context name to be a member of the same fleet. Default: |
|
Disable insecure certificate warnings Choices:
|
|
State of lifecycle rule Choices:
|
|
FlashBlade management IP address or Hostname. |
|
A pre-signed JWT to authenticate with, as an alternative to api_token. The token is exchanged by the array for a short-lived access token. Requires a matching API Client to be registered on the array (see purestorage.flashblade.purefb_apiclient). |
|
The API Client’s trusted identity issuer registered on the array. Used with private_key_file. |
|
Time after which current versions will be marked expired. Enter as days (d) or weeks (w). Range is 1 - 2147483647 days. |
|
Date after which current versions will be marked expired. Enter as date in form YYYY-MM-DD. Note: setting a date in the past will delete ALL objects with the value of prefix as they are created. |
|
Time after which previous versions will be marked expired. Enter as days (d) or weeks (w). Range is 1 - 2147483647 days. |
|
Key ID of the API Client that issues the identity token. Used with private_key_file. |
|
Name of the lifecycle rule |
|
Object key prefix identifying one or more objects in the bucket |
|
Path to the PEM RSA private key used to sign an identity token, as an alternative to api_token. Requires client_id, key_id, issuer and username. |
|
Password protecting private_key_file, if encrypted. |
|
Create or delete lifecycle rule Choices:
|
|
Username the issued token should be granted to. Must be a valid user on the array. Used with private_key_file. |
Notes
Note
You must set
PUREFB_URLandPUREFB_APIenvironment variables if fb_url and api_token arguments are not passed to the module directlyToken-based authentication (id_token, or private_key_file with client_id, key_id, issuer and username) may be used as an alternative to api_token, and requires a matching API Client registered on the array via purestorage.flashblade.purefb_apiclient
Examples
- name: Create a lifecycle rule called bar for bucket foo
purestorage.flashblade.purefb_lifecycle:
name: bar
bucket: foo
keep_previous_for: 2d
abort_uploads_after: 1d
keep_current_until: 2020-11-23
prefix: test
fb_url: 10.10.10.2
api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6
- name: Modify a lifecycle rule
purestorage.flashblade.purefb_lifecycle:
name: bar
bucket: foo
keep_previous_for: 10d
fb_url: 10.10.10.2
api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6
- name: Delete lifecycle rule foo from bucket foo
purestorage.flashblade.purefb_lifecycle:
name: foo
bucket: bar
state: absent
fb_url: 10.10.10.2
api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6