everpure.flashblade.purefb_fs_replica module – Manage filesystem replica links between Everpure FlashBlades
Note
This module is part of the everpure.flashblade collection (version 1.29.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 everpure.flashblade.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: everpure.flashblade.purefb_fs_replica.
New in everpure.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 |
|---|---|
FlashBlade API token for admin privileged user. |
|
ID of the API Client that issues the identity token. Used with private_key_file. |
|
Disable insecure certificate warnings 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 everpure.flashblade.purefb_apiclient). |
|
Confirmation that you wish to delete a filesystem replica link This may cancel any in-progress replication transfers) Choices:
|
|
The API Client’s trusted identity issuer registered on the array. Used with private_key_file. |
|
Key ID of the API Client that issues the identity token. Used with private_key_file. |
|
Local Filesystem Name. |
|
Name of filesystem snapshot policy to apply to the replica link. |
|
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. |
|
Creates or modifies a filesystem replica link. With state=absent and policy set, the policy is removed from the replica link. Without policy the replica link itself is deleted (requires REST 2.10 or higher). Choices:
|
|
Remote array name to create replica on. |
|
Name of target filesystem name If not supplied, will default to name. |
|
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 everpure.flashblade.purefb_apiclient
Examples
- name: Create new filesystem replica from foo to bar on arrayB
everpure.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
everpure.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
everpure.flashblade.purefb_fs_replica:
name: foo
policy: weekly
state: absent
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: Delete the filesystem replica link for foo
everpure.flashblade.purefb_fs_replica:
name: foo
state: absent
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641