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

purestorage.flashblade.purefb_target – Manage remote S3-capable targets for a FlashBlade

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

New in version 1.0.0: of purestorage.flashblade

Synopsis

  • Manage remote S3-capable targets for a FlashBlade system
  • Use this for non-FlashBlade targets.
  • Use purefb_connect for FlashBlade targets.

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
address
string
Address of S3-capable target (IP or FQDN)
api_token
string
FlashBlade API token for admin privileged user.
fb_url
string
FlashBlade management IP address or Hostname.
name
string / required
Name of S3-capable target (IP or FQDN)
state
string
    Choices:
  • absent
  • present ←
Create or delete remote target

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 a connection to remote S3-capable target
  purefb_target:
    name: target_1
    address: 10.10.10.20
    fb_url: 10.10.10.2
    api_token: T-89faa581-c668-483d-b77d-23c5d88ba35c
- name: Delete connection to remote S3-capable system
  purefb_target:
    state: absent
    name: target_1
    target_api: 9c0b56bc-f941-f7a6-9f85-dcc3e9a8f7d6
    fb_url: 10.10.10.2
    api_token: T-89faa581-c668-483d-b77d-23c5d88ba35c

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