netapp.storagegrid.na_sg_grid_group (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 Administration Groups within NetApp StorageGRID.

Usage examples

Scanned by Steampunk Spotter

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

  - name: create a StorageGRID group
    netapp.storagegrid.na_sg_grid_group:
      api_url: "https://<storagegrid-endpoint-url>"
      auth_token: "storagegrid-auth-token"
      validate_certs: false
      state: present
      display_name: ansiblegroup100
      unique_name: group/ansiblegroup100
      management_policy:
        tenant_accounts: true
        maintenance: true
        root_access: false

Inputs

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

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

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

unique_name:
    description:
    - Unique Name for the group. Must begin with C(group/) or C(federated-group/)
    - Required for create, modify or delete operation.
    required: true
    type: str

display_name:
    description:
    - Name of the group.
    - Required for create operation
    type: str

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

management_policy:
    description:
    - Management access controls granted to the group within the tenancy.
    suboptions:
      activate_features:
        description:
        - Users in this group will have permissions to reactivate features.
        required: false
        type: bool
      alarm_acknowledgement:
        description:
        - Group members can have permission to acknowledge alarms.
        required: false
        type: bool
      change_tenant_root_password:
        description:
        - Users in this group will have permissions to change tenant password.
        required: false
        type: bool
      grid_topology_page_configuration:
        description:
        - Users in this group will have permissions to change grid topology.
        required: false
        type: bool
      ilm:
        description:
        - Users in this group will have permissions to manage ILM rules on StorageGRID.
        required: false
        type: bool
      maintenance:
        description:
        - Users in this group will have permissions to run maintenance tasks on StorageGRID.
        required: false
        type: bool
      metrics_query:
        description:
        - Users in this group will have permissions to query metrics on StorageGRID.
        required: false
        type: bool
      object_metadata:
        description:
        - Users in this group will have permissions to manage object metadata.
        required: false
        type: bool
      other_grid_configuration:
        description:
        - Need to investigate.
        required: false
        type: bool
      root_access:
        description:
        - Users in this group will have root access.
        required: false
        type: bool
      tenant_accounts:
        description:
        - Users in this group will have permissions to manage tenant accounts.
        required: false
        type: bool
    type: dict

Outputs

resp:
  description: Returns information about the StorageGRID group attributes.
  returned: success
  sample:
    accountId: '12345678901234567890'
    displayName: Example Group
    federated: false
    groupURN: urn:sgws:identity::12345678901234567890:group/examplegroup
    id: 00000000-0000-0000-0000-000000000000
    policies:
      management:
        activateFeatures: false
        alarmAcknowledgment: true
        changeTenantRootPassword: true
        gridTopologyPageConfiguration: true
        ilm: true
        maintenance: true
        manageAlerts: true
        metricsQuery: true
        objectMetadata: true
        otherGridConfiguration: true
        rootAccess: true
        storageAdmin: true
        tenantAccounts: true
    uniqueName: group/examplegroup
  type: dict