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

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortimanager.fmgr_user_ldap_dynamicmapping。

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 客户端进行身份验证。

ldap

字符串 / 必需

请求的 URL 中的参数 (ldap)。

proposed_method

字符串

用于底层 Json RPC 请求的重写方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

user_ldap_dynamicmapping

字典

设置的顶层参数。

_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

字符串

Cnid。

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_attr

别名: password-attr

字符串

用于获取密码哈希的属性名称。

password_expiry_warning

别名: password-expiry-warning

字符串

密码过期警告。

选项

  • "disable"

  • "enable"

password_renewal

别名: password-renewal

字符串

密码更新。

选项

  • "disable"

  • "enable"

端口

整数

端口。

retrieve_protection_profile

别名: retrieve-protection-profile

字符串

检索保护配置文件。

search_type

别名: search-type

列表 / 元素=字符串

搜索类型。

选项

  • "nested"

  • "recursive"

secondary_server

别名: secondary-server

字符串

备用服务器。

安全

字符串

安全。

选项

  • "disable"

  • "starttls"

  • "ldaps"

服务器

字符串

服务器。

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"

类型

字符串

类型。

选项

  • "simple"

  • "anonymous"

  • "regular"

user_info_exchange_server

别名: user-info-exchange-server

字符串

用户信息交换服务器。

用户名

字符串

用户名。

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 dynamic mappings of LDAP server
      fortinet.fortimanager.fmgr_user_ldap_dynamicmapping:
        bypass_validation: false
        adom: ansible
        ldap: ansible-test-ldap # name
        state: present
        user_ldap_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          dn: ansible-test-dn
          password: fortinet
          port: 9000
          server: ansible
          username: ansible-test-dyn

- 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 dynamic mappings of LDAP server
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_ldap_dynamicmapping"
          params:
            adom: "ansible"
            ldap: "ansible-test-ldap" # name
            dynamic_mapping: "your_value"

返回值

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

键

描述

元数据

字典

请求的结果。

返回: 总是

request_url

字符串

请求的完整 URL。

返回: 总是

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 总是

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回: 总是

response_message

字符串

API 响应的描述性消息。

返回: 总是

示例: "OK."

system_information

字典

目标系统的信息。

返回: 总是

rc

整数

请求的状态。

返回: 总是

示例: 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)