netapp.storagegrid.na_sg_org_info (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

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

Usage examples

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

Scanned by Steampunk Spotter

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

- 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

Inputs

    
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

parameters:
    description:
    - Allows for any rest option to be passed in.
    type: dict

gather_subset:
    default: all
    description:
    - 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
    - C(org_compliance_global_info) or C(org/compliance-global)
    - C(org_config_info) or C(org/config)
    - C(org_config_product_version_info) or C(org/config/product-version)
    - C(org_containers_info) or C(org/containers)
    - C(org_deactivated_features_info) or C(org/deactivated-features)
    - C(org_endpoints_info) or C(org/endpoints)
    - C(org_groups_info) or C(org/groups)
    - C(org_identity_source_info) or C(org/identity-source)
    - C(org_regions_info) or C(org/regions)
    - C(org_users_current_user_s3_access_keys_info) or C(org/users/current-user/s3-access-keys)
    - C(org_usage_info) or C(org/usage)
    - C(org_users_info) or C(org/users)
    - C(org_users_root_info) or C(org/users/root)
    - C(versions_info) or C(versions)
    - Can specify a list of values to include a larger subset.
    elements: str
    type: list

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

Outputs

sg_info:
  description: Returns various information about the StorageGRID Grid configuration.
  returned: always
  sample:
    org/compliance-global:
      '...': null
    org/config:
      '...': null
    org/config/product-version:
      '...': null
    org/containers:
      '...': null
    org/deactivated-features:
      '...': null
    org/endpoints:
      '...': null
    org/groups:
      '...': null
    org/identity-source:
      '...': null
    org/regions:
      '...': null
    org/usage:
      '...': null
    org/users:
      '...': null
    org/users/current-user/s3-access-keys:
      '...': null
    org/users/root:
      '...': null
    org/versions:
      '...': null
  type: dict