netapp.storagegrid.na_sg_org_user_s3_key module – Creates NetApp StorageGRID User S3 keys.

Note

This module is part of the netapp.storagegrid collection (version 21.11.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_s3_key.

New in version 20.6.0: of netapp.storagegrid

Synopsis

  • Create, Delete Users S3 keys on NetApp StorageGRID.

Parameters

Parameter

Comments

access_key

string

Access Key or S3 credential pair identifier.

Required for delete operation.

api_url

string / required

The url to the StorageGRID Admin Node REST API.

auth_token

string / required

The authorization token for the API request

expires

string

Date-Time string for the key to expire.

state

string

Whether the specified account should exist or not.

Choices:

  • present ← (default)

  • absent

unique_user_name

string / required

Unique user name owning the S3 Key.

validate_certs

boolean

Should https certificates be validated?

Choices:

  • no

  • yes ← (default)

Notes

Note

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

Examples

- name: create a s3 key
  netapp.storagegrid.na_sg_org_user_s3_key:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    unique_user_name: user/ansibleuser1

Return Values

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

Key

Description

resp

dictionary

Returns information about an S3 access key for the user.

Returned: always

Sample: {“accountId”: 12345678901234567000, “displayName”: “****************AB12”, “expires”: “2020-09-04T00:00:00.000Z”, “id”: “abcABC_01234-0123456789abcABCabc0123456789==”, “userURN”: “urn:sgws:identity::12345678901234567000:root”, “userUUID”: “00000000-0000-0000-0000-000000000000”}

Authors

  • NetApp Ansible Team (@joshedmonds)