purestorage.fusion.fusion_pp module – Manage protection policies in Pure Storage Fusion

Note

This module is part of the purestorage.fusion collection (version 1.6.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.fusion. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.fusion.fusion_pp.

Note

The purestorage.fusion collection has been deprecated and will be removed from Ansible 10. See the discussion thread for more information.

New in purestorage.fusion 1.0.0

Synopsis

  • Manage protection policies in Pure Storage Fusion.

Requirements

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

  • python >= 3.8

  • purefusion

Parameters

Parameter

Comments

access_token

string

Access token for Fusion Service

Defaults to the set environment variable under FUSION_ACCESS_TOKEN

destroy_snapshots_on_delete

boolean

Before deleting protection policy, snapshots within the protection policy will be deleted.

If `false` then any snapshots will need to be deleted as a separate step before removing the protection policy.

Choices:

  • false

  • true

display_name

string

The human name of the protection policy.

If not provided, defaults to name.

issuer_id

aliases: app_id

string

Application ID from Pure1 Registration page

eg. pure1:apikey:dssf2331sd

Defaults to the set environment variable under FUSION_ISSUER_ID

local_retention

string

Retention Duration for periodic snapshots.

Minimum value is 10 minutes.

Value can be provided as m(inutes), h(ours), d(ays), w(eeks), or y(ears).

If no unit is provided, minutes are assumed.

local_rpo

string

Recovery Point Objective for snapshots.

Minimum value is 10 minutes.

Value can be provided as m(inutes), h(ours), d(ays), w(eeks), or y(ears).

If no unit is provided, minutes are assumed.

name

string / required

The name of the protection policy.

private_key_file

aliases: key_file

string

Path to the private key file

Defaults to the set environment variable under FUSION_PRIVATE_KEY_FILE.

private_key_password

string

Password of the encrypted private key file

state

string

Define whether the protection policy should exist or not.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Supports check mode.

  • This module requires the purefusion Python library

  • You must set FUSION_ISSUER_ID and FUSION_PRIVATE_KEY_FILE environment variables if issuer_id and private_key_file arguments are not passed to the module directly

  • If you want to use access token for authentication, you must use FUSION_ACCESS_TOKEN environment variable if access_token argument is not passed to the module directly

Examples

- name: Create new protection policy foo
  purestorage.fusion.fusion_pp:
    name: foo
    local_rpo: 10
    local_retention: 4d
    display_name: "foo pp"
    issuer_id: key_name
    private_key_file: "az-admin-private-key.pem"

- name: Delete protection policy foo
  purestorage.fusion.fusion_pp:
    name: foo
    state: absent
    issuer_id: key_name
    private_key_file: "az-admin-private-key.pem"

Authors

  • Pure Storage Ansible Team (@sdodsley)