fortinet.fortimanager.fmgr_firewall_vip_quic 模块 – QUIC 设置。

注意

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

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

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

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

fortinet.fortimanager 2.3.0 中的新增功能

概要

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

  • 示例包括所有参数和值，这些参数和值在使用前需要调整为数据源。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

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

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构存在差异时才设置为 True，模块将继续执行，而无需验证参数。

选择

  • false ←（默认）

  • true

enable_log

布尔值

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

选择

  • false ←（默认）

  • true

firewall_vip_quic

字典

设置的顶级参数。

ack_delay_exponent

别名：ack-delay-exponent

整数

ACK 延迟指数

active_connection_id_limit

别名：active-connection-id-limit

整数

活动连接 ID 限制

active_migration

别名：active-migration

字符串

启用/禁用活动迁移

选择

  • "禁用"

  • "启用"

grease_quic_bit

别名：grease-quic-bit

字符串

启用/禁用 grease QUIC 位

选择

  • "禁用"

  • "启用"

max_ack_delay

别名：max-ack-delay

整数

最大 ACK 延迟（以毫秒为单位）

max_datagram_frame_size

别名：max-datagram-frame-size

整数

最大数据报帧大小（以字节为单位）

max_idle_timeout

别名：max-idle-timeout

整数

最大空闲超时（以毫秒为单位）

max_udp_payload_size

别名：max-udp-payload-size

整数

最大 UDP 有效负载大小（以字节为单位）

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

用于底层 Json RPC 请求的覆盖方法。

选择

  • "更新"

  • "设置"

  • "添加"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

vip

字符串 / 必需

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

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: QUIC setting.
      fortinet.fortimanager.fmgr_firewall_vip_quic:
        # 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>
        vip: <your own value>
        firewall_vip_quic:
          ack_delay_exponent: <integer>
          active_connection_id_limit: <integer>
          active_migration: <value in [disable, enable]>
          grease_quic_bit: <value in [disable, enable]>
          max_ack_delay: <integer>
          max_datagram_frame_size: <integer>
          max_idle_timeout: <integer>
          max_udp_payload_size: <integer>

返回值

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

键

描述

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

列表 / 元素=字符串

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

返回：复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)