purestorage.flashblade.purefb_fs_replica module – Manage filesystem replica links between Everpure FlashBlades

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_fs_replica.

New in purestorage.flashblade 1.0.0

Synopsis

• This module manages filesystem replica links between Everpure FlashBlades.

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
api_token string	FlashBlade API token for admin privileged user.
client_id string added in purestorage.flashblade 1.26.0	ID of the API Client that issues the identity token. Used with private_key_file.
disable_warnings boolean added in purestorage.flashblade 1.18.0	Disable insecure certificate warnings Choices: false ← (default) true
fb_url string	FlashBlade management IP address or Hostname.
id_token string added in purestorage.flashblade 1.26.0	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).
in_progress boolean	Confirmation that you wish to delete a filesystem replica link This may cancel any in-progress replication transfers) Choices: false ← (default) true
issuer string added in purestorage.flashblade 1.26.0	The API Client’s trusted identity issuer registered on the array. Used with private_key_file.
key_id string added in purestorage.flashblade 1.26.0	Key ID of the API Client that issues the identity token. Used with private_key_file.
name string / required	Local Filesystem Name.
policy string	Name of filesystem snapshot policy to apply to the replica link.
private_key_file string added in purestorage.flashblade 1.26.0	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.
private_key_password string added in purestorage.flashblade 1.26.0	Password protecting private_key_file, if encrypted.
state string	Creates or modifies a filesystem replica link Choices: "present" ← (default) "absent"
target_array string	Remote array name to create replica on.
target_fs string	Name of target filesystem name If not supplied, will default to name.
username string added in purestorage.flashblade 1.26.0	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_URL and PUREFB_API environment variables if fb_url and api_token arguments are not passed to the module directly

• Token-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 new filesystem replica from foo to bar on arrayB
  purestorage.flashblade.purefb_fs_replica:
    name: foo
    target_array: arrayB
    target_fs: bar
    policy: daily
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Add new snapshot policy to exisitng filesystem replica link
  purestorage.flashblade.purefb_fs_replica:
    name: foo
    policy: weekly
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete snapshot policy from filesystem replica foo
  purestorage.flashblade.purefb_fs_replica:
    name: foo
    policy: weekly
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Authors

• Everpure Ansible Team (@sdodsley)

Collection links

• Issue Tracker
• Repository (Sources)