purestorage.flashblade.purefb_bucket_replica module – Manage bucket replica links between Pure Storage FlashBlades

Note

This module is part of the purestorage.flashblade collection (version 1.24.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_bucket_replica.

New in purestorage.flashblade 1.0.0

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

This module manages bucket replica links between Pure Storage 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.
cascading boolean added in purestorage.flashblade 1.14.0	Objects replicated to this bucket via a replica link from another array will also be replicated by this link to the remote bucket Choices: `false` ← (default) `true`
context string added in purestorage.flashblade 1.22.0	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: `""`
credential string	Name of remote credential name to use.
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.
name string / required	Local Bucket Name.
paused boolean	State of the bucket replica link Choices: `false` ← (default) `true`
state string	Creates or modifies a bucket replica link Choices: `"present"` ← (default) `"absent"`
target string	Remote array or target name to create replica on.
target_bucket string	Name of target bucket name If not supplied, will default to name.

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

Examples

- name: Create new bucket replica from foo to bar on arrayB
  purestorage.flashblade.purefb_bucket_replica:
    name: foo
    target: arrayB
    target_bucket: bar
    credential: cred_1
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Pause exisitng bucket replica link
  purestorage.flashblade.purefb_bucket_replica:
    name: foo
    paused: true
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete bucket replica link foo
  purestorage.flashblade.purefb_bucket_replica:
    name: foo
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Authors

Pure Storage Ansible Team (@sdodsley)

Collection links

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