netapp.ontap.na_ontap_cluster_peer 模块 – 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_cluster_peer。

netapp.ontap 2.7.0 中的新增功能

概要 

在 ONTAP 上创建/删除集群对等关系
在 ONTAP 上修改集群对等关系中的远程集群间地址

要求 

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

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。
dest_cluster_name 字符串	要修改或删除的对等关系中目标集群的名称。删除对等关系和修改 dest_intercluster_lifs 时需要。
dest_hostname 字符串	已弃用 - 请使用 `peer_options`。需要对等的目的地集群 IP 或主机名。需要在目标集群完成对等过程。
dest_intercluster_lifs 别名: dest_intercluster_lif 列表 / 元素=字符串在 netapp.ontap 2.8.0 中添加	目标集群的集群间地址列表。在源集群中用作对等地址。所有这些集群间 LIF 都应属于目标集群。
dest_password 字符串	已弃用 - 请使用 `peer_options`。目标密码。如果这与源密码相同或使用证书，则为可选。
dest_username 字符串	已弃用 - 请使用 `peer_options`。目标用户名。如果这与源用户名相同或使用证书，则为可选。
encryption_protocol_proposed 字符串在 netapp.ontap 20.5.0 中添加	用于集群间通信的加密协议。仅在 ONTAP 9.5 或更高版本上可用。选择 `"tls_psk"` `"none"`
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 时忽略。
hostname 字符串 / 必需	ONTAP 实例的主机名或 IP 地址。
http_port 整数	使用此端口覆盖默认端口（80 或 443）
https 布尔值	启用和禁用 https。使用 REST 时忽略，因为仅支持 https。使用 SSL 证书身份验证时忽略，因为它需要 SSL。选择 `false` ← (默认) `true`
ipspace 字符串在 netapp.ontap 20.11.0 中添加	本地集群间 LIF 的 IP 空间。如果未提供，则假定为默认 IP 空间。
key_filepath 字符串在 netapp.ontap 20.6.0 中添加	SSL 客户端密钥文件的路径。
ontapi 整数	要使用的 ontap api 版本
passphrase 字符串	与提供给对等集群的密码匹配的任意密码。
password 别名: pass 字符串	指定用户的密码。
peer_options 字典在 netapp.ontap 21.8.0 中添加	对等系统的 IP 地址和连接选项。如果未指定任何这些选项，则使用相应的源选项。
cert_filepath 字符串	SSL 客户端证书文件 (.pem) 的路径。
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。选择 `false` `true`
key_filepath 字符串	SSL 客户端密钥文件的路径。
ontapi 整数	要使用的 ontap api 版本
password 别名: pass 字符串	指定用户的密码。
use_rest 字符串	如果目标系统支持模块所需的所有资源和属性，则使用 REST API。否则将恢复为 ZAPI。 always – 将始终使用 REST API never - 将始终使用 ZAPI auto - 将尝试使用 REST API
username 别名：user 字符串	使用基本身份验证时的用户名。
validate_certs 布尔值	如果设置为 `no`，则不会验证 SSL 证书。仅当在个人控制的站点上使用自签名证书时，才应将其设置为 `False`。选择 `false` `true`
source_cluster_name 字符串	要修改或删除的对等关系中源集群的名称。删除对等关系以及修改 source_intercluster_lifs 时是必需的。
source_intercluster_lifs 别名：source_intercluster_lif 列表 / 元素=字符串在 netapp.ontap 2.8.0 中添加	源集群的集群间地址列表。在目标集群中用作对等地址。所有这些集群间 LIF 都应属于源集群。
state 字符串	指定的集群对等关系是否存在。选择 `"present"` ←（默认） `"absent"`
use_rest 字符串	是否使用 REST 或 ZAPI。 always – 如果模块支持 REST，将始终使用 REST API。如果模块不支持 REST，则会发出警告。如果 REST 中不支持模块选项，则会发出错误。 never – 如果模块支持 ZAPI，将始终使用 ZAPI。如果 ZAPI 中不支持 REST 选项，则可能会发出错误。 auto – 如果模块支持 REST 并且支持模块选项，将尝试使用 REST API。否则，将恢复为 ZAPI。默认值： `"auto"`
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 支持修改远程集群间地址的操作。
以 na_ontap 为前缀的模块旨在支持 ONTAP 存储平台。
默认启用并推荐使用 https。要在集群上启用 http，您必须运行以下命令 ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

示例 

- name: Create cluster peer
  netapp.ontap.na_ontap_cluster_peer:
    state: present
    source_intercluster_lifs: 1.2.3.4,1.2.3.5
    dest_intercluster_lifs: 1.2.3.6,1.2.3.7
    passphrase: XXXX
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    peer_options:
      hostname: "{{ dest_netapp_hostname }}"
    encryption_protocol_proposed: tls_psk

- name: Delete cluster peer
  netapp.ontap.na_ontap_cluster_peer:
    state: absent
    source_cluster_name: test-source-cluster
    dest_cluster_name: test-dest-cluster
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    peer_options:
      hostname: "{{ dest_netapp_hostname }}"

- name: Create cluster peer - different credentials
  netapp.ontap.na_ontap_cluster_peer:
    state: present
    source_intercluster_lifs: 1.2.3.4,1.2.3.5
    dest_intercluster_lifs: 1.2.3.6,1.2.3.7
    passphrase: XXXX
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    peer_options:
      hostname: "{{ dest_netapp_hostname }}"
      cert_filepath: "{{ cert_filepath }}"
      key_filepath: "{{ key_filepath }}"
    encryption_protocol_proposed: tls_psk

- name: Modify cluster peer - destination intercluster addresses
  netapp.ontap.na_ontap_cluster_peer:
    state: present
    source_intercluster_lifs: 1.2.3.4,1.2.3.5
    dest_intercluster_lifs: 1.2.3.8
    dest_cluster_name: test-dest-cluster
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    peer_options:
      hostname: "{{ dest_netapp_hostname }}"

作者

NetApp Ansible 团队 (@carchi8py)