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。您需要其他要求才能使用此模块,请参阅 需求 以了解详情。

要在剧本中使用它,请指定: 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。

当 state 为 present 时必需,除非包已存在于磁盘上。

package_version

字符串 / 必需

指定要将 ONTAP 软件更新到的包版本,或要删除的包版本。

password

别名:pass

字符串

指定用户的密码。

stabilize_minutes

整数

netapp.ontap 20.6.0 中新增

更新在接管或返还完成后应等待的分钟数。

需要使用 REST 的 ONTAP 9.8。

state

字符串

此模块下载并可选地安装集群上的 ONTAP 软件。

软件包在成功安装后将被删除。

如果软件包已存在,则不会下载也不会替换。

当 state 为 absent 时,包将从磁盘删除。

选项

  • "present" ← (默认)

  • "absent"

timeout

整数

等待更新完成的时间(秒)。

默认: 1800

use_rest

字符串

是否使用 REST 或 ZAPI。

always – 如果模块支持 REST,则始终使用 REST API。如果模块不支持 REST,则会发出警告。如果模块选项在 REST 中不受支持,则会发出错误。

never – 如果模块支持 ZAPI,则始终使用 ZAPI。如果 REST 选项在 ZAPI 中不受支持,则可能会发出错误。

auto – 如果模块支持 REST 且支持模块选项,则尝试使用 REST API。否则恢复为 ZAPI。

默认: "auto"

username

别名:user

字符串

这可以是集群范围或 SVM 范围的帐户,具体取决于是否需要集群级或 SVM 级 API。

更多信息,请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/

支持两种身份验证方法

  1. 基本身份验证,使用用户名和密码;

  2. SSL证书身份验证,使用SSL客户端证书文件,以及可选的私钥文件。

要使用证书,必须已在ONTAP集群中安装证书,并且必须已启用证书身份验证。

validate_after_download

布尔值

新增于netapp.ontap 21.11.0

默认情况下,下载后不会运行验证,因为此操作已在更新步骤中完成。

当使用download_only时,此选项很有用,例如更新MetroCluster系统时。

选项

  • false ← (默认)

  • true

validate_certs

布尔值

如果设置为no,则不会验证SSL证书。

只有在使用自签名证书的个人控制站点上才应将其设置为False

选项

  • false

  • true ← (默认)

备注

注意

  • ONTAP期望节点成对处于高可用性状态以执行非中断更新。

  • 在单节点设置中,将更新节点并重新启动。

  • 支持ZAPI和REST。

  • 支持check_mode。

  • 以na_ontap为前缀的模块构建用于支持ONTAP存储平台。

  • 默认情况下启用https,并建议使用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)