purestorage.flasharray.purefa_tgroup module – Manage topology groups on Everpure FlashArrays

Note

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

To use it in a playbook, specify: purestorage.flasharray.purefa_tgroup.

New in purestorage.flasharray 1.43.0

Synopsis

  • Create, delete or modify topology groups on Everpure FlashArrays.

  • Supports topology group rename, parent moves, and direct member management.

Requirements

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

  • python >= 3.3

  • purestorage >= 1.19

  • py-pure-client >= 1.26.0

  • netaddr

  • requests

  • pycountry

  • urllib3

Parameters

Parameter

Comments

api_token

string

FlashArray API token for admin privileged user.

array

list / elements=string

List of existing arrays to add to or remove from the topology group.

client_id

string

added in purestorage.flasharray 1.43.0

ID of the API Client that issues the identity token.

Used with private_key_file.

context

string

Name of fleet member on which to perform the operation.

This requires the array receiving the request is a member of a fleet and the context name to be a member of the same fleet.

Default: ""

disable_warnings

boolean

added in purestorage.flasharray 1.29.0

Disable insecure certificate warnings in debug logs

Choices:

  • false ← (default)

  • true

fa_url

string

FlashArray management IPv4 address or Hostname.

id_token

string

added in purestorage.flasharray 1.43.0

A pre-signed JWT to authenticate with, as an alternative to api_token.

The token is exchanged by the array for a short-lived access token.

Requires a matching API Client to be registered on the array (see purestorage.flasharray.purefa_apiclient).

issuer

string

added in purestorage.flasharray 1.43.0

The API Client’s trusted identity issuer registered on the array.

Used with private_key_file.

key_id

string

added in purestorage.flasharray 1.43.0

Key ID of the API Client that issues the identity token.

Used with private_key_file.

name

string / required

The name of the topology group.

parent

string

Parent topology group name.

private_key_file

string

added in purestorage.flasharray 1.43.0

Path to the PEM RSA private key used to sign an identity token, as an alternative to api_token.

Requires client_id, key_id, issuer and username.

private_key_password

string

added in purestorage.flasharray 1.43.0

Password protecting private_key_file, if encrypted.

rename

string

New name of the topology group.

state

string

Define whether the topology group should exist or not.

Choices:

  • "absent"

  • "present" ← (default)

tgroup

list / elements=string

List of existing child topology groups to add to or remove from the topology group.

username

string

added in purestorage.flasharray 1.43.0

Username the issued token should be granted to.

Must be a valid user on the array. Used with private_key_file.

Notes

Note

  • This module requires the purestorage and py-pure-client Python libraries.

  • Additional Python libraries may be required for specific modules.

  • You must set PUREFA_URL and PUREFA_API environment variables if fa_url and api_token arguments are not passed to the module directly.

  • Token-based authentication (id_token, or private_key_file with client_id, key_id, issuer and username) may be used as an alternative to api_token, and requires a matching API Client registered on the array via purestorage.flasharray.purefa_apiclient.

Examples

- name: Create a topology group
  purestorage.flasharray.purefa_tgroup:
    name: app-stack
    fa_url: 10.10.10.2
    api_token: 1234-5678-9012-3456

- name: Create a child topology group under an existing parent
  purestorage.flasharray.purefa_tgroup:
    name: app-stack-dev
    parent: app-stack
    fa_url: 10.10.10.2
    api_token: 1234-5678-9012-3456

- name: Rename a topology group
  purestorage.flasharray.purefa_tgroup:
    name: app-stack-dev
    rename: app-stack-qa
    fa_url: 10.10.10.2
    api_token: 1234-5678-9012-3456

- name: Add array and child topology group members
  purestorage.flasharray.purefa_tgroup:
    name: app-stack
    array:
      - array-a
      - array-b
    tgroup:
      - app-stack-qa
    fa_url: 10.10.10.2
    api_token: 1234-5678-9012-3456

- name: Remove specific members from a topology group
  purestorage.flasharray.purefa_tgroup:
    name: app-stack
    array:
      - array-b
    tgroup:
      - app-stack-qa
    state: absent
    fa_url: 10.10.10.2
    api_token: 1234-5678-9012-3456

- name: Delete a topology group
  purestorage.flasharray.purefa_tgroup:
    name: app-stack-dev
    state: absent
    fa_url: 10.10.10.2
    api_token: 1234-5678-9012-3456

Authors

  • Everpure Ansible Team (@sdodsley)