W3cubDocs

/Ansible

netapp.ontap.na_ontap_software_update – NetApp ONTAP Update Software

Note

This plugin is part of the netapp.ontap collection (version 21.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.

To use it in a playbook, specify: netapp.ontap.na_ontap_software_update.

New in version 2.7.0: of netapp.ontap

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
  • Python3 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.
  • To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter Choices/Defaults Comments
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
download_only
boolean
added in 20.4.0 of netapp.ontap
    Choices:
  • no
  • yes
Allows to download image without update.
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
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.
force_update
boolean
added in 20.11.0 of netapp.ontap
    Choices:
  • no
  • yes
force an update, even if package_version matches what is reported as installed.
hostname
string / required
The hostname or IP address of the ONTAP instance.
http_port
integer
Override the default port (80 or 443) with this port
https
boolean
    Choices:
  • no
  • yes
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
ignore_validation_warning
boolean
    Choices:
  • no
  • yes
Allows the update to continue if warnings are encountered during the validation phase.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
nodes
list / elements=string
List of nodes to be updated, the nodes have to be a part of a HA Pair.

aliases: node
ontapi
integer
The ontap api version to use
package_url
string / required
Specifies the package URL to download the package.
package_version
string / required
Specifies the package version to update software.
password
string
Password for the specified user.

aliases: pass
stabilize_minutes
integer
added in 20.6.0 of netapp.ontap
Number of minutes that the update should wait after a takeover or giveback is completed.
state
string
    Choices:
  • present
This module can only download and optionally install the software.
timeout
integer
Default:
1800
how long to wait for the update to complete, in seconds.
use_rest
string
Default:
"auto"
REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.
always -- will always use the REST API
never -- will always use the ZAPI
auto -- will try to use the REST Api
username
string
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
1. basic authentication, using username and password,
2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file.
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled.

aliases: user
validate_after_download
boolean
added in 21.11.0 of netapp.ontap
    Choices:
  • no
  • yes
By default validation is not run after download, as it is already done in the update step.
This option is useful when using download_only, for instance when updating a MetroCluster system.
validate_certs
boolean
    Choices:
  • no
  • yes
If set to no, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.

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.
  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

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 Returned Description
validation_reports
string
always
validation_reports_after_update as a string, for backward compatibility.

validation_reports_after_download
list / elements=string
always
List of validation reports, after downloading the software package.
Note that it is different from the validation checks reported after attempting an update.

validation_reports_after_updates
list / elements=string
always
List of validation reports, after attemting to update the software package.



Authors

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