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

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，这些参数和值需要在使用前调整到数据源。

参数

参数

注释

access_token

字符串

用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。

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"

system_admin_ldap

字典

设置的顶级参数。

adom

列表 / 元素=字典

Adom。

adom_name

别名：adom-name

字符串

管理域名称。

adom_access

别名：adom-access

字符串

设置全部或指定 ADOM 访问类型。

all - 所有 ADOM 的访问权限。

specify - 指定 ADOM 的访问权限。

选择

  • "all"

  • "specify"

adom_attr

别名：adom-attr

字符串

用于检索 adom 的属性

attributes

字符串

用于组搜索的属性。

ca_cert

别名：ca-cert

字符串

CA 证书名称。

cnid

字符串

公用名称标识符

connect_timeout

别名：connect-timeout

整数

LDAP 连接超时

dn

字符串

专有名称。

filter

字符串

用于组搜索的过滤器。

group

字符串

用于组搜索的完整基本 DN。

memberof_attr

别名：memberof-attr

字符串

用于检索 memberof 的属性。

name

字符串 / 必需

LDAP 服务器条目名称。

password

任意

（列表）初始绑定的密码。

port

整数

LDAP 服务器的端口号

profile_attr

别名：profile-attr

字符串

用于检索管理配置文件的属性。

secondary_server

别名：secondary-server

字符串

无描述

secure

字符串

SSL 连接。

disable - 无 SSL。

starttls - 使用 StartTLS。

ldaps - 使用 LDAPS。

选择

  • "disable"

  • "starttls"

  • "ldaps"

server

字符串

无描述

ssl_protocol

别名：ssl-protocol

字符串

设置连接到 LDAP 服务器的最低 SSL 协议版本。

follow-global-ssl-protocol - 跟随系统。

sslv3 - 将 SSLv3 设置为最低版本。

tlsv1。

tlsv1。

tlsv1。

tlsv1。

选择

  • "follow-global-ssl-protocol"

  • "sslv3"

  • "tlsv1.0"

  • "tlsv1.1"

  • "tlsv1.2"

  • "tlsv1.3"

tertiary_server

别名：tertiary-server

字符串

无描述

type

字符串

LDAP 绑定的类型。

simple - 无需搜索的简单密码身份验证。

anonymous - 使用匿名用户搜索进行绑定。

regular - 使用用户名/密码绑定，然后进行搜索。

选择

  • "simple"

  • "匿名"

  • "常规"

用户名

字符串

用户名

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: LDAP server entry configuration.
      fortinet.fortimanager.fmgr_system_admin_ldap:
        bypass_validation: false
        state: present
        system_admin_ldap:
          adom:
            - adom-name: ansible
          name: ansible-test-ldap
          password: Fortinet
          port: 390
          server: ansible
          type: regular # <value in [simple, anonymous, regular]>
          username: ansible-username

- 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 servers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_ldap"
          params:
            ldap: "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)