netapp.ontap.na_ontap_software_update 模块 – NetApp ONTAP 软件更新

注意

此模块是 netapp.ontap 集合（版本 22.13.0）的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install netapp.ontap。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：netapp.ontap.na_ontap_software_update。

netapp.ontap 2.7.0 中的新功能

概要 

更新 ONTAP 软件
需要 https 连接，不支持通过 http 连接

要求 

以下要求需要在执行此模块的主机上满足。

Ansible 2.9 或更高版本 - 推荐 2.12 或更高版本。
Python3 - 推荐 3.9 或更高版本。
使用 ZAPI 时，建议使用 netapp-lib 2018.11.13 或更高版本（使用“pip install netapp-lib”安装），强烈建议使用 netapp-lib 2020.3.12，因为它为连接问题提供了更好的错误报告。
物理或虚拟集群 Data ONTAP 系统，该模块支持 Data ONTAP 9.1 及更高版本，REST 支持需要 ONTAP 9.6 或更高版本。

参数 

参数	注释
cert_filepath 字符串在 netapp.ontap 20.6.0 中添加	SSL 客户端证书文件 (.pem) 的路径。不支持 python 2.6。
download_only 布尔值在 netapp.ontap 20.4.0 中添加	允许下载映像而不更新。选择 `false` ←（默认） `true`
feature_flags 字典在 netapp.ontap 20.5.0 中添加	启用或禁用新功能。这可用于启用实验性功能或禁用破坏向后兼容性的新功能。支持的键和值如有更改，恕不另行通知。未知键将被忽略。
force_ontap_version 字符串在 netapp.ontap 21.23.0 中添加	使用 REST 时覆盖集群 ONTAP 版本。如果版本与目标集群不匹配，则行为未定义。当由于权限问题无法读取集群版本时，这可以作为一种解决方法。请参阅 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues。这应该采用 9.10 或 9.10.1 的形式，其中每个元素都是一个整数。当 `use_rest` 设置为 auto 时，这可能会根据版本和平台功能强制切换到基于 ZAPI 的版本。使用 ZAPI 时忽略。
force_update 布尔值在 netapp.ontap 20.11.0 中添加	强制更新，即使 package_version 与报告的已安装版本匹配。选择 `false` ←（默认） `true`
hostname 字符串 / 必需	ONTAP 实例的主机名或 IP 地址。
http_port 整数	使用此端口覆盖默认端口（80 或 443）
https 布尔值	启用和禁用 https。使用 REST 时忽略，因为仅支持 https。使用 SSL 证书身份验证时忽略，因为它需要 SSL。选择 `false` ←（默认） `true`
ignore_validation_warning 别名：skip_warnings 布尔值	允许在验证阶段遇到警告时继续更新。选择 `false` ←（默认） `true`
key_filepath 字符串在 netapp.ontap 20.6.0 中添加	SSL 客户端密钥文件的路径。
nodes 别名：node，nodes_to_update 列表 / 元素=字符串	要更新的节点列表，这些节点必须是 HA 对的一部分。需要带有 REST 的 ONTAP 9.9。
ontapi 整数	要使用的 ontap api 版本
package_url 字符串	指定下载软件包的软件包 URL。当状态存在时，除非软件包已存在于磁盘上，否则是必需的。
package_version 字符串 / 必需	指定要将 ONTAP 软件更新到的软件包版本，或要删除的软件包版本。
password 别名：pass 字符串	指定用户的密码。
stabilize_minutes 整数在 netapp.ontap 20.6.0 中添加	接管或交还完成后，更新应等待的分钟数。需要带有 REST 的 ONTAP 9.8。
state 字符串	此模块下载并选择性地在集群上安装 ONTAP 软件。成功安装后，将删除该软件包。如果软件包已存在，则不会下载或替换该软件包。当状态为 absent 时，软件包将从磁盘中删除。选择 `"present"` ←（默认） `"absent"`
timeout 整数	等待更新完成的时间（以秒为单位）。默认值： `1800`
use_rest 字符串	是否使用 REST 或 ZAPI。 always – 如果模块支持 REST，将始终使用 REST API。如果模块不支持 REST，则会发出警告。如果 REST 不支持模块选项，则会发出错误。 never – 如果模块支持 ZAPI，将始终使用 ZAPI。如果 ZAPI 不支持 REST 选项，则可能会发出错误。 auto – 如果模块支持 REST 并且模块选项受支持，将尝试使用 REST API。否则将恢复为 ZAPI。默认值： `"auto"`
用户名别名: user 字符串	这可以是集群范围或SVM范围的帐户，具体取决于是否需要集群级别或SVM级别的API。有关更多信息，请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。支持两种身份验证方法基本身份验证，使用用户名和密码， SSL证书身份验证，使用SSL客户端证书文件，以及可选的私钥文件。要使用证书，必须在ONTAP集群中安装证书，并且必须启用证书身份验证。
validate_after_download 布尔值在netapp.ontap 21.11.0中添加	默认情况下，下载后不会运行验证，因为它已经在更新步骤中完成。此选项在使用 `download_only` 时非常有用，例如在更新MetroCluster系统时。选择 `false` ←（默认） `true`
validate_certs 布尔值	如果设置为 `no`，则不会验证SSL证书。这只应在个人控制的使用自签名证书的站点上设置为 `False`。选择 `false` `true` ← (默认)

注意 

注意

ONTAP期望节点成对配置HA，以执行非中断更新。
在单节点设置中，节点将被更新并重新启动。
支持ZAPI和REST。
支持check_mode。
以na_ontap为前缀的模块旨在支持ONTAP存储平台。
默认启用并推荐使用https。要在集群上启用http，您必须运行以下命令‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

示例 

- 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 }}"

返回值 

常见返回值记录在此处，以下是此模块独有的字段

键	描述
validation_reports 字符串	`validation_reports_after_update` 作为字符串，用于向后兼容。返回: 总是
validation_reports_after_download 列表 / 元素=字符串	下载软件包后，验证报告的列表。请注意，它与尝试更新后报告的验证检查不同。返回: 总是
validation_reports_after_updates 列表 / 元素=字符串	尝试更新软件包后，验证报告的列表。返回: 总是

作者

NetApp Ansible团队 (@carchi8py)