netapp.ontap.na_ontap_cifs 模块 – NetApp ONTAP 管理 cifs 共享
注意
此模块是 netapp.ontap 集合 (版本 22.13.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install netapp.ontap。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在剧本中使用它，请指定：netapp.ontap.na_ontap_cifs。
netapp.ontap 2.6.0 中的新增功能
概要
在 ONTAP 上创建、销毁或修改 (路径) cifs 共享。
要求
执行此模块的主机需要以下要求。
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 或更高版本。
参数
参数 |
注释 |
|---|---|
如果启用，则此共享中的所有文件夹都对用户可见，具体取决于单个用户的访问权限；防止显示用户无权访问的文件夹或其他共享资源。 此选项仅支持 REST。 选项
|
|
指定是否允许 SMB2 客户端访问加密的共享。 此选项需要 REST 和 ONTAP 9.11.0 或更高版本。 选项
|
|
指定 Windows 客户端是否可以浏览共享。 此选项需要 REST 和 ONTAP 9.13.1 或更高版本。 选项
|
|
SSL 客户端证书文件（.pem）的路径。 python 2.6 不支持。 |
|
指定 CIFS 客户端是否可以请求此共享上目录的更改通知。 此选项仅支持 REST。 选项
|
|
CIFS 共享描述。 |
|
指定连接到此共享的客户端是否可以以持久方式打开文件。 以这种方式打开的文件受到保护，不会受到故障转移和返还等中断事件的影响。 此选项需要 REST 和 ONTAP 9.10.1 或更高版本。 选项
|
|
指定访问此共享时必须使用 SMB 加密。不支持加密的客户端无法访问此共享。 此选项仅支持 REST。 选项
|
|
启用或禁用新功能。 这可用于启用实验性功能或禁用破坏向后兼容性的新功能。 支持的键和值可能会更改，恕不另行通知。未知键将被忽略。 |
|
使用 REST 时覆盖集群 ONTAP 版本。 如果版本与目标集群不匹配，则行为未定义。 这是在由于权限问题无法读取集群版本时提供的解决方法。请参阅 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues。 这应采用 9.10 或 9.10.1 的形式，每个元素都是整数。 当 ZAPI 忽略。 |
|
指定共享是否是主目录共享，其中共享和路径名称是动态的。 ONTAP 主目录功能会自动为每个用户提供指向其主目录的动态共享，而无需为每个用户创建单独的 SMB 共享。 此功能使我们能够配置一个共享，该共享根据连接到它的用户映射到不同的目录 无需为每个用户创建单独的共享，可以创建一个具有主目录参数的单个共享。 在主目录共享中，ONTAP 通过将 %w、%u 和 %d 变量分别替换为相应的 Windows 用户名、UNIX 用户名和域名来动态生成共享名称和共享路径。 此选项仅支持 REST 且无法修改。 选项
|
|
ONTAP 实例的主机名或 IP 地址。 |
|
使用此端口覆盖默认端口 (80 或 443) |
|
启用和禁用 https。 使用 REST 时忽略，因为仅支持 https。 使用 SSL 证书身份验证时忽略，因为它需要 SSL。 选项
|
|
SSL 客户端密钥文件的路径。 |
|
CIFS 共享的名称。CIFS 共享名称是 UTF-8 字符串，以下字符是非法的；包括 0x00 到 0x1F 的控制字符，以及 0x22（双引号） |
|
指定连接到此共享的 SMB 客户端是否可以缓存 CIFS 服务器返回的目录枚举结果。 此选项需要 REST 和 ONTAP 9.10.1 或更高版本。 选项
|
|
允许 Windows 客户端在此共享上缓存数据。 此选项仅支持 REST，并且需要 ONTAP 9.10 或更高版本。 选项
|
|
要使用的 ontap api 版本 |
|
指定在此共享上是否启用机会性锁。“机会性锁”允许客户端锁定文件并在本地缓存内容，这可以提高文件操作的性能。 仅支持 REST。 选项
|
|
指定用户的密码。 |
|
通过此 CIFS 共享共享的文件系统路径。该路径是相对于 vserver 根目录的完整、用户可见的路径，并且可能跨越联接挂载点。路径使用 UTF8 编码，并使用正斜杠作为目录分隔符。 |
|
CIFS 共享的属性列表。 不支持 REST。 在 REST API 中，share-properties 是单独的字段。 可以通过设置 |
|
指定可以从客户端查看和还原先前版本。 此选项需要 REST 和 ONTAP 9.13.1 或更高版本。 选项
|
|
指定客户端是否可以查看和遍历快照副本。 此选项需要 REST 和 ONTAP 9.10.1 或更高版本。 选项
|
|
指定的 CIFS 共享是否存在。 选项
|
|
此 CIFS 共享的符号链接属性列表。 不支持 REST，此选项在 REST 中被 |
|
此 CIFS 共享的 unix_symlink 属性列表 此选项仅支持 REST。 选项
|
|
是否使用 REST 或 ZAPI。 always – 如果模块支持 REST，则始终使用 REST API。如果模块不支持 REST，则会发出警告。如果模块选项在 REST 中不受支持，则会发出错误。 never – 如果模块支持 ZAPI，则始终使用 ZAPI。如果 REST 选项在 ZAPI 中不受支持，则可能会发出错误。 auto – 如果模块支持 REST 并且支持模块选项，则尝试使用 REST API。否则恢复到 ZAPI。 默认： |
|
这可以是集群范围或 SVM 范围的帐户，具体取决于是否需要集群级或 SVM 级 API。 更多信息，请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。 支持两种身份验证方法
要使用证书，必须已在 ONTAP 集群中安装证书，并且必须已启用证书身份验证。 |
|
如果设置为 仅当在使用自签名证书的个人控制站点上使用时，才应将其设置为 选项
|
|
应用访问扫描的 vscan 文件操作配置文件集。 REST 支持需要 ONTAP 9.15.1 或更高版本。 选项
|
|
包含 CIFS 共享的 Vserver。 |
备注
注意
以 na_ontap 为前缀的模块旨在支持 ONTAP 存储平台。
默认情况下启用 https 并推荐使用。要在集群上启用 http，必须运行以下命令“set -privilege advanced;”“system services web modify -http-enabled true;”
示例
- name: Create CIFS share - ZAPI
netapp.ontap.na_ontap_cifs:
state: present
name: cifsShareName
path: /
vserver: vserverName
share_properties: browsable,oplocks
symlink_properties: read_only,enable
comment: CIFS share description
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete CIFS share - ZAPI
netapp.ontap.na_ontap_cifs:
state: absent
name: cifsShareName
vserver: vserverName
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Modify path CIFS share - ZAPI
netapp.ontap.na_ontap_cifs:
state: present
name: pb_test
vserver: vserverName
path: /
share_properties: show_previous_versions
symlink_properties: disable
vscan_fileop_profile: no_scan
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create CIFS share - REST
netapp.ontap.na_ontap_cifs:
state: present
name: cifsShareName
path: /
vserver: vserverName
oplocks: true
change_notify: true
unix_symlink: disable
comment: CIFS share description
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Modify CIFS share - REST
netapp.ontap.na_ontap_cifs:
state: present
name: cifsShareName
path: /
vserver: vserverName
oplocks: true
change_notify: true
unix_symlink: local
comment: CIFS share description
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
作者
NetApp Ansible 团队 (@carchi8py)