netapp.ontap.na_ontap_ldap_client 模块 – NetApp ONTAP LDAP 客户端

注意

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

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

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

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

netapp.ontap 2.9.0 中的新增功能

概要

  • 在 NetApp ONTAP 上创建、修改或删除 LDAP 客户端。

需求

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

  • 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 或更高版本。

参数

参数

注释

ad_domain

字符串

Active Directory 域名。

如果 state=present，则需要 servers 或 ad_domain。

与 servers 互斥。

base_dn

字符串

LDAP 基 DN。

base_scope

字符串

LDAP 搜索范围。

选项

  • "subtree"

  • "onelevel"

  • "base"

bind_as_cifs_server

布尔值

集群使用 CIFS 服务器的凭据绑定到 LDAP 服务器。

选项

  • false

  • true

bind_dn

字符串

LDAP 绑定用户 DN。

bind_password

字符串

LDAP 绑定用户密码。

cert_filepath

字符串

netapp.ontap 20.6.0 中新增

SSL 客户端证书文件路径（.pem）。

python 2.6 不支持。

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 客户端密钥文件路径。

ldaps_enabled

布尔值

netapp.ontap 21.22.0 中新增

指定是否启用 LDAPS。

选项

  • false

  • true

min_bind_level

字符串

最低 LDAP 服务器绑定级别。

选项

  • "anonymous"

  • "simple"

  • "sasl"

name

字符串

LDAP 客户端配置的名称。

仅在 ZAPI 中受支持。

ZAPI 必需。

ontapi

整数

要使用的 ontap api 版本

password

别名：pass

字符串

指定用户的密码。

port

别名：tcp_port

整数

netapp.ontap 21.3.0 中新增

LDAP 服务器 TCP 端口。

preferred_ad_servers

列表 / 元素=字符串

首选 Active Directory (AD) 域控制器。

与 servers 互斥。

query_timeout

整数

LDAP 服务器查询超时。

referral_enabled

布尔值

LDAP 转发追踪。

选项

  • false

  • true

schema

字符串

LDAP 模式。

如果 state=present，则需要。

默认模式 - “AD-IDMU”、“AD-SFU”、“MS-AD-BIS”、“RFC-2307”。

也允许自定义模式。

servers

别名：ldap_servers

列表 / 元素=字符串

用逗号分隔的 LDAP 服务器列表。FQDN 或 IP 地址。

如果 state=present，则需要 servers 或 ad_domain。

与 preferred_ad_servers 和 ad_domain 互斥。

session_security

字符串

客户端会话安全。

选项

  • "none"

  • "sign"

  • "seal"

skip_config_validation

布尔值

netapp.ontap 22.0.0 中新增

指示是否禁用对指定的 LDAP 配置的验证。

默认情况下，例如当无法解析服务器名称时，REST 会报告错误。

需要 ONTAP 9.9 或更高版本。

ZAPI 忽略。

选项

  • false

  • true

state

字符串

指定的 LDAP 客户端配置是否存在。

选项

  • "present" ← (默认)

  • "absent"

use_rest

字符串

是否使用 REST 或 ZAPI。

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

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

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

默认值： "auto"

use_start_tls

布尔值

在 LDAP 连接上启动 TLS。

选项

  • 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

字符串 / 必需

保存LDAP客户端配置的vserver/svm。

备注

注意

  • 使用ZAPI创建的LDAP客户端应使用ZAPI删除。

  • 使用REST创建的LDAP客户端应使用REST删除。

  • REST仅支持创建、修改和删除数据svm ldap客户端配置。

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

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

示例

- name: Create LDAP client
  # assuming credentials are set using module_defaults
  netapp.ontap.na_ontap_ldap_client:
    state: present
    vserver: 'vserver1'
    servers: 'ldap1.example.company.com,ldap2.example.company.com'
    base_dn: 'dc=example,dc=company,dc=com'

- name: modify LDAP client
  # assuming credentials are set using module_defaults
  netapp.ontap.na_ontap_ldap_client:
    state: present
    vserver: 'vserver1'
    servers: 'ldap1.example.company.com'
    base_dn: 'dc=example,dc=company,dc=com'
    skip_config_validation: true

- name: Delete LDAP client
  # assuming credentials are set using module_defaults
  netapp.ontap.na_ontap_ldap_client:
    state: absent
    vserver: 'vserver1'

作者

  • Milan Zink (@zeten30) /