netapp.storagegrid.na_sg_grid_recovery_package module – Retrieve the recovery package from StorageGRID

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

New in netapp.storagegrid 21.16.0

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Create recovery package on NetApp StorageGRID.

Parameters

Parameter	Comments
api_url string / required	The url to the StorageGRID Admin Node REST API.
auth_token string / required	The authorization token for the API request
passphrase string	the password used during maintenance procedures to make changes to the grid topology.
state string	Whether the recovery package should be present or absent. Choices: `"present"` ← (default) `"absent"`
validate_certs boolean	Should https certificates be validated? Choices: `false` `true` ← (default)

Notes

Note

The modules prefixed with na_sg are built to manage NetApp StorageGRID.

Examples

- name: Create StorageGRID recovery package
  netapp.storagegrid.na_sg_grid_recovery_package:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    passphrase: "{{ storagegrid_passphrase }}"

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 recovery package. Returned: success Sample: `{"file_saved": "sgws-recovery-package-431636-rev1.zip"}`

Authors

NetApp Ansible Team (@aamirs)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/netapp/storagegrid/na_sg_grid_recovery_package_module.html