fortinet.fortimanager.fmgr_firewall_profileprotocoloptions 模块 – 配置协议选项。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前调整到数据源的参数和值。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。选项 `false` ←（默认） `true`
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ←（默认） `true`
firewall_profileprotocoloptions 字典	设置的顶级参数。
cifs 字典	Cifs。
domain_controller 别名: domain-controller 字符串	用于解密 CIFS 流量的域。
file_filter 别名: file-filter 字典	文件过滤器。
entries 列表 / 元素=字典	条目。
action 字符串	对匹配文件采取的操作。选项 `"log"` `"block"`
comment 字符串	注释。
direction 字符串	匹配会话发起或回复方向传输的文件。选项 `"any"` `"incoming"` `"outgoing"`
file_type 别名: file-type any	（列表）选择文件类型。
filter 字符串	添加文件过滤器。
protocol 列表 / 元素=字符串	要应用的协议。选项 `"cifs"`
log 字符串	启用/禁用文件过滤器日志记录。选项 `"disable"` `"enable"`
status 字符串	启用/禁用文件过滤器。选项 `"disable"` `"enable"`
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"oversize"`
oversize_limit 别名: oversize-limit 整数	可以扫描的最大内存中文件大小
ports any	（列表）要扫描内容的端口
scan_bzip2 别名: scan-bzip2 字符串	启用/禁用扫描 BZip2 压缩文件。选项 `"disable"` `"enable"`
server_credential_type 别名: server-credential-type 字符串	CIFS 服务器凭据类型。选项 `"none"` `"credential-replication"` `"credential-keytab"`
server_keytab 别名: server-keytab 列表 / 元素=字典	服务器密钥表。
keytab 字符串	包含服务器凭据的 Base64 编码密钥表文件。
password any	（列表）密钥表的密码。
principal 字符串	服务主体。
status 字符串	启用/禁用此协议扫描的活动状态。选项 `"disable"` `"enable"`
tcp_window_maximum 别名: tcp-window-maximum 整数	最大动态 TCP 窗口大小
tcp_window_minimum 别名: tcp-window-minimum 整数	最小动态 TCP 窗口大小
tcp_window_size 别名: tcp-window-size 整数	设置 TCP 静态窗口大小
tcp_window_type 别名: tcp-window-type 字符串	指定用于此协议的 TCP 窗口类型。选项 `"system"` `"static"` `"dynamic"` `"auto-tuning"`
uncompressed_nest_limit 别名: uncompressed-nest-limit 整数	可以解压缩和扫描的最大压缩嵌套级别
uncompressed_oversize_limit 别名: uncompressed-oversize-limit 整数	可以扫描的最大内存中未压缩文件大小
comment 字符串	可选注释。
dns 字典	Dns。
ports any	（列表）要扫描内容的端口
status 字符串	启用/禁用此协议扫描的活动状态。选项 `"disable"` `"enable"`
feature_set 别名: feature-set 字符串	流/代理功能集。选项 `"proxy"` `"flow"`
ftp 字典	Ftp。
comfort_amount 别名: comfort-amount 整数	用于客户端舒适传输的数据量
comfort_interval 别名: comfort-interval 整数	开始、上次传输和下一次客户端舒适传输数据之间的时间间隔
explicit_ftp_tls 别名: explicit-ftp-tls 字符串	启用/禁用显式 FTPS 的 FTP 重定向。选项 `"disable"` `"enable"`
inspect_all 别名: inspect-all 字符串	启用/禁用对协议的所有端口的检查。选项 `"disable"` `"enable"`
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"clientcomfort"` `"no-content-summary"` `"oversize"` `"splice"` `"bypass-rest-command"` `"bypass-mode-command"`
oversize_limit 别名: oversize-limit 整数	可以扫描的最大内存中文件大小
ports any	（列表）要扫描内容的端口
scan_bzip2 别名: scan-bzip2 字符串	启用/禁用扫描 BZip2 压缩文件。选项 `"disable"` `"enable"`
ssl_offloaded 别名: ssl-offloaded 字符串	由外部设备执行的 SSL 解密和加密。选项 `"no"` `"yes"`
status 字符串	启用/禁用此协议扫描的活动状态。选项 `"disable"` `"enable"`
stream_based_uncompressed_limit 别名: stream-based-uncompressed-limit 整数	将扫描的最大基于流的未压缩数据大小
tcp_window_maximum 别名: tcp-window-maximum 整数	最大动态 TCP 窗口大小。
tcp_window_minimum 别名: tcp-window-minimum 整数	最小动态 TCP 窗口大小。
tcp_window_size 别名: tcp-window-size 整数	设置 TCP 静态窗口大小。
tcp_window_type 别名: tcp-window-type 字符串	用于此协议的 TCP 窗口类型。选项 `"system"` `"static"` `"dynamic"` `"auto-tuning"`
uncompressed_nest_limit 别名: uncompressed-nest-limit 整数	可以解压缩和扫描的最大压缩嵌套级别
uncompressed_oversize_limit 别名: uncompressed-oversize-limit 整数	可以扫描的最大内存中未压缩文件大小
http 字典	Http。
address_ip_rating 别名: address-ip-rating 字符串	启用/禁用基于 IP 的 URL 评级。选项 `"disable"` `"enable"`
block_page_status_code 别名: block-page-status-code 整数	被阻止的 HTTP 页面返回的代码编号
comfort_amount 别名: comfort-amount 整数	用于客户端舒适传输的数据量
comfort_interval 别名: comfort-interval 整数	开始、上次传输和下一次客户端舒适传输数据之间的时间间隔
domain_fronting 别名: domain-fronting 字符串	配置 HTTP 域名欺骗选项 `"block"` `"monitor"` `"allow"`
fortinet_bar 别名: fortinet-bar 字符串	在 HTML 内容上启用/禁用 Fortinet 条。选项 `"disable"` `"enable"`
fortinet_bar_port 别名: fortinet-bar-port 整数	Fortinet 条使用的端口
h2c 字符串	启用/禁用 h2c HTTP 连接升级。选项 `"disable"` `"enable"`
http_policy 别名: http-policy 字符串	启用/禁用 HTTP 策略检查。选项 `"disable"` `"enable"`
inspect_all 别名: inspect-all 字符串	启用/禁用对协议的所有端口的检查。选项 `"disable"` `"enable"`
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"oversize"` `"chunkedbypass"` `"clientcomfort"` `"no-content-summary"` `"servercomfort"`
oversize_limit 别名: oversize-limit 整数	可以扫描的最大内存中文件大小
ports any	（列表）要扫描内容的端口
post_lang 别名: post-lang 列表 / 元素=字符串	用于将 HTTP POST 上的禁用词和 DLP 转换为 UTF-8 的字符集 ID 代码选项 `"jisx0201"` `"jisx0208"` `"jisx0212"` `"gb2312"` `"ksc5601-ex"` `"euc-jp"` `"sjis"` `"iso2022-jp"` `"iso2022-jp-1"` `"iso2022-jp-2"` `"euc-cn"` `"ces-gbk"` `"hz"` `"ces-big5"` `"euc-kr"` `"iso2022-jp-3"` `"iso8859-1"` `"tis620"` `"cp874"` `"cp1252"` `"cp1251"`
proxy_after_tcp_handshake 别名: proxy-after-tcp-handshake 字符串	在建立 TCP 三次握手后代理流量选项 `"disable"` `"enable"`
range_block 别名: range-block 字符串	启用/禁用部分下载的阻止。选项 `"disable"` `"enable"`
retry_count 别名: retry-count 整数	重试 HTTP 连接的尝试次数
scan_bzip2 别名: scan-bzip2 字符串	启用/禁用扫描 BZip2 压缩文件。选项 `"disable"` `"enable"`
ssl_offloaded 别名: ssl-offloaded 字符串	由外部设备执行的 SSL 解密和加密。选项 `"no"` `"yes"`
status 字符串	启用/禁用此协议扫描的活动状态。选项 `"disable"` `"enable"`
stream_based_uncompressed_limit 别名: stream-based-uncompressed-limit 整数	将扫描的最大基于流的未压缩数据大小
streaming_content_bypass 别名: streaming-content-bypass 字符串	启用/禁用绕过缓冲的流式内容。选项 `"disable"` `"enable"`
strip_x_forwarded_for 别名: strip-x-forwarded-for 字符串	启用/禁用剥离 HTTP X-Forwarded-For 标头。选项 `"disable"` `"enable"`
switching_protocols 别名: switching-protocols 字符串	绕过扫描或阻止尝试切换协议的连接。选项 `"bypass"` `"block"`
tcp_window_maximum 别名: tcp-window-maximum 整数	最大动态 TCP 窗口大小
tcp_window_minimum 别名: tcp-window-minimum 整数	最小动态 TCP 窗口大小
tcp_window_size 别名: tcp-window-size 整数	设置 TCP 静态窗口大小
tcp_window_type 别名: tcp-window-type 字符串	指定用于此协议的 TCP 窗口类型。选项 `"system"` `"static"` `"dynamic"` `"auto-tuning"`
tunnel_non_http 别名: tunnel-non-http 字符串	当配置为 HTTP 流量的配置文件接受非 HTTP 会话时，配置如何处理非 HTTP 流量。选项 `"disable"` `"enable"`
uncompressed_nest_limit 别名: uncompressed-nest-limit 整数	可以解压缩和扫描的最大压缩嵌套级别
uncompressed_oversize_limit 别名: uncompressed-oversize-limit 整数	可以扫描的最大内存中未压缩文件大小
unknown_content_encoding 别名: unknown-content-encoding 字符串	配置 FortiGate 设备对未知内容编码采取的操作。选项 `"block"` `"inspect"` `"bypass"`
unknown_http_version 别名: unknown-http-version 字符串	如何处理不符合 HTTP 0 的 HTTP 会话。选项 `"best-effort"` `"reject"` `"tunnel"`
verify_dns_for_policy_matching 别名: verify-dns-for-policy-matching 字符串	启用/禁用策略匹配的 DNS 验证。选项 `"disable"` `"enable"`
imap 字典	Imap。
inspect_all 别名: inspect-all 字符串	启用/禁用对协议的所有端口的检查。选项 `"disable"` `"enable"`
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"oversize"` `"fragmail"` `"no-content-summary"`
oversize_limit 别名: oversize-limit 整数	可以扫描的最大内存中文件大小
ports any	（列表）要扫描内容的端口
proxy_after_tcp_handshake 别名: proxy-after-tcp-handshake 字符串	在建立 TCP 三次握手后代理流量选项 `"disable"` `"enable"`
scan_bzip2 别名: scan-bzip2 字符串	启用/禁用扫描 BZip2 压缩文件。选项 `"disable"` `"enable"`
ssl_offloaded 别名: ssl-offloaded 字符串	由外部设备执行的 SSL 解密和加密。选项 `"no"` `"yes"`
status 字符串	启用/禁用此协议扫描的活动状态。选项 `"disable"` `"enable"`
uncompressed_nest_limit 别名: uncompressed-nest-limit 整数	可以解压缩和扫描的最大压缩嵌套级别
uncompressed_oversize_limit 别名: uncompressed-oversize-limit 整数	可以扫描的最大内存中未压缩文件大小
mail_signature 别名: mail-signature 字典	邮件签名。
signature 字符串	要添加到外发电子邮件的电子邮件签名
status 字符串	启用/禁用在 SMTP 电子邮件消息通过 FortiGate 时向其添加电子邮件签名。选项 `"disable"` `"enable"`
mapi 字典	Mapi。
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"fragmail"` `"oversize"` `"no-content-summary"`
oversize_limit 别名: oversize-limit 整数	可以扫描的最大内存中文件大小
ports any	（列表）要扫描内容的端口
scan_bzip2 别名: scan-bzip2 字符串	启用/禁用扫描 BZip2 压缩文件。选项 `"disable"` `"enable"`
status 字符串	启用/禁用此协议扫描的活动状态。选项 `"disable"` `"enable"`
uncompressed_nest_limit 别名: uncompressed-nest-limit 整数	可以解压缩和扫描的最大压缩嵌套级别
uncompressed_oversize_limit 别名: uncompressed-oversize-limit 整数	可以扫描的最大内存中未压缩文件大小
名称字符串 / 必需	名称。
nntp 字典	Nntp。
inspect_all 别名: inspect-all 字符串	启用/禁用对协议的所有端口的检查。选项 `"disable"` `"enable"`
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"oversize"` `"no-content-summary"` `"splice"`
oversize_limit 别名: oversize-limit 整数	可以扫描的最大内存中文件大小
ports any	（列表）要扫描内容的端口
proxy_after_tcp_handshake 别名: proxy-after-tcp-handshake 字符串	在建立 TCP 三次握手后代理流量选项 `"disable"` `"enable"`
scan_bzip2 别名: scan-bzip2 字符串	启用/禁用扫描 BZip2 压缩文件。选项 `"disable"` `"enable"`
status 字符串	启用/禁用此协议扫描的活动状态。选项 `"disable"` `"enable"`
uncompressed_nest_limit 别名: uncompressed-nest-limit 整数	可以解压缩和扫描的最大压缩嵌套级别
uncompressed_oversize_limit 别名: uncompressed-oversize-limit 整数	可以扫描的最大内存中未压缩文件大小
oversize_log 别名: oversize-log 字符串	启用/禁用防病毒超大文件阻止的日志记录。选项 `"disable"` `"enable"`
pop3 字典	Pop3。
inspect_all 别名: inspect-all 字符串	启用/禁用对协议的所有端口的检查。选项 `"disable"` `"enable"`
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"oversize"` `"fragmail"` `"no-content-summary"`
oversize_limit 别名: oversize-limit 整数	可以扫描的最大内存中文件大小
ports any	（列表）要扫描内容的端口
proxy_after_tcp_handshake 别名: proxy-after-tcp-handshake 字符串	在建立 TCP 三次握手后代理流量选项 `"disable"` `"enable"`
scan_bzip2 别名: scan-bzip2 字符串	启用/禁用扫描 BZip2 压缩文件。选项 `"disable"` `"enable"`
ssl_offloaded 别名: ssl-offloaded 字符串	由外部设备执行的 SSL 解密和加密。选项 `"no"` `"yes"`
status 字符串	启用/禁用此协议扫描的活动状态。选项 `"disable"` `"enable"`
uncompressed_nest_limit 别名: uncompressed-nest-limit 整数	可以解压缩和扫描的最大压缩嵌套级别
uncompressed_oversize_limit 别名: uncompressed-oversize-limit 整数	可以扫描的最大内存中未压缩文件大小
replacemsg_group 别名: replacemsg-group 字符串	要使用的替换消息组的名称
rpc_over_http 别名: rpc-over-http 字符串	启用/禁用通过 HTTP 的 RPC 检查。选项 `"disable"` `"enable"`
smtp 字典	Smtp。
inspect_all 别名: inspect-all 字符串	启用/禁用对协议的所有端口的检查。选项 `"disable"` `"enable"`
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"oversize"` `"fragmail"` `"no-content-summary"` `"splice"`
oversize_limit 别名: oversize-limit 整数	可以扫描的最大内存中文件大小
ports any	（列表）要扫描内容的端口
proxy_after_tcp_handshake 别名: proxy-after-tcp-handshake 字符串	在建立 TCP 三次握手后代理流量选项 `"disable"` `"enable"`
scan_bzip2 别名: scan-bzip2 字符串	启用/禁用扫描 BZip2 压缩文件。选项 `"disable"` `"enable"`
server_busy 别名: server-busy 字符串	当服务器不可用时，启用/禁用 SMTP 服务器繁忙状态。选项 `"disable"` `"enable"`
ssl_offloaded 别名: ssl-offloaded 字符串	由外部设备执行的 SSL 解密和加密。选项 `"no"` `"yes"`
status 字符串	启用/禁用此协议扫描的活动状态。选项 `"disable"` `"enable"`
uncompressed_nest_limit 别名: uncompressed-nest-limit 整数	可以解压缩和扫描的最大压缩嵌套级别
uncompressed_oversize_limit 别名: uncompressed-oversize-limit 整数	可以扫描的最大内存中未压缩文件大小
ssh 字典	Ssh。
comfort_amount 别名: comfort-amount 整数	用于客户端舒适传输的数据量
comfort_interval 别名: comfort-interval 整数	开始、上次传输和下一次客户端舒适传输数据之间的时间间隔
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"oversize"` `"clientcomfort"` `"servercomfort"`
oversize_limit 别名: oversize-limit 整数	可以扫描的最大内存中文件大小
scan_bzip2 别名: scan-bzip2 字符串	启用/禁用扫描 BZip2 压缩文件。选项 `"disable"` `"enable"`
ssl_offloaded 别名: ssl-offloaded 字符串	由外部设备执行的 SSL 解密和加密。选项 `"no"` `"yes"`
stream_based_uncompressed_limit 别名: stream-based-uncompressed-limit 整数	将扫描的最大基于流的未压缩数据大小
tcp_window_maximum 别名: tcp-window-maximum 整数	最大动态 TCP 窗口大小。
tcp_window_minimum 别名: tcp-window-minimum 整数	最小动态 TCP 窗口大小。
tcp_window_size 别名: tcp-window-size 整数	设置 TCP 静态窗口大小。
tcp_window_type 别名: tcp-window-type 字符串	用于此协议的 TCP 窗口类型。选项 `"system"` `"static"` `"dynamic"` `"auto-tuning"`
uncompressed_nest_limit 别名: uncompressed-nest-limit 整数	可以解压缩和扫描的最大压缩嵌套级别
uncompressed_oversize_limit 别名: uncompressed-oversize-limit 整数	可以扫描的最大内存中未压缩文件大小
switching_protocols_log 别名: switching-protocols-log 字符串	启用/禁用 HTTP/HTTPS 切换协议的日志记录。选项 `"disable"` `"enable"`
forticloud_access_token 字符串	使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。
proposed_method 字符串	底层 Json RPC 请求的重写方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
状态字符串 / 必需	创建、更新或删除对象的指令。选项 `"present"` `"absent"`
workspace_locking_adom 字符串	在工作区模式下运行的 FortiManager 的锁定 ADOM，该值可以是全局的以及其他值（包括根）。
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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_profileprotocoloptions:
          comment: "ansible-comment"
          name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the profile protocol options
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_profileprotocoloptions"
          params:
            adom: "ansible"
            profile-protocol-options: "your_value"

返回值 

通用返回值已在此处记录，以下是此模块独有的字段

键	描述
元数据字典	请求的结果。返回值: 始终
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)