netapp.storagegrid.na_sg_pge_install module – NetApp StorageGRID PGE load install.

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

New in netapp.storagegrid 21.17.0

Synopsis

  • Start loading installation for StorageGRID Pre-Grid Environment (PGE).

Parameters

Parameter

Comments

api_url

string / required

The url to the StorageGRID Node PGE REST API.

start_install

boolean / required

Trigger the storagegrid installation.

Choices:

  • false

  • true

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: Trigger installation for StorageGRID Appliance
  netapp.storagegrid.na_sg_pge_install:
    api_url: "https://<storagegrid-endpoint-url>"
    validate_certs: false
    start_install: 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 install.

Returned: success

Sample: {"complete": false, "failed": false, "okToRedirect": true, "running": true, "started": true, "status": [{"errors": [], "name": "Configure storage", "state": "complete", "steps": [{"name": "Evaluate local node storage", "progress": 100, "state": "complete"}, {"name": "Create local node storage", "progress": 100, "state": "skipped"}, {"name": "Map local node storage", "progress": 100, "state": "complete"}]}, {"errors": [], "name": "Install OS", "state": "complete", "steps": [{"name": "Obtain installer binaries", "progress": 100, "state": "complete"}, {"name": "Configure installer", "progress": 100, "state": "complete"}, {"name": "Install OS", "progress": 100, "state": "complete"}]}, {"errors": [], "name": "Install StorageGRID", "state": "complete", "steps": [{"name": "Install StorageGRID", "progress": 100, "state": "complete"}]}, {"errors": [], "name": "Finalize installation", "state": "complete", "steps": [{"name": "Prepare for bare metal", "progress": 100, "state": "complete"}, {"name": "Initiate bare metal reboot", "progress": 100, "state": "complete"}]}, {"errors": [], "name": "Load StorageGRID Installer", "state": "running", "steps": [{"endTime": "None", "message": "Do not refresh. You will be redirected when the installer is ready", "name": "Starting StorageGRID Installer", "progress": 50, "state": "running"}]}]}

Authors

  • NetApp Ansible Team (@vinaykus)