netapp.storagegrid.na_sg_grid_group module – NetApp StorageGRID manage groups.
Note
This module is part of the netapp.storagegrid collection (version 21.10.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_group
.
New in version 20.6.0: of netapp.storagegrid
Parameters
Parameter |
Comments |
---|---|
The url to the StorageGRID Admin Node REST API. |
|
The authorization token for the API request |
|
Name of the group. Required for create operation |
|
Management access controls granted to the group within the tenancy. |
|
Users in this group will have permissions to reactivate features. Choices:
|
|
Group members can have permission to acknowledge alarms. Choices:
|
|
Users in this group will have permissions to change tenant password. Choices:
|
|
Users in this group will have permissions to change grid topology. Choices:
|
|
Users in this group will have permissions to manage ILM rules on StorageGRID. Choices:
|
|
Users in this group will have permissions to run maintenance tasks on StorageGRID. Choices:
|
|
Users in this group will have permissions to query metrics on StorageGRID. Choices:
|
|
Users in this group will have permissions to manage object metadata. Choices:
|
|
Need to investigate. Choices:
|
|
Users in this group will have root access. Choices:
|
|
Users in this group will have permissions to manage tenant accounts. Choices:
|
|
Whether the specified group should exist or not. Choices:
|
|
Unique Name for the group. Must begin with Required for create, modify or delete operation. |
|
Should https certificates be validated? Choices:
|
Examples
- name: create a StorageGRID group
netapp.storagegrid.na_sg_grid_group:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: present
display_name: ansiblegroup100
unique_name: group/ansiblegroup100
management_policy:
tenant_accounts: true
maintenance: true
root_access: 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 group attributes. Returned: success Sample: {“accountId”: “12345678901234567890”, “displayName”: “Example Group”, “federated”: false, “groupURN”: “urn:sgws:identity::12345678901234567890:group/examplegroup”, “id”: “00000000-0000-0000-0000-000000000000”, “policies”: {“management”: {“activateFeatures”: false, “alarmAcknowledgment”: true, “changeTenantRootPassword”: true, “gridTopologyPageConfiguration”: true, “ilm”: true, “maintenance”: true, “manageAlerts”: true, “metricsQuery”: true, “objectMetadata”: true, “otherGridConfiguration”: true, “rootAccess”: true, “storageAdmin”: true, “tenantAccounts”: true}}, “uniqueName”: “group/examplegroup”} |
Authors
NetApp Ansible Team (@joshedmonds)