netapp.storagegrid.na_sg_pge_setup module – NetApp StorageGRID PGE initial system setup.

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

New in netapp.storagegrid 21.17.0

Synopsis

  • Perform initial system setup for StorageGRID Pre-Grid Environment (PGE).

Parameters

Parameter

Comments

admin_target_ip

string

The IP of the primary Admin Node.

api_url

string / required

The url to the StorageGRID Node PGE REST API.

discovery

boolean

Whether or not to use primary Admin Node discovery. If this is set to true, the ip parameter will be ignored.

Choices:

  • false

  • true ← (default)

node_name

string

Name of the node to be setup.

node_type

string

The node type that will be used. Some appliance models do not support all node types.

Choices:

  • "primary_admin"

  • "non_primary_admin"

  • "gateway"

  • "storage"

  • "data"

  • "metadata"

raid_mode

string

The RAID mode that will be used. Some appliance models do not support all modes.

Choices:

  • "ddp"

  • "ddp16"

  • "raid1"

  • "raid6"

  • "raid5"

  • "mraida"

  • "mraidb"

  • "mraidc"

  • "mraidd"

  • "mraide"

  • "mraidf"

  • "mraidg"

  • "mraidh"

  • "mraidi"

  • "mraidj"

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: Setup StorageGRID PGE configuration
  netapp.storagegrid.na_sg_pge_setup:
    node_name: "sg100-tme-01"
    node_type: "non_primary_admin"
    raid_mode: "raid1"

- name: Setup StorageGRID PGE primary admin node IP
  netapp.storagegrid.na_sg_pge_setup:
    admin_target_ip: "10.0.0.1"
    discovery: false

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 system setup.

Returned: success

Sample: {"compatibilityErrors": [], "connectionState": "ready", "detailMessage": "Connection validated at 2026-03-24T11:06:14.446304", "discoveredAddresses": ["10.0.0.1", "10.0.0.5", "10.0.0.7", "10.0.0.9", "10.0.0.11"], "ip": "10.0.0.1", "storagegridRelease": "12.0.0-20250821.2204.150f19d", "storagegridVersion": "12.0.0", "useDiscovery": true}

Authors

  • NetApp Ansible Team (@vinaykus)