everpure.flashblade.purefb_connect module – Manage replication connections between two 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_connect.
New in everpure.flashblade 1.0.0
Synopsis
Manage replication connections to specified remote FlashBlade system
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. |
|
Name of fleet member on which to perform the operation. This requires the array receiving the request is a member of a fleet and the context name to be a member of the same fleet. Default: |
|
Default maximum bandwidth threshold for outbound traffic in bytes. B, K, M, or G units. See examples. Must be 0 or between 5MB and 28GB Once exceeded, bandwidth throttling occurs |
|
Disable insecure certificate warnings Choices:
|
|
Define if replication connection is encrypted 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). |
|
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. |
|
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. |
|
Create or delete replication connection Choices:
|
|
API token for target FlashBlade system |
|
Replication IP address of target FlashBlade system If not set at time of connection creation, will default to all the replication addresses available on the target array at the time of connection creation. |
|
Management IP address of target FlashBlade system |
|
Username the issued token should be granted to. Must be a valid user on the array. Used with private_key_file. |
|
The window end time. The time must be set to the hour. |
|
Maximum bandwidth threshold for outbound traffic during the specified time range in bytes. B, K, M, or G units. See examples. Must be 0 or between 5MB and 28GB Once exceeded, bandwidth throttling occurs |
|
The window start time. The time must be set to the hour. |
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 a connection to remote FlashBlade system
everpure.flashblade.purefb_connect:
target_url: 10.10.10.20
target_api: T-b3275b1c-8958-4190-9052-eb46b0bd09f8
fb_url: 10.10.10.2
api_token: T-91528421-fe42-47ee-bcb1-47eefb0a9220
- name: Create a connection to remote FlashBlade system with bandwidth limits
everpure.flashblade.purefb_connect:
target_url: 10.10.10.20
target_api: T-b3275b1c-8958-4190-9052-eb46b0bd09f8
window_limit: 28G
window_start: 1AM
window_end: 7AM
default_limit: 5M
fb_url: 10.10.10.2
api_token: T-91528421-fe42-47ee-bcb1-47eefb0a9220
- name: Delete connection to target FlashBlade system
everpure.flashblade.purefb_connect:
state: absent
target_url: 10.10.10.20
target_api: T-b3275b1c-8958-4190-9052-eb46b0bd09f8
fb_url: 10.10.10.2
api_token: T-91528421-fe42-47ee-bcb1-47eefb0a9220