fortinet.fortimanager.fmgr_user_ldap 模块 – 配置 LDAP 服务器条目。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_user_ldap。

fortinet.fortimanager 2.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包含所有需要在使用前调整为数据源的参数和值。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。选项 `false` ← (默认) `true`
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ← (默认) `true`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。选项 `"present"` `"absent"`
user_ldap 字典	设置的顶级参数。
account_key_cert_field 别名：account-key-cert-field 字符串	定义证书中用于用户访问权限检查的主题标识字段。选项 `"othername"` `"rfc822name"` `"dnsname"` `"cn"`
account_key_filter 别名：account-key-filter 字符串	帐户密钥过滤器，使用 UPN 作为搜索过滤器。
account_key_name 别名：account-key-name 字符串	帐户密钥名称，使用 UPN 作为搜索过滤器。
account_key_processing 别名：account-key-processing 字符串	帐户密钥处理操作，保留或去除令牌中 UPN 的域名字符串。选项 `"same"` `"strip"`
account_key_upn_san 别名：account-key-upn-san 字符串	定义证书中的 SAN 用于用户主体名称匹配。选项 `"othername"` `"rfc822name"` `"dnsname"`
antiphish 字符串	启用/禁用反钓鱼凭据后端。选项 `"disable"` `"enable"`
ca_cert 别名：ca-cert 字符串	CA 证书名称。
client_cert 别名：client-cert 字符串	客户端证书名称。
client_cert_auth 别名：client-cert-auth 字符串	启用/禁用使用客户端证书进行 TLS 身份验证。选项 `"disable"` `"enable"`
cnid 字符串	LDAP 服务器的通用名称标识符。
dn 字符串	用于在 LDAP 服务器上查找条目的可分辨名称。
dynamic_mapping 列表 / 元素=字典	动态映射。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
account_key_cert_field 别名：account-key-cert-field 字符串	定义证书中用于用户访问权限检查的主题标识字段。选项 `"othername"` `"rfc822name"` `"dnsname"` `"cn"`
account_key_filter 别名：account-key-filter 字符串	帐户密钥过滤器。
account_key_name 别名：account-key-name 字符串	帐户密钥名称。
account_key_processing 别名：account-key-processing 字符串	帐户密钥处理。选项 `"same"` `"strip"`
account_key_upn_san 别名：account-key-upn-san 字符串	定义证书中的 SAN 用于用户主体名称匹配。选项 `"othername"` `"rfc822name"` `"dnsname"`
antiphish 字符串	启用/禁用反钓鱼凭据后端。选项 `"disable"` `"enable"`
ca_cert 别名：ca-cert 字符串	CA 证书。
client_cert 别名：client-cert 字符串	客户端证书名称。
client_cert_auth 别名：client-cert-auth 字符串	启用/禁用使用客户端证书进行 TLS 身份验证。选项 `"disable"` `"enable"`
cnid 字符串	CN。
dn 字符串	DN。
filter 字符串	过滤器。
group 字符串	组。
group_filter 别名：group-filter 字符串	组过滤器。
group_member_check 别名：group-member-check 字符串	组成员检查。选项 `"user-attr"` `"group-object"` `"posix-group-object"`
group_object_filter 别名：group-object-filter 字符串	组对象过滤器。
group_object_search_base 别名：group-object-search-base 字符串	组对象搜索基础。
group_search_base 别名：group-search-base 字符串	组搜索基础。
interface 字符串	接口。
interface_select_method 别名：interface-select-method 字符串	接口选择方法。选项 `"auto"` `"sdwan"` `"specify"`
max_connections 别名：max-connections 整数	最大连接数。
member_attr 别名：member-attr 字符串	成员属性。
obtain_user_info 别名：obtain-user-info 字符串	获取用户信息。选项 `"disable"` `"enable"`
password 任意	(列表) 密码。
password_attr 别名：password-attr 字符串	获取密码哈希的属性名称。
password_expiry_warning 别名：password-expiry-warning 字符串	密码过期警告。选项 `"disable"` `"enable"`
password_renewal 别名：password-renewal 字符串	密码更新。选项 `"disable"` `"enable"`
port 整数	端口。
retrieve_protection_profile 别名：retrieve-protection-profile 字符串	检索防护配置文件。
search_type 别名：search-type 列表 / 元素=字符串	搜索类型。选项 `"nested"` `"recursive"`
secondary_server 别名：secondary-server 字符串	辅助服务器。
secure 字符串	安全。选项 `"disable"` `"starttls"` `"ldaps"`
server 字符串	服务器。
server_identity_check 别名：server-identity-check 字符串	服务器身份检查。选项 `"disable"` `"enable"`
source_ip 别名：source-ip 字符串	源IP。
source_ip_interface 别名：source-ip-interface 任意	(列表) 与LDAP服务器通信的源接口。
source_port 别名：source-port 整数	用于与LDAP服务器通信的源端口。
ssl_max_proto_version 别名：ssl-max-proto-version 字符串	SSL最大协议版本。选项 `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1"` `"TLSv1-3"`
ssl_min_proto_version 别名：ssl-min-proto-version 字符串	SSL最小协议版本。选项 `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
status_ttl 别名：status-ttl 整数	服务器可达性缓存时间，当服务器不可达时，至少在…之前不会重试。
tertiary_server 别名：tertiary-server 字符串	第三台服务器。
two_factor 别名：two-factor 字符串	双因素认证。选项 `"disable"` `"fortitoken-cloud"`
two_factor_authentication 别名：two-factor-authentication 字符串	双因素认证。选项 `"fortitoken"` `"email"` `"sms"`
two_factor_filter 别名：two-factor-filter 字符串	用于将用户同步到FortiToken Cloud的过滤器。
two_factor_notification 别名：two-factor-notification 字符串	双因素通知。选项 `"email"` `"sms"`
type 字符串	类型。选项 `"simple"` `"anonymous"` `"regular"`
user_info_exchange_server 别名：user-info-exchange-server 字符串	用户信息交换服务器。
username 字符串	用户名。
group_filter 别名：group-filter 字符串	用于组匹配的过滤器。
group_member_check 别名：group-member-check 字符串	组成员检查方法。选项 `"user-attr"` `"group-object"` `"posix-group-object"`
group_object_filter 别名：group-object-filter 字符串	用于组搜索的过滤器。
group_object_search_base 别名：group-object-search-base 字符串	用于组搜索的搜索基础。
group_search_base 别名：group-search-base 字符串	用于组搜索的搜索基础。
interface 字符串	指定到达服务器的出站接口。
interface_select_method 别名：interface-select-method 字符串	指定如何选择到达服务器的出站接口。选项 `"auto"` `"sdwan"` `"specify"`
member_attr 别名：member-attr 字符串	从中获取组成员资格的属性名称。
name 字符串 / 必需	LDAP服务器条目名称。
obtain_user_info 别名：obtain-user-info 字符串	启用/禁用获取用户信息。选项 `"disable"` `"enable"`
password 任意	(列表) 初始绑定的密码。
password_attr 别名：password-attr 字符串	获取密码哈希的属性名称。
password_expiry_warning 别名：password-expiry-warning 字符串	启用/禁用密码过期警告。选项 `"disable"` `"enable"`
password_renewal 别名：password-renewal 字符串	启用/禁用在线密码更新。选项 `"disable"` `"enable"`
port 整数	用于与LDAP服务器通信的端口
search_type 别名：search-type 列表 / 元素=字符串	搜索类型。选项 `"nested"` `"recursive"`
secondary_server 别名：secondary-server 字符串	辅助LDAP服务器CN域名或IP。
secure 字符串	用于身份验证的端口。选项 `"disable"` `"starttls"` `"ldaps"`
server 字符串	LDAP服务器CN域名或IP。
server_identity_check 别名：server-identity-check 字符串	启用/禁用LDAP服务器身份检查选项 `"disable"` `"enable"`
source_ip 别名：source-ip 字符串	与LDAP服务器通信的源IP。
source_ip_interface 别名：source-ip-interface 任意	(列表) 与LDAP服务器通信的源接口。
source_port 别名：source-port 整数	用于与LDAP服务器通信的源端口。
ssl_min_proto_version 别名：ssl-min-proto-version 字符串	SSL/TLS连接支持的最小协议版本选项 `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
status_ttl 别名：status-ttl 整数	服务器可达性缓存时间，当服务器不可达时，至少在…之前不会重试。
tertiary_server 别名：tertiary-server 字符串	第三台LDAP服务器CN域名或IP。
two_factor 别名：two-factor 字符串	启用/禁用双因素身份验证。选项 `"disable"` `"fortitoken-cloud"`
two_factor_authentication 别名：two-factor-authentication 字符串	FortiToken Cloud的身份验证方法。选项 `"fortitoken"` `"email"` `"sms"`
two_factor_filter 别名：two-factor-filter 字符串	用于将用户同步到FortiToken Cloud的过滤器。
two_factor_notification 别名：two-factor-notification 字符串	FortiToken Cloud用户激活的通知方法。选项 `"email"` `"sms"`
type 字符串	LDAP搜索的身份验证类型。选项 `"simple"` `"anonymous"` `"regular"`
user_info_exchange_server 别名：user-info-exchange-server 字符串	从中获取用户信息的MS Exchange服务器。
username 字符串	用户名
workspace_locking_adom 字符串	在工作区模式下运行的FortiManager要锁定的ADOM，值可以是global和其他包括root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁定的最大时间（秒）。默认值： `300`

备注 

注意

从2.4.0版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以在ansible.cfg中设置deprecation_warnings=False来忽略此警告。
此FortiManager模块支持在工作区锁定模式下运行，顶级参数workspace_locking_adom和workspace_locking_timeout有助于完成此工作。
要创建或更新对象，请使用state present指令。
要删除对象，请使用state absent指令。
通常，当返回非零rc时，运行一个模块可能会失败。您还可以使用参数rc_failed和rc_succeeded覆盖失败或成功的条件。

示例 

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure LDAP server entries.
      fortinet.fortimanager.fmgr_user_ldap:
        bypass_validation: false
        adom: ansible
        state: present
        user_ldap:
          dn: ansible-test
          name: ansible-test-ldap
          password: fortinet
          port: 9000
          server: ansible

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the LDAP server entries
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_ldap"
          params:
            adom: "ansible"
            ldap: "your_value"

返回值 

常用返回值已在此处记录，以下是此模块特有的字段

键	描述
meta 字典	请求的结果。返回：始终
request_url 字符串	请求的完整URL。返回：始终示例： `"/sys/login/user"`
response_code 整数	API请求的状态。返回：始终示例： `0`
response_data 列表 / 元素=字符串	API响应。返回：始终
response_message 字符串	API响应的描述性消息。返回：始终示例： `"OK."`
system_information 字典	目标系统的信息。返回：始终
rc 整数	请求的状态。返回：始终示例： `0`
version_check_warning 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则发出警告。返回：复杂

作者

杜欣伟 (@dux-fortinet)
李兴 (@lix-fortinet)
薛杰 (@JieX19)
郑林 (@chillancezen)
沈峰 (@fshen01)
卢洪斌 (@fgtdev-hblu)