netapp.storagegrid.na_sg_grid_regions module – NetApp StorageGRID manage Regions for the grid.
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_regions
.
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 Users within a NetApp StorageGRID tenant.
Parameters
Parameter |
Comments |
---|---|
The url to the StorageGRID Admin Node REST API. |
|
The authorization token for the API request |
|
List of regions |
|
Whether the specified user should exist or not. Choices:
|
|
Should https certificates be validated? Choices:
|
Notes
Note
The modules prefixed with
na_sg
are built to manage NetApp StorageGRID.
Examples
- name: update Regions
netapp.storagegrid.na_sg_grid_regions:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: present
regions: "us-east-1"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Returns information about the configured regions. Returned: success Sample: |