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

注意

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

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

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

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

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_imap 字典	设置的顶级参数。
inspect_all 别名：inspect-all 字符串	启用/禁用对协议的所有端口的检查。选项 `"disable"` `"enable"`
options 列表 / 元素=字符串	可以应用于会话的一个或多个选项。选项 `"oversize"` `"fragmail"` `"no-content-summary"`
oversize_limit 别名：oversize-limit 整数	可以扫描的最大内存文件大小
ports 任意	(列表) 要扫描内容的端口
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 整数	可以扫描的最大内存未压缩文件大小
forticloud_access_token 字符串	使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。
profile-protocol-options 字符串	已弃用，请使用“profile_protocol_options”
profile_protocol_options 字符串	请求 URL 中的参数 (profile-protocol-options)。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
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 有助于完成这项工作。
通常，当返回非零 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 IMAP protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_imap:
        # 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>
        profile_protocol_options: <your own value>
        firewall_profileprotocoloptions_imap:
          inspect_all: <value in [disable, enable]>
          options:
            - "oversize"
            - "fragmail"
            - "no-content-summary"
          oversize_limit: <integer>
          ports: <list or integer>
          scan_bzip2: <value in [disable, enable]>
          status: <value in [disable, enable]>
          uncompressed_nest_limit: <integer>
          uncompressed_oversize_limit: <integer>
          ssl_offloaded: <value in [no, yes]>
          proxy_after_tcp_handshake: <value in [disable, enable]>

返回值 

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

键	描述
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 版本支持，则会发出警告。返回：复杂类型

作者

杜欣伟 (@dux-fortinet)
李兴 (@lix-fortinet)
薛杰 (@JieX19)
郑麟 (@chillancezen)
沈方 (@fshen01)
卢洪斌 (@fgtdev-hblu)