purestorage.flasharray.purefa_apiclient – Manage FlashArray API Clients
purestorage.flasharray.purefa_apiclient – Manage FlashArray API Clients
Note
This plugin is part of the purestorage.flasharray collection (version 1.5.1).
To install it use: ansible-galaxy collection install purestorage.flasharray
.
To use it in a playbook, specify: purestorage.flasharray.purefa_apiclient
.
New in version 1.5.0: of purestorage.flasharray
Synopsis
- Enable or disable FlashArray API Clients
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. | |
enabled boolean |
|
State of the API Client Key |
fa_url string |
FlashArray management IPv4 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 |
|
The maximum role allowed for ID Tokens issued by this API client |
state string |
|
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
purestorage
Python library - You must set
PUREFA_URL
andPUREFA_API
environment variables if fa_url and api_token arguments are not passed to the module directly
Examples
- name: Create API token ansible-token
purefa_apiclient:
name: ansible-token
issuer: "Pure Storage"
ttl: 3000
role: array_admin
public_key: "{{lookup('file', 'public_pem_file') }}"
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Disable API CLient
purefa_apiclient:
name: ansible-token
enabled: false
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Enable API CLient
purefa_apiclient:
name: ansible-token
enabled: true
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Delete API Client
purefa_apiclient:
state: absent
name: ansible-token
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
Authors
- Pure Storage Ansible Team (@sdodsley) <[email protected]>
© 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/flasharray/purefa_apiclient_module.html