Note
This plugin is part of the netapp.ontap collection.
To install it use: ansible-galaxy collection install netapp.ontap
.
To use it in a playbook, specify: netapp.ontap.na_ontap_firmware_upgrade
.
New in version 2.9.0: of netapp.ontap
The below requirements are needed on the host that executes this module.
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. | |
clear_logs boolean |
| Clear logs on the device after update. Default value is true. Not used if force_disruptive_update is False. |
disk_fw string | disk firmware to be updated to. Not used if force_disruptive_update is False (ONTAP will automatically select the firmware) | |
fail_on_502_error boolean added in 20.6.0 of netapp.ontap |
| The firmware download may take time if the web server is slow and if there are many nodes in the cluster. ONTAP will break the ZAPI connection after 5 minutes with a 502 Bad Gateway error, even though the download is still happening. By default, this module ignores this error and assumes the download is progressing as ONTAP does not provide a way to check the status. When setting this option to true, the module will report 502 as an error. |
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. | |
firmware_type string |
| Type of firmware to be upgraded. Options include shelf, ACP, service-processor, and disk. For shelf firmware upgrade the operation is asynchronous, and therefore returns no errors that might occur during the download process. Shelf firmware upgrade is idempotent if shelf_module_fw is provided . disk firmware upgrade is idempotent if disk_fw is provided . With check mode, SP, ACP, disk, and shelf firmware upgrade is not idempotent. This operation will only update firmware on shelves/disk that do not have the latest firmware-revision. Not used if force_disruptive_update is False (ONTAP will automatically detect the firmware type) |
force_disruptive_update boolean added in 20.4.1 of netapp.ontap |
| If set to False , and URL is given, the upgrade is non disruptive. If URL is not given, no operation is performed.Do not set this to True , unless directed by NetApp Tech Support.It will force an update even if the resource is not ready for it, and can be disruptive. |
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. |
install_baseline_image boolean |
| Install the version packaged with ONTAP if this parameter is set to true. Otherwise, package must be used to specify the package to install. Not used if force_disruptive_update is False (ONTAP will automatically select the firmware) |
key_filepath string added in 20.6.0 of netapp.ontap | path to SSL client key file. | |
node string | Node on which the device is located. Not required if package_url is present and force_disruptive_update is False. If this option is not given, the firmware will be downloaded on all nodes in the cluster, and the resources will be updated in background on all nodes, except for service processor. For service processor, the upgrade will happen automatically when each node is rebooted. | |
ontapi integer | The ontap api version to use | |
package string | Name of the package file containing the firmware to be installed. Not required when -baseline is true. Not used if force_disruptive_update is False. | |
package_url string added in 20.4.1 of netapp.ontap | URL of the package file containing the firmware to be downloaded. Once the package file is downloaded to a node, the firmware update will happen automatically in background. For SP, the upgrade will happen automatically when a node is rebooted. For SP, the upgrade will happen automatically if autoupdate is enabled (which is the recommended setting). | |
password string | Password for the specified user. aliases: pass | |
reboot_sp boolean added in 20.6.1 of netapp.ontap |
| Reboot service processor before downloading package. Only available if 'firmware_type' is 'service-processor'. |
rename_package string added in 20.6.1 of netapp.ontap | Rename the package. Only available if 'firmware_type' is 'service-processor'. | |
replace_package boolean added in 20.6.1 of netapp.ontap |
| Replace the local package. Only available if 'firmware_type' is 'service-processor'. |
shelf_module_fw string | Shelf module firmware to be updated to. Not used if force_disruptive_update is False (ONTAP will automatically select the firmware) | |
state string | Default: "present" | Whether the specified ONTAP firmware should be upgraded or not. |
update_type string | Type of firmware update to be performed. Options include serial_full, serial_differential, network_full. Not used if force_disruptive_update is False (ONTAP will automatically select the firmware) | |
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_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. |
Note
- name: firmware upgrade na_ontap_firmware_upgrade: state: present package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: firmware upgrade, confirm successful download na_ontap_firmware_upgrade: state: present package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" fail_on_502_error: true - name: SP firmware upgrade na_ontap_firmware_upgrade: state: present node: vsim1 package: "{{ file name }}" package_url: "{{ web_link }}" clear_logs: True install_baseline_image: False update_type: serial_full force_disruptive_update: False firmware_type: service-processor hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: SP firmware download replace package tags: - sp_download na_ontap_firmware_upgrade: state: present node: vsim1 package_url: "{{ web_link }}" firmware_type: service-processor replace_package: true reboot_sp: true hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: true validate_certs: false - name: SP firmware download rename package tags: - sp_download na_ontap_firmware_upgrade: state: present node: vsim1 package_url: "{{ web_link }}" firmware_type: service-processor rename_package: SP_FW.zip hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: true validate_certs: false - name: ACP firmware download and upgrade na_ontap_firmware_upgrade: state: present node: vsim1 firmware_type: acp force_disruptive_update: False package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: shelf firmware upgrade na_ontap_firmware_upgrade: state: present firmware_type: shelf shelf_module_fw: 1221 force_disruptive_update: False package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: disk firmware upgrade na_ontap_firmware_upgrade: state: present firmware_type: disk disk_fw: NA02 force_disruptive_update: False package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
msg string | always | Returns additional information in case of success. |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netapp/ontap/na_ontap_firmware_upgrade_module.html