netapp.ontap.na_ontap_cifs_server 模块 – NetApp ONTAP CIFS 服务器配置

注意

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

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

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

要在 Playbook 中使用它,请指定:netapp.ontap.na_ontap_cifs_server

netapp.ontap 2.6.0 中的新功能

概要

  • 创建/删除和修改 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 或更高版本。

参数

参数

注释

admin_password

字符串

指定 CIFS 服务器管理员密码。

当与 absent 一起使用时,如果还提供了 admin_user_name,则会删除该帐户。

admin_user_name

字符串

指定 CIFS 服务器管理员用户名。

当与 absent 一起使用时,如果还提供了 admin_password,则会删除该帐户。

aes_netlogon_enabled

布尔值

在 netapp.ontap 21.20.0 中添加

指定是否为 Netlogon 通道启用 AES 会话密钥。

仅支持 REST,需要 ONTAP 版本 9.10.1 或更高版本。

选项

  • false

  • true

cert_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端证书文件 (.pem) 的路径。

不支持 Python 2.6。

comment

字符串

在 netapp.ontap 22.13.0 中添加

CIFS 服务器的描述性文本注释。

SMB 客户端在网络上浏览服务器时可以看到 CIFS 服务器注释。

仅支持 REST。

default_site

字符串

在 netapp.ontap 22.8.0 中添加

指定 Active Directory 域中与 CIFS 服务器关联的站点,如果 Data ONTAP 无法确定合适的站点。

仅支持 REST,需要 ONTAP 版本 9.13.1 或更高版本。

domain

字符串

此 CIFS 服务器所属的 Windows Active Directory 的完全限定域名。

encrypt_dc_connection

布尔值

在 netapp.ontap 21.20.0 中添加

指定是否需要对域控制器连接进行加密。

仅支持 REST,需要 ONTAP 版本 9.8 或更高版本。将 na_ontap_vserver_cifs_security 与 ZAPI 一起使用。

选项

  • false

  • true

feature_flags

字典

在 netapp.ontap 20.5.0 中添加

启用或禁用新功能。

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

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

force

布尔值

在 netapp.ontap 2.7.0 中添加

当状态为 present 时,如果设置此项,并且 Active Directory 中存在与“name”中指定的名称相同的计算机帐户,则将覆盖并重用该帐户。

当状态为 absent 时,如果设置此项,则无论通信错误如何,都会删除本地 CIFS 配置。

对于 REST,需要 ONTAP 版本 9.11。

选项

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

from_name

字符串

在 netapp.ontap 21.19.0 中添加

指定现有的 cifs_server 名称。

此选项用于重命名 cifs_server。

仅在 REST 中支持,并且需要将 force 设置为 True。

需要 ONTAP 版本 9.11.0。

如果服务正在运行,它将停止以执行重命名操作,并自动重新启动。

如果服务已停止,它将在重命名操作后短暂重新启动,然后再次停止。

hostname

字符串 / 必需

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

http_port

整数

使用此端口覆盖默认端口(80 或 443)

https

布尔值

启用和禁用 https。

当使用 REST 时被忽略,因为仅支持 https。

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

选项

  • false ← (默认)

  • true

is_multichannel_enabled

布尔值

在 netapp.ontap 22.10.0 中添加

指定 CIFS 服务器是否支持多通道。

仅在使用 REST 时支持,并且需要 ontap 版本 9.10 或更高版本。

选项

  • false

  • true

kdc_encryption

布尔值

在 netapp.ontap 21.20.0 中添加

指定是否为所有基于 Kerberos 与 Active Directory KDC 的通信启用 AES-128 和 AES-256 加密。

仅在使用 REST 时支持。使用 ZAPI 时使用 na_ontap_vserver_cifs_security。

选项

  • false

  • true

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

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

ldap_referral_enabled

布尔值

在 netapp.ontap 21.20.0 中添加

指定是否为 AD LDAP 连接启用 LDAP 引用追踪。

仅在使用 REST 时支持,并且需要 ontap 版本 9.10.1 或更高版本。使用 ZAPI 时使用 na_ontap_vserver_cifs_security。

选项

  • false

  • true

lm_compatibility_level

字符串

在 netapp.ontap 22.9.0 中添加

指定 CIFS 服务器的最小安全级别,也称为 LMCompatibilityLevel。

仅支持 REST,需要 ONTAP 版本 9.8 或更高版本。将 na_ontap_vserver_cifs_security 与 ZAPI 一起使用。

选项

  • "lm_ntlm_ntlmv2_krb"

  • "ntlm_ntlmv2_krb"

  • "ntlmv2_krb"

  • "krb"

name

别名:cifs_server_name

字符串 / 必需

指定 cifs_server 名称。

ontapi

整数

要使用的 ontap API 版本

ou

字符串

在 netapp.ontap 2.7.0 中添加

此 CIFS 服务器所属的 Windows Active Directory 中的组织单元 (OU)。

password

别名:pass

字符串

指定用户的密码。

restrict_anonymous

字符串

在 netapp.ontap 21.20.0 中添加

指定授予匿名用户的访问级别。

仅支持 REST。

选项

  • "no_enumeration"

  • "no_restriction"

  • "no_access"

service_state

字符串

CIFS 服务器的管理状态。

选项

  • "stopped"

  • "started"

session_security

字符串

在 netapp.ontap 21.20.0 中添加

指定 AD LDAP 连接的客户端会话安全。

仅在使用 REST 时支持,并且需要 ontap 版本 9.10.1 或更高版本。使用 ZAPI 时使用 na_ontap_vserver_cifs_security。

选项

  • "none"

  • "sign"

  • "seal"

smb_encryption

布尔值

在 netapp.ontap 21.20.0 中添加

确定是否需要对传入的 CIFS 流量进行 SMB 加密。

仅在使用 REST 时支持。使用 ZAPI 时使用 na_ontap_vserver_cifs_security。

选项

  • false

  • true

smb_signing

布尔值

在 netapp.ontap 21.20.0 中添加

指定是否需要对传入的 CIFS 流量进行签名。

仅在使用 REST 时支持。使用 ZAPI 时使用 na_ontap_vserver_cifs_security。

选项

  • false

  • true

state

字符串

指定的 cifs_server 是否应该存在。

选项

  • "present" ← (默认)

  • "absent"

try_ldap_channel_binding

布尔值

在 netapp.ontap 21.20.0 中添加

指定在 TLS/LDAPS 的情况下是否尝试通道绑定。

仅在使用 REST 时支持,并且需要 ontap 版本 9.10.1 或更高版本。使用 ZAPI 时使用 na_ontap_vserver_cifs_security。

选项

  • false

  • true

use_ldaps

布尔值

在 netapp.ontap 21.20.0 中添加

指定是否对安全的 Active Directory LDAP 连接使用 LDAPS。

仅在使用 REST 时支持,并且需要 ontap 版本 9.10.1 或更高版本。使用 ZAPI 时使用 na_ontap_vserver_cifs_security。

选项

  • false

  • true

use_rest

字符串

是否使用 REST 或 ZAPI。

always – 如果模块支持 REST,将始终使用 REST API。如果模块不支持 REST,则会发出警告。如果模块选项在 REST 中不受支持,则会发出错误。

never – 如果模块支持 ZAPI,将始终使用 ZAPI。如果 REST 选项在 ZAPI 中不受支持,则可能会发出错误。

auto – 如果模块支持 REST 并且支持模块选项,将尝试使用 REST API。否则恢复为 ZAPI。

默认值: "auto"

use_start_tls

布尔值

在 netapp.ontap 21.20.0 中添加

指定是否使用 SSL/TLS 来允许与 Active Directory LDAP 服务器进行安全的 LDAP 通信。

仅在使用 REST 时支持,并且需要 ontap 版本 9.10.1 或更高版本。使用 ZAPI 时使用 na_ontap_vserver_cifs_security。

选项

  • false

  • true

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 ← (默认)

vserver

字符串 / 必需

要使用的 vserver 的名称。

workgroup

字符串

此 CIFS 服务器所属的域或工作组的 NetBIOS 名称。

注释

注意

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

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

示例

- name: Create cifs_server
  netapp.ontap.na_ontap_cifs_server:
    state: present
    name: data2
    vserver: svm1
    service_state: stopped
    domain: "{{ id_domain }}"
    admin_user_name: "{{ domain_login }}"
    admin_password: "{{ domain_pwd }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete cifs_server
  netapp.ontap.na_ontap_cifs_server:
    state: absent
    name: data2
    vserver: svm1
    admin_user_name: "{{ domain_login }}"
    admin_password: "{{ domain_pwd }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Start cifs_server
  netapp.ontap.na_ontap_cifs_server:
    state: present
    name: data2
    vserver: svm1
    service_state: started
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Stop cifs_server
  netapp.ontap.na_ontap_cifs_server:
    state: present
    name: data2
    vserver: svm1
    service_state: stopped
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Rename cifs_server - REST
  netapp.ontap.na_ontap_cifs_server:
    state: present
    from_name: data2
    name: cifs
    vserver: svm1
    force: True
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify cifs_server security - REST
  netapp.ontap.na_ontap_cifs_server:
    state: present
    name: data2
    vserver: svm1
    service_state: stopped
    encrypt_dc_connection: True
    smb_encryption: True
    kdc_encryption: True
    smb_signing: True
    aes_netlogon_enabled: True
    ldap_referral_enabled: True
    session_security: seal
    try_ldap_channel_binding: False
    use_ldaps: True
    use_start_tls: True
    restrict_anonymous: no_access
    domain: "{{ id_domain }}"
    admin_user_name: "{{ domain_login }}"
    admin_password: "{{ domain_pwd }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

作者

  • NetApp Ansible 团队 (@carchi8py)