purestorage.flashblade.purefb_lifecycle module – Manage FlashBlade object lifecycles

Note

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

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

New in version 1.4.0: of purestorage.flashblade

Synopsis

  • Manage lifecycles for object buckets

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • purity_fb >= 1.9

  • netaddr

  • pytz

Parameters

Parameter

Comments

abort_uploads_after

string

added in 1.8.0 of purestorage.flashblade

Duration of time after which incomplete multipart uploads will be aborted.

Enter as days (d) or weeks (w). Range is 1 - 2147483647 days.

api_token

string

FlashBlade API token for admin privileged user.

bucket

string / required

Bucket the lifecycle rule applies to

enabled

boolean

State of lifecycle rule

Choices:

  • no

  • yes ← (default)

fb_url

string

FlashBlade management IP address or Hostname.

keep_current_for

string

added in 1.8.0 of purestorage.flashblade

Time after which current versions will be marked expired.

Enter as days (d) or weeks (w). Range is 1 - 2147483647 days.

keep_current_until

string

added in 1.8.0 of purestorage.flashblade

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.

keep_previous_for

aliases: keep_for

string

Time after which previous versions will be marked expired.

Enter as days (d) or weeks (w). Range is 1 - 2147483647 days.

name

string / required

Name of the lifecycle rule

prefix

string

Object key prefix identifying one or more objects in the bucket

state

string

Create or delete lifecycle rule

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 a lifecycle rule called bar for bucket foo (pre-Purity//FB 3.2.3)
  purefb_lifecycle:
    name: bar
    bucket: foo
    keep_previous_for: 2d
    prefix: test
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6
- name: Create a lifecycle rule called bar for bucket foo (post-Purity//FB 3.2.3)
  purefb_lifecycle:
    name: bar
    bucket: foo
    keep_previous_for: 2d
    keep_current_for: 1w
    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 (post-Purity//FB 3.2.3)
  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
  purefb_lifecycle:
    name: foo
    bucket: bar
    state: absent
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

Authors

  • Pure Storage Ansible Team (@sdodsley)