netapp.storagegrid.na_sg_org_user – NetApp StorageGRID manage users within a tenancy.

Note

This plugin is part of the netapp.storagegrid collection (version 21.9.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_org_user.

New in version 20.6.0: of netapp.storagegrid

Synopsis

  • Create, Update, Delete Users within a NetApp StorageGRID tenant.

Parameters

Parameter Choices/Defaults Comments
api_url
string / required
The url to the StorageGRID Admin Node REST API.
auth_token
string / required
The authorization token for the API request
disable
boolean
    Choices:
  • no
  • yes
Disable the user from signing in. Does not apply to federated users.
full_name
string
Full Name of the user.
Required for create operation
member_of
list / elements=string
List of unique_groups that the user is a member of.
password
string
Set a password for a local user. Does not apply to federated users.
Requires root privilege.
state
string
    Choices:
  • present ←
  • absent
Whether the specified user should exist or not.
unique_name
string / required
Unique Name for the user. Must begin with user/ or federated-user/.
Required for create, modify or delete operation.
update_password
string
    Choices:
  • on_create ←
  • always
Choose when to update the password.
When set to always, the password will always be updated.
When set to on_create, the password will only be set upon a new user creation.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Should https certificates be validated?

Notes

Note

  • The modules prefixed with na_sg are built to manage NetApp StorageGRID.

Examples

- name: create a tenant user
  netapp.storagegrid.na_sg_org_user:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    full_name: ansibleuser1
    unique_name: user/ansibleuser1
    member_of: "group/ansiblegroup1"
    disable: false

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
resp
dictionary
always
Returns information about the StorageGRID tenant user.

Sample:
{'accountId': '0', 'disable': False, 'federated': False, 'fullName': 'Example User', 'id': '00000000-0000-0000-0000-000000000000', 'memberOf': ['00000000-0000-0000-0000-000000000000'], 'uniqueName': 'user/Example', 'userURN': 'urn:sgws:identity::0:user/Example'}


Authors