Docs4dev
Docs
ansible / 2.10 / collections / purestorage / flashblade / purefb_remote_cred_module.html

purestorage.flashblade.purefb_remote_cred – Create, modify and delete FlashBlade object store remote credentials

Note

This plugin is part of the purestorage.flashblade collection (version 1.4.0).

To install it use: ansible-galaxy collection install purestorage.flashblade.

To use it in a playbook, specify: purestorage.flashblade.purefb_remote_cred.

New in version 1.0.0: of purestorage.flashblade

Synopsis

  • Create, modify and delete object store remote credentials
  • You must have a correctly configured remote array or target
  • This module is not idempotent when updating existing remote credentials

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
access_key
string
Access Key ID of the S3 target
api_token
string
FlashBlade API token for admin privileged user.
fb_url
string
FlashBlade management IP address or Hostname.
name
string / required
The name of the credential
secret
string
Secret Access Key for the S3 or Azure target
state
string
    Choices:
  • absent
  • present ←
Define state of remote credential
target
string / required
Define whether to initialize the S3 bucket

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 remote credential
  purefb_remote_cred:
    name: cred1
    access_key: "3794fb12c6204e19195f"
    secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    target: target1
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

- name: Delete remote credential
  purefb_remote_cred:
    name: cred1
    target: target1
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641

Authors

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