purestorage.fusion.fusion_api_client module – Manage API clients in Pure Storage Fusion

Note

This module is part of the purestorage.fusion collection (version 1.2.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.fusion. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: purestorage.fusion.fusion_api_client.

New in purestorage.fusion 1.0.0

Synopsis

  • Create or delete an API Client in Pure Storage Fusion.

Requirements

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

  • python >= 3.5

  • purefusion

Parameters

Parameter

Comments

app_id

string

Application ID from Pure1 Registration page

eg. pure1:apikey:dssf2331sd

Defaults to the set environment variable under FUSION_APP_ID

key_file

string

Path to the private key file

Defaults to the set environment variable under FUSION_PRIVATE_KEY_FILE.

name

string / required

The name of the client.

public_key

string / required

The API clients PEM formatted (Base64 encoded) RSA public key.

Include the —–BEGIN PUBLIC KEY—– and —–END PUBLIC KEY—– lines.

state

string

Define whether the client should exist or not.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Supports check mode.

  • This module requires the purefusion Python library

  • You must set FUSION_APP_ID and FUSION_PRIVATE_KEY_FILE environment variables if app_id and key_file arguments are not passed to the module directly

Examples

- name: Create new API client foo
  purestorage.fusion.fusion_api_client:
    name: "foo client"
    public_key: "{{lookup('file', 'public_pem_file') }}"
    app_id: key_name
    key_file: "az-admin-private-key.pem"

Authors

  • Pure Storage Ansible Team (@sdodsley)