netapp.storagegrid.na_sg_org_info – NetApp StorageGRID Org information gatherer.

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_org_info.

New in version 20.11.0: of netapp.storagegrid

Synopsis

  • This module allows you to gather various information about StorageGRID Org configuration.

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
gather_subset
list / elements=string
Default:
"all"
When supplied, this argument will restrict the information collected to a given subset.
Either the info name or the Rest API can be given.
Possible values for this argument include
org_compliance_global_info or org/compliance-global
org_config_info or org/config
org_config_product_version_info or org/config/product-version
org_containers_info or org/containers
org_deactivated_features_info or org/deactivated-features
org_endpoints_info or org/endpoints
org_groups_info or org/groups
org_identity_source_info or org/identity-source
org_regions_info or org/regions
org_users_current_user_s3_access_keys_info or org/users/current-user/s3-access-keys
org_usage_info or org/usage
org_users_info or org/users
org_users_root_info or org/users/root
versions_info or versions
Can specify a list of values to include a larger subset.
parameters
dictionary
Allows for any rest option to be passed in.
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: Gather StorageGRID Org info
  netapp.storagegrid.na_sg_org_info:
    api_url: "https://1.2.3.4/"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
  register: sg_org_info

- name: Gather StorageGRID Org info for org/containers and org/config subsets
  netapp.storagegrid.na_sg_org_info:
    api_url: "https://1.2.3.4/"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    gather_subset:
      - org_containers_info
      - org/config
  register: sg_org_info

- name: Gather StorageGRID Org info for all subsets
  netapp.storagegrid.na_sg_org_info:
    api_url: "https://1.2.3.4/"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    gather_subset:
      - all
  register: sg_org_info

- name: Gather StorageGRID Org info for org/containers and org/users subsets, limit to 5 results for each subset
  netapp.storagegrid.na_sg_org_info:
    api_url: "https://1.2.3.4/"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    gather_subset:
      - org/containers
      - org/users
    parameters:
      limit: 5
  register: sg_org_info

Return Values

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

Key Returned Description
sg_info
dictionary
always
Returns various information about the StorageGRID Grid configuration.

Sample:
{'org/compliance-global': {'...': None}, 'org/config': {'...': None}, 'org/config/product-version': {'...': None}, 'org/containers': {'...': None}, 'org/deactivated-features': {'...': None}, 'org/endpoints': {'...': None}, 'org/groups': {'...': None}, 'org/identity-source': {'...': None}, 'org/regions': {'...': None}, 'org/usage': {'...': None}, 'org/users': {'...': None}, 'org/users/current-user/s3-access-keys': {'...': None}, 'org/users/root': {'...': None}, 'org/versions': {'...': None}}


Authors