netapp.storagegrid.na_sg_grid_account (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, Update, Delete Tenant Accounts on NetApp StorageGRID.

Usage examples

Scanned by Steampunk Spotter

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

  - 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

Scanned by Steampunk Spotter

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

  - 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

Scanned by Steampunk Spotter

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

  - 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

Inputs

    
name:
    description:
    - Name of the tenant.
    - Required for create or modify operation.
    type: str

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

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

password:
    description:
    - Root password for tenant account.
    - Requires root privilege.
    type: str

protocol:
    choices:
    - s3
    - swift
    description:
    - Object Storage protocol used by the tenancy.
    - Required for create operation.
    type: str

account_id:
    description:
    - Account Id of the tenant.
    - May be used for modify or delete operation.
    type: str

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

management:
    default: true
    description:
    - Whether the tenant can login to the StorageGRID tenant portal.
    type: bool

quota_size:
    default: 0
    description:
    - Quota to apply to the tenant specified in I(quota_size_unit).
    - If you intend to have no limits, assign C(0).
    type: int

description:
    description:
    - Additional identifying information for the tenant account.
    type: str
    version_added: 21.12.0
    version_added_collection: netapp.storagegrid

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

quota_size_unit:
    choices:
    - bytes
    - b
    - kb
    - mb
    - gb
    - tb
    - pb
    - eb
    - zb
    - yb
    default: gb
    description:
    - The unit used to interpret the size parameter.
    type: str

update_password:
    choices:
    - on_create
    - always
    default: on_create
    description:
    - Choose when to update the password.
    - When set to C(always), the password will always be updated.
    - When set to C(on_create) the password will only be set upon a new user creation.
    type: str

root_access_group:
    description:
    - Existing federated group to have initial Root Access permissions for the tenant.
    - Must begin with C(federated-group/)
    type: str
    version_added: 20.11.0
    version_added_collection: netapp.storagegrid

allow_platform_services:
    description:
    - Allows tenant to use platform services features such as CloudMirror.
    type: bool

use_own_identity_source:
    description:
    - Whether the tenant account should configure its own identity source.
    type: bool

allow_select_object_content:
    description:
    - Allows tenant to use the S3 SelectObjectContent API to filter and retrieve object
      data.
    type: bool
    version_added: 21.12.0
    version_added_collection: netapp.storagegrid

Outputs

resp:
  description: Returns information about the StorageGRID tenant account.
  returned: success
  sample:
    capabilities:
    - management
    - s3
    id: '12345678901234567890'
    name: Example Account
    policy:
      allowPlatformServices: false
      quotaObjectBytes: 100000000000
      useAccountIdentitySource: true
  type: dict