netapp.storagegrid.na_sg_grid_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 Grid configuration.

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather StorageGRID Grid info
  netapp.storagegrid.na_sg_grid_info:
    api_url: "https://1.2.3.4/"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
  register: sg_grid_info

Scanned by Steampunk Spotter

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

- name: Gather StorageGRID Grid info for grid/accounts and grid/config subsets
  netapp.storagegrid.na_sg_grid_info:
    api_url: "https://1.2.3.4/"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    gather_subset:
      - grid_accounts_info
      - grid/config
  register: sg_grid_info

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

- name: Gather StorageGRID Grid info for grid/accounts and grid/users subsets, limit to 5 results for each subset
  netapp.storagegrid.na_sg_grid_info:
    api_url: "https://1.2.3.4/"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    gather_subset:
      - grid/accounts
      - grid/users
    parameters:
      limit: 5
  register: sg_grid_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(grid_accounts_info) or C(grid/accounts)
    - C(grid_alarms_info) or C(grid/alarms)
    - C(grid_audit_info) or C(grid/audit)
    - C(grid_compliance_global_info) or C(grid/compliance-global)
    - C(grid_config_info) or C(grid/config)
    - C(grid_config_management_info) or C(grid/config/management)
    - C(grid_config_product_version_info) or C(grid/config/product-version)
    - C(grid_deactivated_features_info) or C(grid/deactivated-features)
    - C(grid_dns_servers_info) or C(grid/dns-servers)
    - C(grid_domain_names_info) or C(grid/domain-names)
    - C(grid_ec_profiles_info) or C(grid/ec-profiles)
    - C(grid_expansion_info) or C(grid/expansion)
    - C(grid_expansion_nodes_info) or C(grid/expansion/nodes)
    - C(grid_expansion_sites_info) or C(grid/expansion/sites)
    - C(grid_grid_networks_info) or C(grid/grid-networks)
    - C(grid_groups_info) or C(grid/groups)
    - C(grid_health_info) or C(grid/health)
    - C(grid_health_topology_info) or C(grid/health/topology)
    - C(grid_identity_source_info) or C(grid/identity-source)
    - C(grid_ilm_criteria_info) or C(grid/ilm-criteria)
    - C(grid_ilm_policies_info) or C(grid/ilm-policies)
    - C(grid_ilm_rules_info) or C(grid/ilm-rules)
    - C(grid_license_info) or C(grid/license)
    - C(grid_management_certificate_info) or C(grid/management-certificate)
    - C(grid_ntp_servers_info) or C(grid/ntp-servers)
    - C(grid_recovery_available_nodes_info) or C(grid/recovery/available-nodes)
    - C(grid_recovery_info) or C(grid/recovery)
    - C(grid_regions_info) or C(grid/regions)
    - C(grid_schemes_info) or C(grid/schemes)
    - C(grid_snmp_info) or C(grid/snmp)
    - C(grid_storage_api_certificate_info) or C(grid/storage-api-certificate)
    - C(grid_untrusted_client_network_info) or C(grid/untrusted-client-network)
    - C(grid_users_info) or C(grid/users)
    - C(grid_users_root_info) or C(grid/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:
    grid/accounts:
      '...': null
    grid/alarms:
      '...': null
    grid/audit:
      '...': null
    grid/compliance-global:
      '...': null
    grid/config:
      '...': null
    grid/config/management:
      '...': null
    grid/config/product-version:
      '...': null
    grid/deactivated-features:
      '...': null
    grid/dns-servers:
      '...': null
    grid/domain-names:
      '...': null
    grid/ec-profiles:
      '...': null
    grid/expansion:
      '...': null
    grid/expansion/nodes:
      '...': null
    grid/expansion/sites:
      '...': null
    grid/groups:
      '...': null
    grid/health:
      '...': null
    grid/health/topology:
      '...': null
    grid/identity-source:
      '...': null
    grid/ilm-criteria:
      '...': null
    grid/ilm-policies:
      '...': null
    grid/ilm-rules:
      '...': null
    grid/license:
      '...': null
    grid/management-certificate:
      '...': null
    grid/networks:
      '...': null
    grid/ntp-servers:
      '...': null
    grid/recovery:
      '...': null
    grid/recovery/available-nodes:
      '...': null
    grid/regions:
      '...': null
    grid/schemes:
      '...': null
    grid/snmp:
      '...': null
    grid/storage-api-certificate:
      '...': null
    grid/untrusted-client-network:
      '...': null
    grid/users:
      '...': null
    grid/users/root:
      '...': null
    grid/versions:
      '...': null
  type: dict