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。

与服务器互斥。

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

列表 / elements=字符串

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

与服务器互斥。

query_timeout

整数

LDAP 服务器查询超时。

referral_enabled

布尔值

LDAP 引荐追逐。

选择

  • false

  • true

schema

字符串

LDAP 架构。

如果 state=present,则为必填项。

默认架构 - ‘AD-IDMU’、‘AD-SFU’、‘MS-AD-BIS’、‘RFC-2307’。

也允许自定义架构。

servers

别名:ldap_servers

列表 / elements=字符串

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) /