fortinet.fortios.fortios_icap_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 ICAP 配置文件。
注意
此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要更多要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定： fortinet.fortios.fortios_icap_profile。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改 icap 功能和配置文件类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整到数据源。已在 FOS v6.0.0 版本上测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选项
|
|
配置 ICAP 配置文件。 |
|
启用/禁用分块封装。 选项
|
|
注释。 |
|
启用/禁用 ICAP 扩展功能。 选项
|
|
配置文件传输协议，将传输的文件作为 REQMOD 传递到 ICAP 服务器。 选项
|
|
处理文件传输时无法联系 ICAP 服务器时要采取的操作。 选项
|
|
标识文件传输处理服务的 ICAP URI 的路径组件。 |
|
用于文件传输的 ICAP 服务器。来源 icap.server.name icap.server-group.name。 |
|
发现感染时启用/禁用 UTM 日志。 选项
|
|
配置 ICAP 转发的请求头。 |
|
启用/禁用 HTTP 内容的 base64 编码。 选项
|
|
HTTP 头内容。 |
|
HTTP 转发头 ID。参见 备注。 |
|
HTTP 转发头名称。 |
|
将发送到 ICAP 服务器以进行进一步处理的允许的 HTTP 方法。 选项
|
|
ICAP 配置文件名称。 |
|
启用/禁用对 ICAP 服务器的数据预览。 选项
|
|
要发送到 ICAP 服务器的预览数据长度。 |
|
替换消息组。来源 system.replacemsg-group.name。 |
|
启用/禁用是否将 HTTP 请求传递到 ICAP 服务器。 选项
|
|
处理 HTTP 请求时无法联系 ICAP 服务器时要采取的操作。 选项
|
|
标识 HTTP 请求处理服务的 ICAP URI 的路径组件。 |
|
用于 HTTP 请求的 ICAP 服务器。来源 icap.server.name icap.server-group.name。 |
|
对 ICAP 响应修改 (respmod) 处理的默认操作。 选项
|
|
ICAP 响应模式转发规则。 |
|
对 ICAP 服务器要采取的操作。 选项
|
|
HTTP 头组。 |
|
启用/禁用匹配头时区分大小写。 选项
|
|
HTTP 头正则表达式。 |
|
HTTP 头。 |
|
ID。参见 备注。 |
|
主机的地址对象。来源 firewall.address.name firewall.addrgrp.name firewall.proxy-address.name。 |
|
HTTP 响应状态代码。 |
|
HTTP 响应状态代码。参见 备注。 |
|
地址名称。 |
|
启用/禁用是否将 HTTP 响应传递到 ICAP 服务器。 选项
|
|
启用/禁用允许 ICAP 服务器返回 204 响应。 选项
|
|
处理 HTTP 响应时无法联系 ICAP 服务器时要采取的操作。 选项
|
|
标识 HTTP 响应处理服务的 ICAP URI 的路径组件。 |
|
启用/禁用为 ICAP 响应修改 (respmod) 处理添加 req-hdr。 选项
|
|
用于 HTTP 响应的 ICAP 服务器。来源 icap.server.name icap.server-group.name。 |
|
扫描进度间隔值。 |
|
ICAP 客户端以兆字节 (1 - 10) 保存的 204 响应大小限制。 |
|
启用/禁用绕过 ICAP 服务器的流内容。 选项
|
|
ICAP 客户端等待 ICAP 服务器响应的时间（以秒为单位）。 |
|
要操作的成员属性路径。 如果有多个属性，则以斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
虚拟域，属于之前定义的那些域。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认值： |
注释
注意
旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方法。
该模块支持 check_mode。
示例
- name: Configure ICAP profiles.
fortinet.fortios.fortios_icap_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
icap_profile:
response_204: "disable"
size_limit_204: "1"
chunk_encap: "disable"
comment: "Comment."
extension_feature: "scan-progress"
file_transfer: "ssh"
file_transfer_failure: "error"
file_transfer_path: "<your_own_value>"
file_transfer_server: "<your_own_value> (source icap.server.name icap.server-group.name)"
icap_block_log: "disable"
icap_headers:
-
base64_encoding: "disable"
content: "<your_own_value>"
id: "16"
name: "default_name_17"
methods: "delete"
name: "default_name_19"
preview: "disable"
preview_data_length: "0"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
request: "disable"
request_failure: "error"
request_path: "<your_own_value>"
request_server: "<your_own_value> (source icap.server.name icap.server-group.name)"
respmod_default_action: "forward"
respmod_forward_rules:
-
action: "forward"
header_group:
-
case_sensitivity: "disable"
header: "<your_own_value>"
header_name: "<your_own_value>"
id: "34"
host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name)"
http_resp_status_code:
-
code: "<you_own_value>"
name: "default_name_38"
response: "disable"
response_failure: "error"
response_path: "<your_own_value>"
response_req_hdr: "disable"
response_server: "<your_own_value> (source icap.server.name icap.server-group.name)"
scan_progress_interval: "10"
streaming_content_bypass: "disable"
timeout: "30"
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
FortiGate 镜像的版本号 返回：始终 示例： |
|
上次用于将内容置备到 FortiGate 的方法 返回：始终 示例： |
|
FortiGate 在上次应用的操作中给出的最后结果 返回：始终 示例： |
|
上次调用 FortiGate 时使用的主密钥 (ID) 返回：成功 示例： |
|
用于满足请求的表的名称 返回：始终 示例： |
|
用于满足请求的表的路径 返回：始终 示例： |
|
内部修订号 返回：始终 示例： |
|
设备的序列号 返回：始终 示例： |
|
操作结果的指示 返回：始终 示例： |
|
使用的虚拟域 返回：始终 示例： |
|
FortiGate 的版本 返回：始终 示例： |