netapp.storagegrid.na_sg_pge_info module – NetApp StorageGRID node PGE information gatherer.

Note

This module is part of the netapp.storagegrid collection (version 21.16.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_pge_info.

New in netapp.storagegrid 21.16.0

Synopsis

  • Gather various information about StorageGRID node Pre-Grid Environment (PGE) configuration.

Parameters

Parameter

Comments

api_url

string / required

The url to the StorageGRID Node PGE REST API.

gather_subset

list / elements=string

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

pge_storage_configuration_networking or pge/storage-configuration/networking

pge_bmc_config or pge/bmc-config

pge_install_status or pge/install-status

pge_networks or pge/networks

pge_link_config or pge/link-config

pge_dns or pge/dns

pge_system_info or pge/system-info

pge_system_config or pge/system-config

pge_admin_connection or pge/admin-connection

pge_ipmi_sensors or pge/ipmi-sensors

pge_upgrade_status or pge/upgrade/status

pge_debug_dump_addr_show or pge/debug/dump-addr-show

pge_debug_dump_routes or pge/debug/dump-routes

pge_debug_dump_bonding or pge/debug/dump-bonding

pge_debug_dump_netlink or pge/debug/dump-netlink

pge_debug_dump_bonding_raw or pge/debug/dump-bonding-raw

pge_debug_dump_lldp_attributes or pge/debug/dump-lldp-attributes

Can specify a list of values to include a larger subset.

Default: ["all"]

parameters

dictionary

Allows for any rest option to be passed in.

validate_certs

boolean

Should https certificates be validated?

Choices:

  • false

  • true ← (default)

Notes

Note

  • The modules prefixed with na_sg_pge are built to manage NetApp StorageGRID node Pre-Grid Environment (PGE) configuration.

Examples

- name: Gather StorageGRID node PGE info
  netapp.storagegrid.na_sg_pge_info:
    api_url: "https://1.2.3.4/"
    validate_certs: false
  register: sg_pge_info

- name: Gather StorageGRID PGE info for pge/bmc-config and pge_dns subsets
  netapp.storagegrid.na_sg_pge_info:
    api_url: "https://1.2.3.4/"
    validate_certs: false
    gather_subset:
      - pge/bmc-config
      - pge_dns
  register: sg_pge_info

- name: Gather StorageGRID PGE info for all subsets
  netapp.storagegrid.na_sg_pge_info:
    api_url: "https://1.2.3.4/"
    validate_certs: false
    gather_subset:
      - all
  register: sg_pge_info

- name: Gather StorageGRID PGE info for pge/system-config and pge/system-info subsets, limit to 5 results for each subset
  netapp.storagegrid.na_sg_pge_info:
    api_url: "https://1.2.3.4/"
    validate_certs: false
    gather_subset:
      - pge/system-config
      - pge/system-info
    parameters:
      limit: 5
  register: sg_pge_info

Return Values

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

Key

Description

sg_pge_info

dictionary

Returns various information about the StorageGRID node PGE configuration.

Returned: always

Sample: {"pge/admin-connection": {"...": null}, "pge/bmc-config": {"...": null}, "pge/debug/dump-addr-show": {"...": null}, "pge/debug/dump-bonding": {"...": null}, "pge/debug/dump-bonding-raw": {"...": null}, "pge/debug/dump-lldp-attributes": {"...": null}, "pge/debug/dump-netlink": {"...": null}, "pge/debug/dump-routes": {"...": null}, "pge/dns": {"...": null}, "pge/install-status": {"...": null}, "pge/ipmi-sensors": {"...": null}, "pge/link-config": {"...": null}, "pge/networks": {"...": null}, "pge/storage-configuration/networking": {"...": null}, "pge/system-config": {"...": null}, "pge/system-info": {"...": null}, "pge/upgrade/status": {"...": null}}

Authors

  • NetApp Ansible Team (@vinaykus)