netapp.ontap.na_ontap_cluster 模块 – NetApp ONTAP 集群 - 创建集群并添加/删除节点。

注意

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

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

要安装它，请使用：ansible-galaxy collection install netapp.ontap。您需要满足其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在剧本中使用它，请指定：netapp.ontap.na_ontap_cluster。

netapp.ontap 2.6.0 中的新增功能

概要

  • 创建 ONTAP 集群。

  • 使用 cluster_ip_address 添加或删除集群节点。

  • 添加节点需要 ONTAP 9.3 或更高版本。

  • 删除节点需要 ONTAP 9.4 或更高版本。

要求

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

  • 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 不支持。

certificate

字典

在 netapp.ontap 22.9.0 中添加

集群和节点管理接口用于 TLS 连接请求的证书。

仅支持 REST，需要 ONTAP 9.10 或更高版本。

uuid

字符串

证书 UUID。

cluster_contact

字符串

在 netapp.ontap 19.11.0 中添加

集群联系方式，仅在执行修改操作时相关。

cluster_ip_address

字符串

要添加或删除的节点的集群内部 IP 地址。

cluster_location

字符串

在 netapp.ontap 19.11.0 中添加

集群位置，仅在执行修改操作时相关。

cluster_name

字符串

要管理的集群的名称。

feature_flags

字典

在 netapp.ontap 20.5.0 中添加

启用或禁用新功能。

这可用于启用实验性功能或禁用破坏向后兼容性的新功能。

支持的键和值可能会更改，恕不另行通知。未知键将被忽略。

force

布尔值

在 netapp.ontap 21.13.0 中添加

强制删除已关闭且无法上线以删除其共享资源的节点。

选项

  • false ← (默认)

  • true

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 时将被忽略。

hostname

字符串 / 必需

ONTAP 实例的主机名或 IP 地址。

http_port

整数

使用此端口覆盖默认端口（80 或 443）

https

布尔值

启用和禁用 https。

使用 REST 时将被忽略，因为仅支持 https。

使用 SSL 证书身份验证时将被忽略，因为它需要 SSL。

选项

  • false ← (默认)

  • true

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端密钥文件的路径。

node_name

字符串

在 netapp.ontap 20.9.0 中添加

要添加到集群或从集群删除的节点的名称。

请注意，添加节点时，ONTAP 后端会将“-”转换为“_”。

创建集群时，node_name 将被忽略。

使用 cluster_ip_address 添加节点时，node_name 是可选的。

当用于移除节点时，cluster_ip_address 和 node_name 是互斥的。

ontapi

整数

要使用的 ontap API 版本

password

别名: pass

字符串

指定用户的密码。

single_node_cluster

布尔值

在 netapp.ontap 19.11.0 中添加

集群是否为单节点集群。对于 9.3 或更旧的版本，此参数将被忽略。

如果存在，则观察到无论 ZAPI 的值如何，“集群”接口都会被删除。

选项

  • false

  • true

state

字符串

指定的集群是否应该存在（不支持删除集群）。

由其 cluster_ip_address 标识的节点是否应存在于集群中。

选项

  • "present" ← (默认)

  • "absent"

time_out

整数

在 netapp.ontap 21.1.0 中添加

等待集群创建的超时时间，以秒为单位。

如果在定义的时间内任务未完成，则会报错。

如果为 0，则请求为异步的。

默认设置为 3 分钟。

默认值： 180

timezone

字典

在 netapp.ontap 21.24.0 中添加

集群的时区。仅 REST 支持。

name

字符串

时区名称必须是

地理区域，通常表示为区域/位置

格林威治标准时间 (GMT) 或与 GMT 的小时差

有效的别名；即标准定义中用于指代地理区域或 GMT 的术语

特定于系统或其他与地理区域或 GMT 无关的术语

支持的别名的完整列表可以在这里找到：https://library.netapp.com/ecmdocs/ECMP1155590/html/GUID-D3B8A525-67A2-4BEE-99DB-EF52D6744B5F.html

仅 REST 支持

use_rest

字符串

是否使用 REST 或 ZAPI。

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

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

auto - 如果模块支持 REST API 且模块选项受支持，则会尝试使用 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_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

说明

注意

  • 支持 REST 和 ZAPI

  • 以 na_ontap 为前缀的模块旨在支持 ONTAP 存储平台。

  • 默认情况下启用 https，建议使用。要在集群上启用 http，您必须运行以下命令“set -privilege advanced;”、“system services web modify -http-enabled true;”

示例

- name: Create cluster
  netapp.ontap.na_ontap_cluster:
    state: present
    cluster_name: new_cluster
    time_out: 0
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Add node to cluster (Join cluster)
  netapp.ontap.na_ontap_cluster:
    state: present
    cluster_ip_address: 10.10.10.10
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Add node to cluster (Join cluster)
  netapp.ontap.na_ontap_cluster:
    state: present
    cluster_ip_address: 10.10.10.10
    node_name: my_preferred_node_name
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create a 2 node cluster in one call
  netapp.ontap.na_ontap_cluster:
    state: present
    cluster_name: new_cluster
    cluster_ip_address: 10.10.10.10
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Remove node from cluster
  netapp.ontap.na_ontap_cluster:
    state: absent
    cluster_ip_address: 10.10.10.10
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Remove node from cluster
  netapp.ontap.na_ontap_cluster:
    state: absent
    node_name: node002
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: modify cluster
  netapp.ontap.na_ontap_cluster:
    state: present
    cluster_contact: testing
    cluster_location: testing
    cluster_name: "{{ netapp_cluster}}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: updating the cluster-wide web services configuration
  netapp.ontap.na_ontap_cluster:
    state: present
    cluster_contact: testing
    cluster_location: testing
    certificate:
      uuid: 7f2f332c-933e-11ee-ab1c-005056b397ff
    cluster_name: "{{ netapp_cluster}}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

作者

  • NetApp Ansible 团队 (@carchi8py)