netapp.storagegrid.na_sg_grid_hotfix module – Apply hotfixes on 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_hotfix.

New in netapp.storagegrid 21.15.0

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Apply hotfix 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
file_path string	The path to the software update file.
passphrase string	The provisioning passphrase.
state string	The hotfix will start applying if present. If absent, it remove all nodes from the hotfix queue. Choices: `"present"` ← (default) `"absent"`
timeout integer	The time in seconds to wait for the software update to complete. Default: `20`
type string	the type of software update to deploy. Choices: `"hotfix"`
validate_certs boolean	Should https certificates be validated? Choices: `false` `true` ← (default)

Notes

Note

It is recommend to apply the latest hotfix before and after each software upgrade.
Before starting the hotfix process, confirm that there are no active alerts and that all grid nodes are online and available.
When the primary Admin Node is updated, services are stopped and restarted. Connectivity might be interrupted until the services are back online.
The modules prefixed with na_sg are built to manage NetApp StorageGRID.

Examples

- name: Apply hotfix on StorageGRID
  na_sg_grid_hotfix:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    state: "present"
    validate_certs: false
    passphrase: "{{ storagegrid_passphrase }}"
    type: "hotfix"
    file_path: "/path/to/hotfix_file"

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 software update. Returned: success Sample: `{"endTime": "2025-03-28T06:33:58.576Z", "error": "Failed to apply software update to DC1-S1", "fileName": "StorageGRID-Software-Update", "filePath": "/tmp/StorageGRID-Software-Update", "id": "software-update", "inProgress": true, "percent": 75, "restart": true, "stage": "applying", "startTime": "2025-03-28T06:33:58.576Z", "type": "hotfix", "uploadType": "hotfix", "validationError": "Failed to validate installer file: File is empty", "version": "11.4.0.1"}`

Key

Description

resp

dictionary

Returns information about the StorageGRID software update.

Returned: success

Sample: {"endTime": "2025-03-28T06:33:58.576Z", "error": "Failed to apply software update to DC1-S1", "fileName": "StorageGRID-Software-Update", "filePath": "/tmp/StorageGRID-Software-Update", "id": "software-update", "inProgress": true, "percent": 75, "restart": true, "stage": "applying", "startTime": "2025-03-28T06:33:58.576Z", "type": "hotfix", "uploadType": "hotfix", "validationError": "Failed to validate installer file: File is empty", "version": "11.4.0.1"}

Authors

NetApp Ansible Team (@vinaykus)

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_hotfix_module.html