everpure.flasharray.purefa_localgroup module – Manage Everpure FlashArray local groups

Note

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

To use it in a playbook, specify: everpure.flasharray.purefa_localgroup.

New in everpure.flasharray 1.45.0

Synopsis

• Create, rename, reconfigure and delete groups inside a local directory service on Everpure FlashArrays.

• Every group belongs to one local directory service, which is managed by everpure.flasharray.purefa_lds. Group names are only unique within a service, so local_directory_service is always required.

• Each local directory service is created holding its own Administrators, Guests, Backup Operators and Audit Operators groups. Those are built-in - the array allows neither modifying nor deleting them - so this module reports no change for a state=present task that asks nothing of them, and fails rather than pretending otherwise if a change is requested.

Requirements

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

• python >= 3.3

• purestorage >= 1.19

• py-pure-client >= 1.88.0

• netaddr

• requests

• pycountry

• urllib3

Parameters

Parameter	Comments
api_token string	FlashArray API token for admin privileged user.
client_id string added in everpure.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 everpure.flasharray 1.29.0	Disable insecure certificate warnings in debug logs Choices: false ← (default) true
email string	Email address to associate with the group.
fa_url string	FlashArray management IPv4 address or Hostname.
gid integer	Group ID to give the group. The array assigns one when the group is created without it. Group IDs only have to be unique within a local directory service.
id_token string added in everpure.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 everpure.flasharray.purefa_apiclient).
issuer string added in everpure.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 everpure.flasharray 1.43.0	Key ID of the API Client that issues the identity token. Used with private_key_file.
local_directory_service string / required	Name of the local directory service the group belongs to. Required because group names repeat across local directory services.
name string / required	Name of the local group
private_key_file string added in everpure.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 everpure.flasharray 1.43.0	Password protecting private_key_file, if encrypted.
rename string	Value to rename the specified local group to Re-running a rename task reports no change, as long as the group is already known by the new name.
state string	Define whether the local group should exist or not. Choices: "absent" "present" ← (default)
username string added in everpure.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

• Supported from Purity//FA 6.8.0 or higher. Local groups themselves go back further, but the parameters that scope a request to one local directory service arrived with the service object itself, and without them a request cannot be aimed reliably once an array holds more than one service.

• Deleting the local directory service deletes every group in it. See everpure.flasharray.purefa_lds.

• This module requires the py-pure-client Python library.

• 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 everpure.flasharray.purefa_apiclient.

Examples

- name: Create local group backup in local directory service foo
  everpure.flasharray.purefa_localgroup:
    name: backup
    local_directory_service: foo
    gid: 70001
    email: backup@example.com
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Create local group with an array-assigned GID
  everpure.flasharray.purefa_localgroup:
    name: reporting
    local_directory_service: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Change the email address of local group backup
  everpure.flasharray.purefa_localgroup:
    name: backup
    local_directory_service: foo
    email: storage@example.com
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Rename local group backup to archive
  everpure.flasharray.purefa_localgroup:
    name: backup
    local_directory_service: foo
    rename: archive
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete local group backup
  everpure.flasharray.purefa_localgroup:
    name: backup
    local_directory_service: foo
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Authors

• Everpure Ansible Team (@sdodsley)

Collection links

• Issue Tracker
• Repository (Sources)