fortinet.fortios.fortios_user_domain_controller 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置域控制器条目。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_user_domain_controller。

在 fortinet.fortios 2.0.0 中新增

概要

  • 此模块能够通过允许用户设置和修改用户特性和 domain_controller 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值，需要在使用前调整为数据源。使用 FOS v6.0.0 测试。

要求

在执行此模块的主机上需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ←（默认）

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标记为 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

当指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

user_domain_controller

字典

配置域控制器条目。

ad_mode

字符串

设置 Active Directory 模式。

选项

  • "none"

  • "ds"

  • "lds"

adlds_dn

字符串

AD LDS 专有名称。

adlds_ip6

字符串

AD LDS IPv6 地址。

adlds_ip_address

字符串

AD LDS IPv4 地址。

adlds_port

整数

AD LDS 服务的端口号。

change_detection

字符串

启用/禁用 Active Directory 服务器中配置更改的检测。

选项

  • "enable"

  • "disable"

change_detection_period

整数

检测 Active Directory 服务器中配置更改的分钟数（5 - 10080 分钟（7 天））。

dns_srv_lookup

字符串

启用/禁用 DNS 服务查找。

选项

  • "enable"

  • "disable"

domain_name

字符串

域 DNS 名称。

extra_server

列表 / elements=字典

额外服务器。

id

整数 / 必需

服务器 ID。请参阅 <a href=’#notes’>注释</a>。

ip_address

字符串

域控制器 IP 地址。

port

整数

用于与域控制器通信的端口。

source_ip_address

字符串

用于与域控制器通信的 FortiGate IPv4 地址。

source_port

整数

用于与域控制器通信的源端口。

hostname

字符串

要连接的服务器的主机名。

interface

字符串

指定用于连接服务器的传出接口。源 system.interface.name。

interface_select_method

字符串

指定如何选择用于连接服务器的传出接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

ip6

字符串

域控制器 IPv6 地址。

ip_address

字符串

域控制器 IPv4 地址。

ldap_server

列表 / elements=字典

LDAP 服务器名称。源 user.ldap.name。

name

字符串 / 必需

LDAP 服务器名称。源 user.ldap.name。

name

字符串 / 必需

域控制器条目名称。

password

字符串

指定用户名的密码。

port

整数

用于与域控制器通信的端口。

replication_port

整数

用于与域控制器通信以进行复制服务的端口。端口号 0 表示自动发现。

source_ip6

字符串

用于与域控制器通信的 FortiGate IPv6 地址。

source_ip_address

字符串

用于与域控制器通信的 FortiGate IPv4 地址。

source_port

整数

用于与域控制器通信的源端口。

username

字符串

用于登录的用户名。必须具有适当的服务权限。

vdom

字符串

之前定义的虚拟域。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。

默认值： "root"

注释

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方式

  • 该模块支持 check_mode。

示例

- name: Configure domain controller entries.
  fortinet.fortios.fortios_user_domain_controller:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_domain_controller:
          ad_mode: "none"
          adlds_dn: "<your_own_value>"
          adlds_ip_address: "<your_own_value>"
          adlds_ip6: "<your_own_value>"
          adlds_port: "389"
          change_detection: "enable"
          change_detection_period: "60"
          dns_srv_lookup: "enable"
          domain_name: "<your_own_value>"
          extra_server:
              -
                  id: "13"
                  ip_address: "<your_own_value>"
                  port: "445"
                  source_ip_address: "<your_own_value>"
                  source_port: "0"
          hostname: "myhostname"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          ip_address: "<your_own_value>"
          ip6: "<your_own_value>"
          ldap_server:
              -
                  name: "default_name_24 (source user.ldap.name)"
          name: "default_name_25"
          password: "<your_own_value>"
          port: "445"
          replication_port: "0"
          source_ip_address: "<your_own_value>"
          source_ip6: "<your_own_value>"
          source_port: "0"
          username: "<your_own_value>"

返回值

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

键

描述

build

字符串

fortigate 映像的版本号

返回： 总是

示例： "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 的方法

返回： 总是

示例： "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果

返回： 总是

示例： "200"

mkey

字符串

在上次调用 FortiGate 时使用的主密钥（id）

返回: 成功

示例: "id"

name

字符串

用于满足请求的表名

返回： 总是

示例: "urlfilter"

路径

字符串

用于满足请求的表的路径

返回： 总是

示例: "webfilter"

修订版本

字符串

内部修订号

返回： 总是

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回： 总是

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

返回： 总是

示例: "success"

vdom

字符串

使用的虚拟域

返回： 总是

示例: "root"

版本

字符串

FortiGate 的版本

返回： 总是

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)