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.11.1).

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.

New in netapp.storagegrid 20.6.0

Synopsis

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

Parameters

Parameter

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

regions

list / elements=string / required

List of regions

state

string

Whether the specified user should exist or not.

Choices:

  • "present" ← (default)

validate_certs

boolean

Should https certificates be validated?

Choices:

  • false

  • true ← (default)

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

resp

list / elements=string

Returns information about the configured regions.

Returned: success

Sample: ["us-east-1", "us-central-1"]

Authors

  • NetApp Ansible Team (@joshedmonds)