Docs4dev
Docs
ansible / latest / collections / purestorage / flasharray / purefa_pod_replica_module.html

purestorage.flasharray.purefa_pod_replica – Manage ActiveDR pod replica links between Pure Storage FlashArrays

Note

This plugin is part of the purestorage.flasharray collection (version 1.11.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.flasharray.

To use it in a playbook, specify: purestorage.flasharray.purefa_pod_replica.

New in version 1.0.0: of purestorage.flasharray

Synopsis

  • This module manages ActiveDR pod replica links between Pure Storage FlashArrays.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • purestorage >= 1.19
  • py-pure-client >= 1.6.0
  • netaddr
  • requests

Parameters

Parameter Choices/Defaults Comments
api_token
string
FlashArray API token for admin privileged user.
fa_url
string
FlashArray management IPv4 address or Hostname.
name
string / required
ActiveDR source pod name
pause
boolean
    Choices:
  • no
  • yes
Pause/unpause a pod replica link
state
string
    Choices:
  • present ←
  • absent
Creates or modifies a pod replica link
target_array
string
Remote array name to create replica on.
target_pod
string
Name of target pod
Must not be the same as the local pod.

Notes

Note

  • This module requires the purestorage and py-pure-client Python libraries
  • Additional Python librarues may be required for specific modules.
  • You must set PUREFA_URL and PUREFA_API environment variables if fa_url and api_token arguments are not passed to the module directly

Examples

- name: Create new pod replica link from foo to bar on arrayB
  purefa_pod_replica:
    name: foo
    target_array: arrayB
    target_pod: bar
    state: present
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Pause an pod replica link
  purefa_pod_replica:
    name: foo
    pause: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete and eradicate pod replica link
  purefa_pod_replica:
    name: foo
    state: absent
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

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/flasharray/purefa_pod_replica_module.html