netapp.storagegrid.na_sg_org_user_s3_key (21.12.0) — module

Install collection

Install with ansible-galaxy collection install netapp.storagegrid:==21.12.0

Add to requirements.yml

  collections:
    - name: netapp.storagegrid
      version: 21.12.0

Description

Create, Delete Users S3 keys on NetApp StorageGRID.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - 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

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified account should exist or not.
    type: str

api_url:
    description:
    - The url to the StorageGRID Admin Node REST API.
    required: true
    type: str

expires:
    description:
    - Date-Time string for the key to expire.
    type: str

access_key:
    description:
    - Access Key or S3 credential pair identifier.
    - Required for delete operation.
    type: str

auth_token:
    description:
    - The authorization token for the API request
    required: true
    type: str

validate_certs:
    default: true
    description:
    - Should https certificates be validated?
    required: false
    type: bool

unique_user_name:
    description:
    - Unique user name owning the S3 Key.
    required: true
    type: str

Outputs

resp:
  description: 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
  type: dict