netapp.ontap.na_ontap_software_update module – NetApp ONTAP Update Software
Note
This module is part of the netapp.ontap collection (version 22.12.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.ontap.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_software_update.
New in netapp.ontap 2.7.0
Synopsis
Update ONTAP software
Requires an https connection and is not supported over http
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9 or later - 2.12 or later is recommended.
Python3 - 3.9 or later is recommended.
When using ZAPI, netapp-lib 2018.11.13 or later (install using ‘pip install netapp-lib’), netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues
a physical or virtual clustered Data ONTAP system, the modules support Data ONTAP 9.1 and onward, REST support requires ONTAP 9.6 or later
Parameters
Parameter |
Comments |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Allows to download image without update. Choices:
|
|
Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. When Ignored with ZAPI. |
|
force an update, even if package_version matches what is reported as installed. Choices:
|
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
Allows the update to continue if warnings are encountered during the validation phase. Choices:
|
|
path to SSL client key file. |
|
List of nodes to be updated, the nodes have to be a part of a HA Pair. Requires ONTAP 9.9 with REST. |
|
The ontap api version to use |
|
Specifies the package URL to download the package. Required when state is present unless the package is already present on disk. |
|
Specifies the package version to update ONTAP software to, or to be deleted. |
|
Password for the specified user. |
|
Number of minutes that the update should wait after a takeover or giveback is completed. Requires ONTAP 9.8 with REST. |
|
This module downloads and optionally installs ONTAP software on a cluster. The software package is deleted after a successful installation. If the software package is already present, it is not downloaded and not replaced. When state is absent, the package is deleted from disk. Choices:
|
|
how long to wait for the update to complete, in seconds. Default: |
|
Whether to use REST or ZAPI. always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST. never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI. auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise. Default: |
|
This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Two authentication methods are supported
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
By default validation is not run after download, as it is already done in the update step. This option is useful when using Choices:
|
|
If set to This should only set to Choices:
|
Notes
Note
ONTAP expects the nodes to be in HA pairs to perform non disruptive updates.
In a single node setup, the node is updated, and rebooted.
Supports ZAPI and REST.
Support check_mode.
The modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Examples
- name: ONTAP software update
netapp.ontap.na_ontap_software_update:
state: present
nodes: vsim1
package_url: "{{ url }}"
package_version: "{{ version_name }}"
ignore_validation_warning: True
download_only: True
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Returned: always |
|
List of validation reports, after downloading the software package. Note that it is different from the validation checks reported after attempting an update. Returned: always |
|
List of validation reports, after attemting to update the software package. Returned: always |