fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ssh 模块 – 配置 SFTP 和 SCP 协议选项。

注意

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

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

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

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

fortinet.fortimanager 2.1.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有需要在使用前调整到数据源的参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块会继续执行而不验证参数。

选项

  • false ←（默认）

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ←（默认）

  • true

firewall_profileprotocoloptions_ssh

字典

设置的顶级参数。

comfort_amount

别名：comfort-amount

整数

为客户端舒适传输而发送的数据量

comfort_interval

别名：comfort-interval

整数

开始、上次传输和下一次客户端舒适数据传输之间的时间间隔

options

列表 / elements=字符串

可以应用于会话的一个或多个选项。

选项

  • "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

整数

可以扫描的最大内存未压缩文件大小

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

列表 / elements=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / elements=整数

将覆盖成功条件的 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 SFTP and SCP protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ssh:
        # 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_ssh:
          comfort_amount: <integer>
          comfort_interval: <integer>
          options:
            - "oversize"
            - "clientcomfort"
            - "servercomfort"
          oversize_limit: <integer>
          scan_bzip2: <value in [disable, enable]>
          uncompressed_nest_limit: <integer>
          uncompressed_oversize_limit: <integer>
          ssl_offloaded: <value in [no, yes]>
          stream_based_uncompressed_limit: <integer>
          tcp_window_maximum: <integer>
          tcp_window_minimum: <integer>
          tcp_window_size: <integer>
          tcp_window_type: <value in [system, static, dynamic, ...]>

返回值

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

键

描述

meta

字典

请求的结果。

返回： 总是

request_url

字符串

请求的完整 URL。

返回： 总是

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回： 总是

示例： 0

response_data

列表 / elements=字符串

API 响应。

返回： 总是

response_message

字符串

API 响应的描述性消息。

返回： 总是

示例： "OK."

system_information

字典

目标系统的信息。

返回： 总是

rc

整数

请求的状态。

返回： 总是

示例： 0

version_check_warning

列表 / elements=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)