netapp.ontap.na_ontap_software_update module – NetApp ONTAP Update Software

Note

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

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

Allows to download image without update.

Choices:

  • no ← (default)

  • yes

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

force an update, even if package_version matches what is reported as installed.

Choices:

  • no ← (default)

  • yes

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

Enable and disable https.

Ignored when using REST as only https is supported.

Ignored when using SSL certificate authentication as it requires SSL.

Choices:

  • no ← (default)

  • yes

ignore_validation_warning

aliases: skip_warnings

boolean

Allows the update to continue if warnings are encountered during the validation phase.

Choices:

  • no ← (default)

  • yes

key_filepath

string

added in 20.6.0 of netapp.ontap

path to SSL client key file.

nodes

aliases: node, nodes_to_update

list / elements=string

List of nodes to be updated, the nodes have to be a part of a HA Pair.

Requires ONTAP 9.9 with REST.

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

aliases: pass

string

Password for the specified user.

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.

Requires ONTAP 9.8 with REST.

state

string

This module can only download and optionally install the software.

Choices:

  • present ← (default)

timeout

integer

how long to wait for the update to complete, in seconds.

Default: 1800

use_rest

string

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: “auto”

username

aliases: user

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.

validate_after_download

boolean

added in 21.11.0 of netapp.ontap

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.

Choices:

  • no ← (default)

  • yes

validate_certs

boolean

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.

Choices:

  • no

  • yes ← (default)

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.

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

validation_reports

string

validation_reports_after_update as a string, for backward compatibility.

Returned: always

validation_reports_after_download

list / elements=string

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

validation_reports_after_updates

list / elements=string

List of validation reports, after attemting to update the software package.

Returned: always

Authors

  • NetApp Ansible Team (@carchi8py)