netapp.storagegrid.na_sg_grid_user module – NetApp StorageGRID manage users.
Note
This module is part of the netapp.storagegrid collection (version 21.13.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 netapp.storagegrid
.
To use it in a playbook, specify: netapp.storagegrid.na_sg_grid_user
.
Note
The netapp.storagegrid collection is considered unmaintained and will be removed from Ansible 11. See the discussion thread for more information.
New in netapp.storagegrid 20.6.0
Synopsis
Create, Update, Delete Administrative Users within NetApp StorageGRID.
Parameters
Parameter |
Comments |
---|---|
The url to the StorageGRID Admin Node REST API. |
|
The authorization token for the API request |
|
Disable the user from signing in. Does not apply to federated users. Choices:
|
|
Full Name of the user. Required for create operation |
|
List of |
|
Set a password for a local user. Does not apply to federated users. Requires root privilege. |
|
Whether the specified user should exist or not. Choices:
|
|
Unique Name for the user. Must begin with Required for create, modify or delete operation. |
|
Choose when to update the password. When set to When set to Choices:
|
|
Should https certificates be validated? Choices:
|
Notes
Note
The modules prefixed with
na_sg
are built to manage NetApp StorageGRID.
Examples
- name: create a user
netapp.storagegrid.na_sg_grid_user:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: present
full_name: ansibleuser100
unique_name: user/ansibleuser100
member_of: "group/ansiblegroup100"
disable: false
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Returns information about the StorageGRID Grid user. Returned: always Sample: |