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

purestorage.flashblade.purefb_apiclient – Manage FlashBlade API Clients

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

New in version 1.6.0: of purestorage.flashblade

Synopsis

  • Enable or disable FlashBlade API Clients

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.
enabled
boolean
    Choices:
  • no
  • yes ←
State of the API Client Key
fb_url
string
FlashBlade management IP address or Hostname.
issuer
string
The name of the identity provider that will be issuing ID Tokens for this API client
If not specified, defaults to the API client name, name.
name
string / required
Name of the API Client
public_key
string
The API clients PEM formatted (Base64 encoded) RSA public key.
Include the —–BEGIN PUBLIC KEY—– and —–END PUBLIC KEY—– lines
role
string
    Choices:
  • readonly
  • ops_admin
  • storage_admin
  • array_admin
The maximum role allowed for ID Tokens issued by this API client
state
string
    Choices:
  • absent
  • present ←
Define whether the API client should exist or not.
token_ttl
integer
Default:
86400
Time To Live length in seconds for the exchanged access token
Range is 1 second to 1 day (86400 seconds)

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 API token ansible-token
  purefb_apiclient:
    name: ansible_token
    issuer: "Pure_Storage"
    token_ttl: 3000
    role: array_admin
    public_key: "{{lookup('file', 'public_pem_file') }}"
    fb_url: 10.10.10.2
    api_token: T-68618f31-0c9e-4e57-aa44-5306a2cf10e3

- name: Disable API CLient
  purefb_apiclient:
    name: ansible_token
    enabled: false
    fb_url: 10.10.10.2
    api_token: T-68618f31-0c9e-4e57-aa44-5306a2cf10e3

- name: Enable API CLient
  purefb_apiclient:
    name: ansible_token
    enabled: true
    fb_url: 10.10.10.2
    api_token: T-68618f31-0c9e-4e57-aa44-5306a2cf10e3

- name: Delete API Client
  purefb_apiclient:
    state: absent
    name: ansible_token
    fb_url: 10.10.10.2
    api_token: T-68618f31-0c9e-4e57-aa44-5306a2cf10e3

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