fortinet.fortimanager.fmgr_user_domaincontroller 模块 – 配置域控制器条目。

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_user_domaincontroller。

fortinet.fortimanager 2.1.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_domaincontroller

字典

顶级参数集。

ad_mode

别名: ad-mode

字符串

设置 Active Directory 模式。

选择

  • "none"

  • "ds"

  • "lds"

adlds_dn

别名: adlds-dn

字符串

AD LDS 专有名称。

adlds_ip6

别名: adlds-ip6

字符串

AD LDS IPv6 地址。

adlds_ip_address

别名: adlds-ip-address

字符串

AD LDS IPv4 地址。

adlds_port

别名: adlds-port

整数

AD LDS 服务的端口号

change_detection

别名: change-detection

字符串

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

选择

  • "disable"

  • "enable"

change_detection_period

别名: change-detection-period

整数

检测 Active Directory 服务器中配置更改的分钟数

dns_srv_lookup

别名: dns-srv-lookup

字符串

启用/禁用 DNS 服务查找。

选择

  • "disable"

  • "enable"

domain_name

别名: domain-name

字符串

域 DNS 名称。

extra_server

别名: extra-server

列表 / 元素=字典

额外服务器。

id

整数

服务器 ID。

ip_address

别名: ip-address

字符串

域控制器 IP 地址。

port

整数

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

source_ip_address

别名: source-ip-address

字符串

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

source_port

别名: source-port

整数

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

hostname

字符串

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

interface

字符串

指定到达服务器的传出接口。

interface_select_method

别名: interface-select-method

字符串

指定如何选择到达服务器的传出接口。

选择

  • "auto"

  • "sdwan"

  • "specify"

ip6

字符串

域控制器 IPv6 地址。

ip_address

别名: ip-address

字符串

域控制器 IP 地址。

ldap_server

别名: ldap-server

任意

(列表或字符串) LDAP 服务器名称。

name

字符串 / 必需

域控制器条目名称。

password

任意

(列表) 指定用户名的密码。

port

整数

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

replication_port

别名: replication-port

整数

用于与域控制器通信以进行复制服务的端口。

source_ip6

别名: source-ip6

字符串

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

source_ip_address

别名: source-ip-address

字符串

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

source_port

别名: source-port

整数

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

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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure domain controller entries.
      fortinet.fortimanager.fmgr_user_domaincontroller:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        user_domaincontroller:
          domain_name: <string>
          extra_server:
            -
              id: <integer>
              ip_address: <string>
              port: <integer>
              source_ip_address: <string>
              source_port: <integer>
          ip_address: <string>
          ldap_server: <list or string>
          name: <string>
          port: <integer>
          ad_mode: <value in [none, ds, lds]>
          adlds_dn: <string>
          adlds_ip_address: <string>
          adlds_ip6: <string>
          adlds_port: <integer>
          dns_srv_lookup: <value in [disable, enable]>
          hostname: <string>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          ip6: <string>
          password: <list or string>
          replication_port: <integer>
          source_ip_address: <string>
          source_ip6: <string>
          source_port: <integer>
          username: <string>
          change_detection: <value in [disable, enable]>
          change_detection_period: <integer>

返回值

常见的返回值记录在这里，以下是此模块独有的字段

键

描述

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

列表 / 元素=字符串

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)