purestorage.flashblade.purefb_policy – Manage FlashBlade policies

Note

This plugin is part of the purestorage.flashblade collection (version 1.7.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_policy.

New in version 1.0.0: of purestorage.flashblade

Synopsis

  • Manage policies for filesystem and file replica links

Requirements

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

  • python >= 2.7
  • purity_fb >= 1.9
  • netaddr
  • pytz

Parameters

Parameter Choices/Defaults Comments
api_token
string
FlashBlade API token for admin privileged user.
at
string
Provide a time in 12-hour AM/PM format, eg. 11AM
enabled
boolean
    Choices:
  • no
  • yes ←
State of policy
every
integer
Interval between snapshots in seconds
Range available 300 - 31536000 (equates to 5m to 365d)
fb_url
string
FlashBlade management IP address or Hostname.
filesystem
list / elements=string
List of filesystems to add to a policy on creation
To amend policy members use the purefb_fs module
keep_for
integer
How long to keep snapshots for
Range available 300 - 31536000 (equates to 5m to 365d)
Must not be set less than every
name
string
Name of the policy
replica_link
list / elements=string
List of filesystem replica links to add to a policy on creation
To amend policy members use the purefb_fs_replica module
state
string
    Choices:
  • absent
  • present ←
Create or delete policy
timezone
string
Time Zone used for the at parameter
If not provided, the module will attempt to get the current local timezone from the server

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 simple policy with no rules
  purefb_policy:
    name: test_policy
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6
- name: Create a policy and connect to existing filesystems and filesystem replica links
  purefb_policy:
    name: test_policy_with_members
    filesystem:
    - fs1
    - fs2
    replica_link:
    - rl1
    - rl2
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6
- name: Create a policy with rules
  purefb_policy:
    name: test_policy2
    at: 11AM
    keep_for: 86400
    every: 86400
    timezone: Asia/Shanghai
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6
- name: Delete a policy
  purefb_policy:
    name: test_policy
    state: absent
    fb_url: 10.10.10.2
    api_token: T-9f276a18-50ab-446e-8a0c-666a3529a1b6

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/purestorage/flashblade/purefb_policy_module.html