fortinet.fortios.fortios_endpoint_control_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiClient 端点控制配置文件。
注意
此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定： fortinet.fortios.fortios_endpoint_control_profile。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改 endpoint_control 功能和配置文件类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整为数据源。在 FOS v6.0.0 上测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 FortiGate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选项
|
|
配置 FortiClient 端点控制配置文件。 |
|
描述。 |
|
设备组。 |
|
来自可用选项的设备组对象。来源 user.device-group.name user.device-category.name。 |
|
Android 平台的 FortiClient 设置。 |
|
在 FortiGate 保护时启用/禁用 FortiClient Web 类别过滤。 选项
|
|
启用/禁用高级 FortiClient VPN 配置。 选项
|
|
高级 FortiClient VPN 配置。 |
|
启用/禁用 FortiClient VPN 配置。 选项
|
|
FortiClient VPN 设置。 |
|
身份验证方法。 选项
|
|
VPN 名称。 |
|
PSK 身份验证的预共享密钥。 |
|
远程 VPN 网关的 IP 地址或 FQDN。 |
|
SSL VPN 访问端口 (1 - 65535)。 |
|
启用/禁用要求 SSL VPN 客户端证书。 选项
|
|
VPN 类型 (IPsec 或 SSL VPN)。 选项
|
|
启用/禁用 FortiClient Web 过滤。 选项
|
|
要应用的 FortiClient Web 过滤器配置文件。来源 webfilter.profile.name。 |
|
iOS 平台的 FortiClient 设置。 |
|
FortiClient VPN 配置。 选项
|
|
FortiClient VPN 设置。 |
|
身份验证方法。 选项
|
|
VPN 名称。 |
|
PSK 身份验证的预共享密钥。 |
|
远程 VPN 网关的 IP 地址或 FQDN。 |
|
SSL VPN 访问端口 (1 - 65535)。 |
|
启用/禁用要求 SSL VPN 客户端证书。 选项
|
|
VPN 类型 (IPsec 或 SSL VPN)。 选项
|
|
VPN 配置的内容。 |
|
VPN 配置的名称。 |
|
配置配置文件的内容。 |
|
配置配置文件的名称。 |
|
在 FortiGate 保护时启用/禁用 FortiClient Web 类别过滤。 选项
|
|
启用/禁用配置文件 (.mobileconfig 文件) 分发。 选项
|
|
启用/禁用 FortiClient Web 过滤。 选项
|
|
要应用的 FortiClient Web 过滤器配置文件。来源 webfilter.profile.name。 |
|
Windows/Mac 平台的 FortiClient 设置。 |
|
启用/禁用 FortiClient 防病毒实时保护。 选项
|
|
启用/禁用 FortiClient AV 签名更新。 选项
|
|
启用/禁用 FortiClient 应用防火墙。 选项
|
|
FortiClient 应用防火墙规则列表。来源 application.list.name。 |
|
启用/禁用 FortiClient 防病毒扫描。 选项
|
|
启用/禁用 FortiClient 企业管理服务器 (EMS) 合规性。 选项
|
|
FortiClient EMS 合规性操作。 选项
|
|
FortiClient EMS 条目。 |
|
FortiClient EMS 名称。来源 endpoint-control.forticlient-ems.name。 |
|
最低 FortiClient Linux 版本。 |
|
启用/禁用上传 FortiClient 日志。 选项
|
|
选择要上传的 FortiClient 日志。 选项
|
|
要上传 FortiClient 日志的服务器的 IP 地址或 FQDN。 |
|
最低 FortiClient Mac OS 版本。 |
|
启用/禁用要求客户端运行具有最低软件版本号的 FortiClient。 选项
|
|
FortiClient 操作系统。 |
|
操作系统条目 ID。参见 <a href=’#notes’>注释</a>。 |
|
自定义操作系统名称或 Mac OS 格式：x.x.x |
|
操作系统类型。 选项
|
|
检查FortiClient应用程序的路径和文件名。 |
|
文件路径和名称。 |
|
文件ID。参见 注释。 |
|
FortiClient注册合规性操作。 选项
|
|
FortiClient注册表项。 |
|
注册表项ID。参见 注释。 |
|
注册表项。 |
|
使用FortiClient验证客户端上是否正在运行列出的应用程序。 |
|
应用程序名称。 |
|
应用程序的SHA256签名。 |
|
应用程序的SHA256签名。 |
|
应用程序的SHA256签名。 |
|
应用程序的SHA256签名。 |
|
应用程序检查规则。 选项
|
|
应用程序ID。参见 注释。 |
|
进程名称。 |
|
进程名称。 |
|
进程名称。 |
|
进程名称。 |
|
启用/禁用FortiClient安全态势检查选项。 选项
|
|
FortiClient安全态势合规性操作。 选项
|
|
启用/禁用FortiClient系统合规性的强制执行。 选项
|
|
阻止或警告不符合FortiClient要求的客户端。 选项
|
|
启用/禁用FortiClient漏洞扫描。 选项
|
|
FortiClient漏洞合规性操作。 选项
|
|
配置导致FortiClient漏洞合规性操作的发现漏洞的级别。 选项
|
|
FortiClient漏洞扫描强制执行宽限期（0-30天）。 |
|
启用/禁用对无法自动修补的漏洞的合规性豁免。 选项
|
|
启用/禁用 FortiClient Web 过滤。 选项
|
|
要应用的 FortiClient Web 过滤器配置文件。来源 webfilter.profile.name。 |
|
最低FortiClient Windows版本。 |
|
启用/禁用检查操作系统识别的杀毒软件。 选项
|
|
FortiSandbox地址。 |
|
启用/禁用将文件发送到FortiSandbox进行分析。 选项
|
|
内网检测地址。 |
|
来自可用选项的地址对象。来源：firewall.address.name firewall.addrgrp.name。 |
|
配置文件名称。 |
|
从可用选项中选择端点控制替换消息覆盖组。来源：system.replacemsg-group.name。 |
|
源地址。 |
|
来自可用选项的地址对象。来源：firewall.address.name firewall.addrgrp.name。 |
|
用户组。 |
|
用户组名称。来源：user.group.name。 |
|
用户。 |
|
用户名。来源：user.local.name。 |
|
要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标有member_path的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 指定member_state时，将忽略state选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
虚拟域，在之前定义的虚拟域中。vdom是FortiGate的虚拟实例，可以将其配置和用作不同的单元。 默认值： |
注释
注意
旧版fortiosapi已弃用，httpapi是运行剧本的首选方式。
该模块支持check_mode。
示例
- name: Configure FortiClient endpoint control profiles.
fortinet.fortios.fortios_endpoint_control_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
endpoint_control_profile:
description: "<your_own_value>"
device_groups:
-
name: "default_name_5 (source user.device-group.name user.device-category.name)"
forticlient_android_settings:
disable_wf_when_protected: "enable"
forticlient_advanced_vpn: "enable"
forticlient_advanced_vpn_buffer: "<your_own_value>"
forticlient_vpn_provisioning: "enable"
forticlient_vpn_settings:
-
auth_method: "psk"
name: "default_name_13"
preshared_key: "<your_own_value>"
remote_gw: "<your_own_value>"
sslvpn_access_port: "32767"
sslvpn_require_certificate: "enable"
type: "ipsec"
forticlient_wf: "enable"
forticlient_wf_profile: "<your_own_value> (source webfilter.profile.name)"
forticlient_ios_settings:
client_vpn_provisioning: "enable"
client_vpn_settings:
-
auth_method: "psk"
name: "default_name_25"
preshared_key: "<your_own_value>"
remote_gw: "<your_own_value>"
sslvpn_access_port: "32767"
sslvpn_require_certificate: "enable"
type: "ipsec"
vpn_configuration_content: "<your_own_value>"
vpn_configuration_name: "<your_own_value>"
configuration_content: "<your_own_value>"
configuration_name: "<your_own_value>"
disable_wf_when_protected: "enable"
distribute_configuration_profile: "enable"
forticlient_wf: "enable"
forticlient_wf_profile: "<your_own_value> (source webfilter.profile.name)"
forticlient_winmac_settings:
av_realtime_protection: "enable"
av_signature_up_to_date: "enable"
forticlient_application_firewall: "enable"
forticlient_application_firewall_list: "<your_own_value> (source application.list.name)"
forticlient_av: "enable"
forticlient_ems_compliance: "enable"
forticlient_ems_compliance_action: "block"
forticlient_ems_entries:
-
name: "default_name_48 (source endpoint-control.forticlient-ems.name)"
forticlient_linux_ver: "<your_own_value>"
forticlient_log_upload: "enable"
forticlient_log_upload_level: "traffic"
forticlient_log_upload_server: "<your_own_value>"
forticlient_mac_ver: "<your_own_value>"
forticlient_minimum_software_version: "enable"
forticlient_operating_system:
-
id: "56"
os_name: "<your_own_value>"
os_type: "custom"
forticlient_own_file:
-
file: "<your_own_value>"
id: "61"
forticlient_registration_compliance_action: "block"
forticlient_registry_entry:
-
id: "64"
registry_entry: "<your_own_value>"
forticlient_running_app:
-
app_name: "<your_own_value>"
app_sha256_signature: "<your_own_value>"
app_sha256_signature2: "<your_own_value>"
app_sha256_signature3: "<your_own_value>"
app_sha256_signature4: "<your_own_value>"
application_check_rule: "present"
id: "73"
process_name: "<your_own_value>"
process_name2: "<your_own_value>"
process_name3: "<your_own_value>"
process_name4: "<your_own_value>"
forticlient_security_posture: "enable"
forticlient_security_posture_compliance_action: "block"
forticlient_system_compliance: "enable"
forticlient_system_compliance_action: "block"
forticlient_vuln_scan: "enable"
forticlient_vuln_scan_compliance_action: "block"
forticlient_vuln_scan_enforce: "critical"
forticlient_vuln_scan_enforce_grace: "15"
forticlient_vuln_scan_exempt: "enable"
forticlient_wf: "enable"
forticlient_wf_profile: "<your_own_value> (source webfilter.profile.name)"
forticlient_win_ver: "<your_own_value>"
os_av_software_installed: "enable"
sandbox_address: "<your_own_value>"
sandbox_analysis: "enable"
on_net_addr:
-
name: "default_name_94 (source firewall.address.name firewall.addrgrp.name)"
profile_name: "<your_own_value>"
replacemsg_override_group: "<your_own_value> (source system.replacemsg-group.name)"
src_addr:
-
name: "default_name_98 (source firewall.address.name firewall.addrgrp.name)"
user_groups:
-
name: "default_name_100 (source user.group.name)"
users:
-
name: "default_name_102 (source user.local.name)"
返回值
常用返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
FortiGate镜像的版本号 返回值：始终 示例： |
|
上次用于将内容置入FortiGate的方法 返回值：始终 示例： |
|
FortiGate在上次应用的操作中给出的最后结果 返回值：始终 示例： |
|
上次调用FortiGate时使用的主密钥(ID) 返回值：成功 示例： |
|
用于完成请求的表的名称 返回值：始终 示例： |
|
用于完成请求的表的路径 返回值：始终 示例： |
|
内部修订号 返回值：始终 示例： |
|
设备的序列号 返回值：始终 示例： |
|
操作结果的指示 返回值：始终 示例： |
|
使用的虚拟域 返回值：始终 示例： |
|
FortiGate的版本 返回值：始终 示例： |