netapp.ontap.na_ontap_vserver_peer 模块 – NetApp ONTAP Vserver 对等

注意

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

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

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

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

netapp.ontap 2.7.0 中的新增功能

概要 

创建/删除 vserver 对等

要求 

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

Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。
Python 3 - 建议使用 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 或更高版本。

参数 

参数	注释
applications 列表 / 元素=字符串	可以使用对等关系的应用程序列表。从 ONTAP 9.5 开始支持 FlexCache。
cert_filepath 字符串 netapp.ontap 20.6.0 中新增	SSL 客户端证书文件（.pem）的路径。不支持 python 2.6。
dest_hostname 字符串	已弃用 - 请使用 `peer_options`。目标主机名或 IP 地址。需要与远程集群创建 vserver 对等关系。
dest_password 字符串	已弃用 - 请使用 `peer_options`。目标密码。如果与源密码相同，则可选。
dest_username 字符串	已弃用 - 请使用 `peer_options`。目标用户名。如果与源用户名相同，则可选。
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`
key_filepath 字符串 netapp.ontap 20.6.0 中新增	SSL 客户端密钥文件的路径。
local_name_for_peer 字符串	指定关系中对等 Vserver 的本地名称。如果您看到“Error creating vserver peer … Vserver name conflicts with one of the following”，请使用此选项。
local_name_for_source 字符串	指定关系中源 Vserver 的本地名称。如果您看到“Error accepting vserver peer … System generated a name for the peer Vserver because of a naming conflict”，请使用此选项。
ontapi 整数	要使用的 ONTAP API 版本
password 别名：pass 字符串	指定用户的密码。
peer_cluster 字符串	指定对等集群的名称。需要与远程集群创建 vserver 对等关系
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`
peer_vserver 字符串 / 必需	指定关系中对等 Vserver 的名称。
state 字符串	指定的 vserver 对等是否存在。选项 `"present"` ← (默认) `"absent"`
use_rest 字符串	是否使用 REST 或 ZAPI。 always – 如果模块支持 REST API，则始终使用 REST API。如果模块不支持 REST，则会发出警告。如果 REST 中不支持模块选项，则会发出错误。 never – 如果模块支持 ZAPI，则始终使用 ZAPI。如果 ZAPI 中不支持 REST 选项，则可能会发出错误。 auto – 如果模块支持 REST API 且支持模块选项，则尝试使用 REST API。否则回退到 ZAPI。默认值： `"auto"`
用户名别名：user 字符串	这可以是集群范围或 SVM 范围的帐户，具体取决于是否需要集群级或 SVM 级 API。更多信息，请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。支持两种身份验证方法基本身份验证，使用用户名和密码； SSL 证书身份验证，使用 ssl 客户端证书文件，以及可选的私钥文件。要使用证书，必须已在 ONTAP 集群中安装证书，并且必须已启用证书身份验证。
validate_certs 布尔值	如果设置为 `no`，则不会验证 SSL 证书。仅应在使用自签名证书的个人控制站点上将此设置为 `False`。选项 `false` `true` ← (默认)
vserver 字符串 / 必需	指定关系中源 Vserver 的名称。

备注 

注意

以 na_ontap 为前缀的模块旨在支持 ONTAP 存储平台。
默认情况下启用 https 并推荐使用。要在集群上启用 http，必须运行以下命令“set -privilege advanced;”“system services web modify -http-enabled true;”。

示例 

- name: Source vserver peer create
  netapp.ontap.na_ontap_vserver_peer:
    state: present
    peer_vserver: ansible2
    peer_cluster: ansibleCluster
    local_name_for_peer: peername
    local_name_for_source: sourcename
    vserver: ansible
    applications: ['snapmirror']
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    peer_options:
      hostname: "{{ netapp_dest_hostname }}"

- name: vserver peer delete
  netapp.ontap.na_ontap_vserver_peer:
    state: absent
    peer_vserver: ansible2
    vserver: ansible
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Source vserver peer create - different credentials
  netapp.ontap.na_ontap_vserver_peer:
    state: present
    peer_vserver: ansible2
    peer_cluster: ansibleCluster
    local_name_for_peer: peername
    local_name_for_source: sourcename
    vserver: ansible
    applications: ['snapmirror']
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    peer_options:
      hostname: "{{ netapp_dest_hostname }}"
      cert_filepath: "{{ cert_filepath }}"
      key_filepath: "{{ key_filepath }}"

作者

NetApp Ansible 团队 (@carchi8py)