netapp.ontap.na_ontap_portset 模块 – NetApp ONTAP 创建/删除端口集

注意

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

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

要安装它，请使用：ansible-galaxy collection install netapp.ontap。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

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

netapp.ontap 2.8.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。
feature_flags 字典在 netapp.ontap 20.5.0 中添加	启用或禁用新功能。这可以用来启用实验性功能或禁用破坏向后兼容性的新功能。支持的键和值如有更改，恕不另行通知。未知的键将被忽略。
force 布尔值	如果为“false”或未指定，则如果存在任何绑定到此端口集的 igroup，则请求将失败。如果为“true”，则强制销毁端口集，即使存在现有的 igroup 绑定。选项 `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 客户端密钥文件的路径。
name 字符串 / 必需	要创建的端口集的名称。
ontapi 整数	要使用的 ontap api 版本
password 别名：pass 字符串	指定用户的密码。
ports 列表 / 元素=字符串	指定与此端口集关联的端口。应该用逗号分隔。它表示任何时候端口列表的预期状态，并替换端口的当前值。如果端口在预期状态中指定但不在当前状态中，则添加端口。如果端口在当前状态中但不在预期状态中，则删除端口。
state 字符串	如果您想创建一个端口集。默认： `"present"`
type 字符串	在 ZAPI 中创建时必需。如果在 REST 中创建时未指定，则默认值为 mixed。此端口集接受的协议。选项 `"fcp"` `"iscsi"` `"mixed"`
use_rest 字符串	是否使用 REST 或 ZAPI。 always – 如果模块支持 REST，将始终使用 REST API。如果模块不支持 REST，则会发出警告。如果 REST 不支持模块选项，则会发出错误。 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/。支持两种身份验证方法基本身份验证，使用用户名和密码， SSL 证书身份验证，使用 SSL 客户端证书文件，以及可选的私钥文件。要使用证书，必须已在 ONTAP 集群中安装证书，并且必须启用证书身份验证。
validate_certs 布尔值	如果设置为 `no`，则不会验证 SSL 证书。只有在使用自签名证书的个人控制站点上，才应将其设置为 `False`。选项 `false` `true` ← (默认)
vserver 字符串 / 必需	SVM 的名称。

注释 

注意

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

示例 

- name: Create Portset
  netapp.ontap.na_ontap_portset:
    state: present
    vserver: vserver_name
    name: portset_name
    ports: a1
    type: "{{ protocol type }}"
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"

- name: Modify ports in portset
  netapp.ontap.na_ontap_portset:
    state: present
    vserver: vserver_name
    name: portset_name
    ports: a1,a2
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"

- name: Delete Portset
  netapp.ontap.na_ontap_portset:
    state: absent
    vserver: vserver_name
    name: portset_name
    force: True
    type: "{{ protocol type }}"
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"

作者

NetApp Ansible 团队 (@carchi8py)