netapp.storagegrid.na_sg_grid_group – NetApp StorageGRID manage groups.

Note

This plugin is part of the netapp.storagegrid collection (version 21.9.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_grid_group.

New in version 20.6.0: of netapp.storagegrid

Synopsis

  • Create, Update, Delete Administration Groups within NetApp StorageGRID.

Parameters

Parameter Choices/Defaults 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
display_name
string
Name of the group.
Required for create operation
management_policy
dictionary
Management access controls granted to the group within the tenancy.
activate_features
boolean
    Choices:
  • no
  • yes
Users in this group will have permissions to reactivate features.
alarm_acknowledgement
boolean
    Choices:
  • no
  • yes
Group members can have permission to acknowledge alarms.
change_tenant_root_password
boolean
    Choices:
  • no
  • yes
Users in this group will have permissions to change tenant password.
grid_topology_page_configuration
boolean
    Choices:
  • no
  • yes
Users in this group will have permissions to change grid topology.
ilm
boolean
    Choices:
  • no
  • yes
Users in this group will have permissions to manage ILM rules on StorageGRID.
maintenance
boolean
    Choices:
  • no
  • yes
Users in this group will have permissions to run maintenance tasks on StorageGRID.
metrics_query
boolean
    Choices:
  • no
  • yes
Users in this group will have permissions to query metrics on StorageGRID.
object_metadata
boolean
    Choices:
  • no
  • yes
Users in this group will have permissions to manage object metadata.
other_grid_configuration
boolean
    Choices:
  • no
  • yes
Need to investigate.
root_access
boolean
    Choices:
  • no
  • yes
Users in this group will have root access.
tenant_accounts
boolean
    Choices:
  • no
  • yes
Users in this group will have permissions to manage tenant accounts.
state
string
    Choices:
  • present ←
  • absent
Whether the specified group should exist or not.
unique_name
string / required
Unique Name for the group. Must begin with group/ or federated-group/
Required for create, modify or delete operation.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Should https certificates be validated?

Notes

Note

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

Examples

- 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

Return Values

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

Key Returned Description
resp
dictionary
success
Returns information about the StorageGRID group attributes.

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'}


Authors