everpure.flashblade.purefb_local_group module – Manage FlashBlade Local Directory Service groups
Note
This module is part of the everpure.flashblade collection (version 1.29.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.flashblade.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: everpure.flashblade.purefb_local_group.
New in everpure.flashblade 1.28.0
Synopsis
Create, update, rename or delete a local group in a FlashBlade Local Directory Service (LDS). These are the SMB/NFS local identities that live inside an LDS attached to a FlashBlade server.
Requires FlashBlade REST API version 2.24 or later (Purity//FB 4.6.8+).
User memberships can be managed inline via the local_users option. If you also drive membership from the user side (via everpure.flashblade.purefb_local_user), only manage a given (user,group) edge from one side in a single playbook run.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9
py-pure-client
netaddr
datetime
pytz
distro
pycountry
urllib3
Parameters
Parameter |
Comments |
|---|---|
FlashBlade API token for admin privileged user. |
|
ID of the API Client that issues the identity token. Used with private_key_file. |
|
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 insecure certificate warnings Choices:
|
|
Email address for the group. |
|
FlashBlade management IP address or Hostname. |
|
Only used when state=absent. When the group has members and force=false, the module fails with a clear message rather than surfacing the raw API error. When force=true, the module removes all current memberships before deleting the group. Refused on built-in groups regardless. Choices:
|
|
Numeric GID for the group. Auto-assigned by the array if omitted at create time. Patchable. |
|
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.flashblade.purefb_apiclient). |
|
The API Client’s trusted identity issuer registered on the array. Used with private_key_file. |
|
Key ID of the API Client that issues the identity token. Used with private_key_file. |
|
Name of the Local Directory Service that owns this group. Attach LDSes to servers via everpure.flashblade.purefb_server. |
|
List of local-user names that should be members of this group. When set, the module reconciles the group’s user members against this list via The option is named local_users rather than members to reserve option space for future external_members and group_members without a breaking rename. |
|
Name of the local group inside the LDS. |
|
New name for the group. Uses the Rejected for built-in groups. |
|
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. |
|
Password protecting private_key_file, if encrypted. |
|
Whether the local group should exist or not. Choices:
|
|
Username the issued token should be granted to. Must be a valid user on the array. Used with private_key_file. |
Notes
Note
You must set
PUREFB_URLandPUREFB_APIenvironment variables if fb_url and api_token arguments are not passed to the module directlyToken-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.flashblade.purefb_apiclient
Examples
- name: Create local group 'developers'
everpure.flashblade.purefb_local_group:
name: developers
local_directory_service: myserver_local
gid: 6001
email: developers@example.com
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: Ensure 'developers' has these local user members
everpure.flashblade.purefb_local_group:
name: developers
local_directory_service: myserver_local
local_users:
- alice
- bob
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: Rename local group
everpure.flashblade.purefb_local_group:
name: developers
new_name: devs
local_directory_service: myserver_local
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: Delete an empty local group
everpure.flashblade.purefb_local_group:
name: devs
local_directory_service: myserver_local
state: absent
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
- name: Force-delete a group that still has members
everpure.flashblade.purefb_local_group:
name: devs
local_directory_service: myserver_local
state: absent
force: true
fb_url: 10.10.10.2
api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641