netapp.storagegrid.na_sg_pge_config module – NetApp StorageGRID node PGE configuration.

Note

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

New in netapp.storagegrid 21.17.0

Synopsis

  • update configuration for StorageGRID node Pre-Grid Environment (PGE).

Parameters

Parameter

Comments

api_url

string / required

The url to the StorageGRID Node PGE REST API.

file_path

string

Path of the StorageGRID Appliance configuration file to be uploaded.

reset_config

boolean

Reset the PGE configuration update fields to default values.

Choices:

  • false ← (default)

  • true

selected_node

string

The node on which the uploaded PGE configuration will be applied.

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: Upload and apply configuration on StorageGRID Appliance
  netapp.storagegrid.na_sg_pge_config:
    api_url: "https://<storagegrid-endpoint-url>"
    validate_certs: false
    file_path: "/path/to/configuration/file.json"
    selected_node: "node-name"

- name: Reset configuration update fields to default
  netapp.storagegrid.na_sg_pge_config:
    api_url: "https://<storagegrid-endpoint-url>"
    validate_certs: false
    reset_config: true

Return Values

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

Key

Description

resp

dictionary

Returns information about the StorageGRID PGE configuration.

Returned: success

Sample: {"jsonFileName": "config.json", "logMessages": null, "nodeNames": ["node1"], "selectedNode": null, "updateConfigStatus": "ready"}

Authors

  • NetApp Ansible Team (@vinaykus)