fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric 模块 – 配置 WAN 指标。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

  • 示例包含所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必填

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

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

hotspot20_h2qpwanmetric

字典

设置的顶级参数。

downlink_load

别名：downlink-load

整数

下行链路负载。

downlink_speed

别名：downlink-speed

整数

下行链路速度

link_at_capacity

别名：link-at-capacity

字符串

链路满负荷。

选项

  • "disable"

  • "enable"

link_status

别名：link-status

字符串

链路状态。

选项

  • "down"

  • "up"

  • "in-test"

load_measurement_duration

别名：load-measurement-duration

整数

负载测量持续时间

name

字符串 / 必填

WAN 指标名称。

symmetric_wan_link

别名：symmetric-wan-link

字符串

WAN 链路对称性。

选项

  • "asymmetric"

  • "symmetric"

uplink_load

别名：uplink-load

整数

上行链路负载。

uplink_speed

别名：uplink-speed

整数

上行链路速度

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必填

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

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 有助于完成此工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 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 WAN metrics.
      fortinet.fortimanager.fmgr_hotspot20_h2qpwanmetric:
        # 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>
        state: present # <value in [present, absent]>
        hotspot20_h2qpwanmetric:
          downlink_load: <integer>
          downlink_speed: <integer>
          link_at_capacity: <value in [disable, enable]>
          link_status: <value in [down, up, in-test]>
          load_measurement_duration: <integer>
          name: <string>
          symmetric_wan_link: <value in [asymmetric, symmetric]>
          uplink_load: <integer>
          uplink_speed: <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 版本支持，则会发出警告。

返回：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑林 (@chillancezen)

  • 沈方 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)