Docs4dev
Docs
ansible / latest / collections / purestorage / flashblade / purefb_bucket_replica_module.html

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

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

New in version 1.0.0: of purestorage.flashblade

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 >= 2.7
  • purity_fb >= 1.9
  • netaddr
  • pytz

Parameters

Parameter Choices/Defaults Comments
api_token
string
FlashBlade API token for admin privileged user.
credential
string
Name of remote credential name to use.
fb_url
string
FlashBlade management IP address or Hostname.
name
string / required
Local Bucket Name.
paused
boolean
    Choices:
  • no ←
  • yes
State of the bucket replica link
state
string
    Choices:
  • present ←
  • absent
Creates or modifies a bucket replica link
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

  • 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 new bucket replica from foo to bar on arrayB
  purefb_bucket_replica:
    name: foo
    target: arrayB
    target_bucket: bar
    credentials: cred_1
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Pause exisitng bucket replica link
  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
  purefb_fs_replica:
    name: foo
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

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_bucket_replica_module.html