netapp.storagegrid.na_sg_grid_account module – NetApp StorageGRID manage accounts.
Note
This module is part of the netapp.storagegrid collection (version 21.12.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_account
.
New in netapp.storagegrid 20.6.0
Synopsis
Create, Update, Delete Tenant Accounts on NetApp StorageGRID.
Parameters
Parameter |
Comments |
---|---|
Account Id of the tenant. May be used for modify or delete operation. |
|
Allows tenant to use platform services features such as CloudMirror. Choices:
|
|
Allows tenant to use the S3 SelectObjectContent API to filter and retrieve object data. Choices:
|
|
The url to the StorageGRID Admin Node REST API. |
|
The authorization token for the API request |
|
Additional identifying information for the tenant account. |
|
Whether the tenant can login to the StorageGRID tenant portal. Choices:
|
|
Name of the tenant. Required for create or modify operation. |
|
Root password for tenant account. Requires root privilege. |
|
Object Storage protocol used by the tenancy. Required for create operation. Choices:
|
|
Quota to apply to the tenant specified in quota_size_unit. If you intend to have no limits, assign Default: |
|
The unit used to interpret the size parameter. Choices:
|
|
Existing federated group to have initial Root Access permissions for the tenant. Must begin with |
|
Whether the specified account should exist or not. Required for all operations. Choices:
|
|
Choose when to update the password. When set to When set to Choices:
|
|
Whether the tenant account should configure its own identity source. 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 tenant account
netapp.storagegrid.na_sg_grid_account:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: present
name: storagegrid-tenant-1
protocol: s3
management: true
use_own_identity_source: false
allow_platform_services: false
password: "tenant-password"
quota_size: 0
- name: update a tenant account
netapp.storagegrid.na_sg_grid_account:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: present
name: storagegrid-tenant-1
protocol: s3
management: true
use_own_identity_source: false
allow_platform_services: true
password: "tenant-password"
quota_size: 10240
- name: delete a tenant account
netapp.storagegrid.na_sg_grid_account:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: absent
name: storagegrid-tenant-1
protocol: s3
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Returns information about the StorageGRID tenant account. Returned: success Sample: |