netapp.ontap.na_ontap_cli_timeout 模块 – 用于设置 CLI 不活动超时值的 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_cli_timeout。

netapp.ontap 22.9.0 中的新功能

概要 

修改 CLI 会话的超时值。

要求 

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

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。
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 的形式，每个元素都是一个整数。
hostname 字符串 / 必填	ONTAP 实例的主机名或 IP 地址。
http_port 整数	使用此端口覆盖默认端口（80 或 443）
https 布尔值	启用和禁用 https。当使用 REST 时，由于仅支持 https，因此会被忽略。当使用 SSL 证书身份验证时，由于它需要 SSL，因此会被忽略。选择 `false` ← (默认) `true`
key_filepath 字符串在 netapp.ontap 20.6.0 中添加	SSL 客户端密钥文件的路径。
password 别名：pass 字符串	指定用户的密码。
state 字符串	修改超时值，仅支持 present。选择 `"present"` ← (默认)
timeout 整数 / 必填	指定超时值，以分钟为单位。要防止 CLI 会话超时，请指定值 0（零）。
use_rest 字符串	此模块仅支持 REST。 always – 将始终使用 REST API。如果该模块不支持 REST，则会发出警告。默认值: `"always"`
username 别名：user 字符串	这可以是集群范围或 SVM 范围的帐户，具体取决于需要集群级别还是 SVM 级别的 API。有关更多信息，请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。支持两种身份验证方法基本身份验证，使用用户名和密码， SSL 证书身份验证，使用 ssl 客户端证书文件，以及可选的私钥文件。要使用证书，必须已在 ONTAP 集群中安装证书，并且必须已启用证书身份验证。
validate_certs 布尔值	如果设置为 `no`，则不会验证 SSL 证书。这应该仅在使用自签名证书的个人控制站点上设置为 `False`。选择 `false` `true` ← (默认)

注释 

注意

仅支持 REST，且需要 ONTAP 9.6 或更高版本。
前缀为 na_ontap 的模块旨在支持 ONTAP 存储平台。
默认启用并建议使用 https。要在集群上启用 http，必须运行以下命令：‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

示例 

- name: Modify the timeout value for CLI sessions to be 15 minutes
  netapp.ontap.na_ontap_cli_timeout:
    state: present
    timeout: 15
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

- name: Prevent CLI sessions from timing out
  netapp.ontap.na_ontap_cli_timeout:
    state: present
    timeout: 0
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

作者

NetApp Ansible 团队 (@carchi8py)