fortinet.fortios.fortios_user_ldap 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 LDAP 服务器条目。
注意
此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在剧本中使用它，请指定：fortinet.fortios.fortios_user_ldap。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改用户功能和 ldap 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值都需要在使用前调整为数据源。已使用 FOS v6.0.0 进行测试
要求
执行此模块的主机需要满足以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选项
|
|
要操作的成员属性路径。 如果存在多个属性，则以斜杠字符分隔。 标记有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
配置 LDAP 服务器条目。 |
|
定义证书中的主体标识字段，用于用户访问权限检查。 选项
|
|
帐户密钥筛选器，使用 UPN 作为搜索筛选器。 |
|
帐户密钥处理操作。FortiGate 将保留整个域或从主体标识中剥离域。 选项
|
|
在证书中定义 SAN，用于用户主体名称匹配。 选项
|
|
启用/禁用反钓鱼凭据后端。 选项
|
|
CA 证书名称。来源 vpn.certificate.ca.name。 |
|
客户端证书名称。来源 vpn.certificate.local.name。 |
|
启用/禁用使用客户端证书进行 TLS 身份验证。 选项
|
|
LDAP 服务器的通用名称标识符。大多数 LDAP 服务器的通用名称标识符是“cn”。 |
|
用于在 LDAP 服务器上查找条目的专有名称。 |
|
用于组匹配的筛选器。 |
|
组成员检查方法。 选项
|
|
用于组搜索的筛选器。 |
|
用于组搜索的搜索基准。 |
|
指定用于访问服务器的传出接口。来源 system.interface.name。 |
|
指定如何选择传出接口来访问服务器。 选项
|
|
从中获取组成员资格的属性名称。 |
|
LDAP 服务器条目名称。 |
|
启用/禁用获取用户信息。 选项
|
|
用于初始绑定的密码。 |
|
获取密码哈希的属性名称。 |
|
启用/禁用密码过期警告。 选项
|
|
启用/禁用在线密码更新。 选项
|
|
用于与 LDAP 服务器通信的端口。 |
|
搜索类型。 选项
|
|
辅助 LDAP 服务器 CN 域名或 IP。 |
|
用于身份验证的端口。 选项
|
|
LDAP 服务器 CN 域名或 IP。 |
|
启用/禁用 LDAP 服务器身份检查（根据服务器证书验证服务器域名/IP 地址）。 选项
|
|
用于与 LDAP 服务器通信的 FortiGate IP 地址。 |
|
用于与 LDAP 服务器通信的源接口。来源 system.interface.name。 |
|
用于与 LDAP 服务器通信的源端口。 |
|
SSL/TLS 连接的最低支持协议版本。 选项
|
|
服务器可达性缓存的时间，以便当服务器无法访问时，至少在此期间内不会重试（0 = 禁用缓存）。 |
|
第三个 LDAP 服务器 CN 域名或 IP。 |
|
启用/禁用双因素身份验证。 选项
|
|
FortiToken Cloud 的身份验证方法。 选项
|
|
用于将用户同步到 FortiToken Cloud 的筛选器。 |
|
FortiToken Cloud 用户激活的通知方法。 选项
|
|
LDAP 搜索的身份验证类型。 选项
|
|
从中获取用户信息的 MS Exchange 服务器。来源 user.exchange.name。 |
|
用于初始绑定的用户名（完整 DN）。 |
|
虚拟域，在先前定义的那些中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。 默认值： |
说明
注意
旧版 fortiosapi 已被弃用，httpapi 是运行剧本的首选方式
该模块支持 check_mode。
示例
- name: Configure LDAP server entries.
fortinet.fortios.fortios_user_ldap:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_ldap:
account_key_cert_field: "othername"
account_key_filter: "<your_own_value>"
account_key_processing: "same"
account_key_upn_san: "othername"
antiphish: "enable"
ca_cert: "<your_own_value> (source vpn.certificate.ca.name)"
client_cert: "<your_own_value> (source vpn.certificate.local.name)"
client_cert_auth: "enable"
cnid: "<your_own_value>"
dn: "<your_own_value>"
group_filter: "<your_own_value>"
group_member_check: "user-attr"
group_object_filter: "<your_own_value>"
group_search_base: "<your_own_value>"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
member_attr: "<your_own_value>"
name: "default_name_20"
obtain_user_info: "enable"
password: "<your_own_value>"
password_attr: "<your_own_value>"
password_expiry_warning: "enable"
password_renewal: "enable"
port: "389"
search_type: "recursive"
secondary_server: "<your_own_value>"
secure: "disable"
server: "192.168.100.40"
server_identity_check: "enable"
source_ip: "84.230.14.43"
source_ip_interface: "<your_own_value> (source system.interface.name)"
source_port: "0"
ssl_min_proto_version: "default"
status_ttl: "300"
tertiary_server: "<your_own_value>"
two_factor: "disable"
two_factor_authentication: "fortitoken"
two_factor_filter: "<your_own_value>"
two_factor_notification: "email"
type: "simple"
user_info_exchange_server: "<your_own_value> (source user.exchange.name)"
username: "<your_own_value>"
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
FortiGate 镜像的构建号 返回: 始终 示例: |
|
上次用于将内容配置到 FortiGate 的方法 返回: 始终 示例: |
|
上次操作应用后 FortiGate 给出的最后结果 返回: 始终 示例: |
|
上次调用 FortiGate 时使用的主键 (id) 返回: 成功 示例: |
|
用于满足请求的表的名称 返回: 始终 示例: |
|
用于满足请求的表的路径 返回: 始终 示例: |
|
内部修订号 返回: 始终 示例: |
|
设备的序列号 返回: 始终 示例: |
|
操作结果的指示 返回: 始终 示例: |
|
使用的虚拟域 返回: 始终 示例: |
|
FortiGate 的版本 返回: 始终 示例: |