fortinet.fortios.fortios_endpoint_control_fctems 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiClient 企业管理服务器 (EMS) 条目。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
endpoint_control_fctems 字典	配置 FortiClient 企业管理服务器 (EMS) 条目。
admin_password 字符串	FortiClient EMS 管理员密码。
admin_username 字符串	FortiClient EMS 管理员用户名。
call_timeout 整数	FortiClient EMS 调用超时时间（以秒为单位）（1-180 秒）。
capabilities 列表 / 元素=字符串	EMS 功能列表。 选项 "fabric-auth" "silent-approval" "websocket" "websocket-malware" "push-ca-certs" "common-tags-api" "tenant-id" "client-avatars" "single-vdom-connector" "fgt-sysinfo-api" "ztna-server-info"
certificate 字符串	FortiClient EMS 证书。源证书。remote.name。
cloud_authentication_access_key 字符串	FortiClient EMS 云多租户访问密钥
cloud_server_type 字符串	云服务器类型。 选项 "production" "alpha" "beta"
dirty_reason 字符串	FortiClient EMS 的脏原因。 选项 "none" "mismatched-ems-sn"
ems_id 整数 / 必填	EMS ID 按顺序排列 (1-7)。请参阅 注释。
fortinetone_cloud_authentication 字符串	启用/禁用通过 FortiCloud 帐户对 FortiClient EMS 云进行身份验证。 选项 "enable" "disable"
https_port 整数	FortiClient EMS HTTPS 访问端口号。(1-65535)。
interface 字符串	指定到达服务器的出站接口。源 system.interface.name。
interface_select_method 字符串	指定如何选择到达服务器的出站接口。 选项 "auto" "sdwan" "specify"
name 字符串	FortiClient 企业管理服务器 (EMS) 名称。
out_of_sync_threshold 整数	过时的资源阈值（以秒为单位）（10-3600）。
preserve_ssl_session 字符串	启用/禁用 EMS SSL 会话连接的保留。警告，大多数用户不应更改此设置。 选项 "enable" "disable"
pull_avatars 字符串	启用/禁用从 EMS 拉取头像。 选项 "enable" "disable"
pull_malware_hash 字符串	启用/禁用从 EMS 拉取 FortiClient 恶意软件哈希值。 选项 "enable" "disable"
pull_sysinfo 字符串	启用/禁用从 EMS 拉取系统信息。 选项 "enable" "disable"
pull_tags 字符串	启用/禁用从 EMS 拉取 FortiClient 用户标签。 选项 "enable" "disable"
pull_vulnerabilities 字符串	启用/禁用从 EMS 拉取漏洞。 选项 "enable" "disable"
send_tags_to_all_vdoms 字符串	放宽对标签的限制，将所有 EMS 标签发送到所有 VDOM。 选项 "enable" "disable"
serial_number 字符串	EMS 序列号。
server 字符串	FortiClient EMS FQDN 或 IPv4 地址。
source_ip 字符串	REST API 调用源 IP。
status 字符串	启用或禁用此 EMS 配置。 选项 "enable" "disable"
status_check_interval 整数	FortiClient EMS 调用超时时间（以秒为单位）（1-120 秒）。
tenant_id 字符串	EMS 租户 ID。
trust_ca_cn 字符串	启用/禁用信任 EMS 证书颁发机构 (CA) 和公共名称 (CN) 以进行证书自动续订。 选项 "enable" "disable"
verifying_ca 字符串	FortiGate 中已验证 EMS 证书链中的最低 CA 证书。源 certificate.ca.name vpn.certificate.ca.name。
websocket_override 字符串	启用/禁用此 FortiGate 单元如何使用 WebSocket 连接连接到 EMS 的覆盖行为。 选项 "enable" "disable"
member_path 字符串	要操作的成员属性路径。 如果有多个属性，则以斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项 "present" "absent"
state 字符串 / 必填	指示是创建还是删除对象。 选项 "present" "absent"
vdom 字符串	虚拟域，属于之前定义的那些域。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认值： "root"

注释

注意

• 强烈建议使用您自己的值作为ems_id，而不是0。虽然‘0’是一个特殊的占位符，允许后端为对象分配最新的可用编号，但它也有一定的限制。更多详情请见问答。

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

• 该模块支持 check_mode。

示例

- name: Configure FortiClient Enterprise Management Server (EMS) entries.
  fortinet.fortios.fortios_endpoint_control_fctems:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      endpoint_control_fctems:
          admin_password: "<your_own_value>"
          admin_username: "<your_own_value>"
          call_timeout: "30"
          capabilities: "fabric-auth"
          certificate: "<your_own_value> (source certificate.remote.name)"
          cloud_authentication_access_key: "<your_own_value>"
          cloud_server_type: "production"
          dirty_reason: "none"
          ems_id: "<you_own_value>"
          fortinetone_cloud_authentication: "enable"
          https_port: "443"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          name: "default_name_16"
          out_of_sync_threshold: "180"
          preserve_ssl_session: "enable"
          pull_avatars: "enable"
          pull_malware_hash: "enable"
          pull_sysinfo: "enable"
          pull_tags: "enable"
          pull_vulnerabilities: "enable"
          send_tags_to_all_vdoms: "enable"
          serial_number: "<your_own_value>"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          status: "enable"
          status_check_interval: "90"
          tenant_id: "<your_own_value>"
          trust_ca_cn: "enable"
          verifying_ca: "<your_own_value> (source certificate.ca.name vpn.certificate.ca.name)"
          websocket_override: "enable"

返回值

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

键	描述
build 字符串	FortiGate镜像的版本号 返回：始终 示例： "1547"
http_method 字符串	上次用于将内容置备到 FortiGate 的方法 返回：始终 示例： "PUT"
http_status 字符串	FortiGate 在上次应用的操作中给出的最后结果 返回：始终 示例： "200"
mkey 字符串	上次调用 FortiGate 时使用的主密钥 (id) 返回：成功 示例： "id"
name 字符串	用于完成请求的表的名称 返回：始终 示例： "urlfilter"
path 字符串	用于完成请求的表的路径 返回：始终 示例： "webfilter"
revision 字符串	内部修订号 返回：始终 示例： "17.0.2.10658"
serial 字符串	设备的序列号 返回：始终 示例： "FGVMEVYYQT3AB5352"
status 字符串	操作结果的指示 返回：始终 示例： "success"
vdom 字符串	使用的虚拟域 返回：始终 示例： "root"
version 字符串	FortiGate 的版本 返回：始终 示例： "v5.6.3"

作者

• 郑琳 (@chillancezen)

• 薛杰 (@JieX19)

• 陆洪斌 (@fgtdev-hblu)

• 沈峰 (@frankshen01)

• 米格尔·安吉尔·穆诺斯 (@mamunozgonzalez)

• 尼古拉斯·托马斯 (@thomnico)

资源链接

• 问题追踪器
• 主页
• 代码库 (源代码)