fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck 模块 – SD-WAN 状态检查或健康检查。

注意

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

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

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

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

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 客户端进行身份验证。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。选项 `"present"` `"absent"`
wanprof 字符串 / 必需	请求 URL 中的参数 (wanprof)。
wanprof_system_virtualwanlink_healthcheck 字典	设置的顶级参数。
_dynamic_server 别名：_dynamic-server 字符串	动态服务器。
addr_mode 别名：addr-mode 字符串	地址模式选项 `"ipv4"` `"ipv6"`
diffservcode 字符串	区分服务代码点
dns_request_domain 别名：dns-request-domain 字符串	要为 DNS 探测解析的完全限定域名。
failtime 整数	服务器被认为丢失之前的失败次数
ha_priority 别名：ha-priority 整数	HA 选举优先级
http_agent 别名：http-agent 字符串	HTTP 标头中 http-agent 字段中的字符串。
http_get 别名：http-get 字符串	如果协议是 HTTP，则用于与服务器通信的 URL。
http_match 别名：http-match 字符串	如果协议是 HTTP，则服务器应返回的响应字符串。
internet_service_id 别名：internet-service-id 字符串	互联网服务 ID。
interval 整数	状态检查间隔，或尝试连接到服务器之间的时间
members 任意	(列表或字符串) 成员序列号列表。
name 字符串 / 必需	状态检查或健康检查名称。
packet_size 别名：packet-size 整数	twamp 测试会话的包大小，
password 任意	(列表) 身份验证模式下的 Twamp 控制器密码
port 整数	用于通过所选协议与服务器通信的端口号。
probe_count 别名：probe-count 整数	用于计算延迟和抖动的最新探测数
probe_packets 别名：probe-packets 字符串	启用/禁用探测包的传输。选项 `"disable"` `"enable"`
probe_timeout 别名：probe-timeout 整数	在探测包被认为丢失之前要等待的时间
protocol 字符串	用于确定 FortiGate 是否可以与服务器通信的协议。选项 `"ping"` `"tcp-echo"` `"udp-echo"` `"http"` `"twamp"` `"ping6"` `"dns"`
recoverytime 整数	在服务器被认为恢复之前的成功响应数
security_mode 别名：security-mode 字符串	Twamp 控制器安全模式。选项 `"none"` `"authentication"`
server 任意	(列表) 服务器的 IP 地址或 FQDN 名称。
sla 列表 / 元素=字典	SLA。
id 整数	SLA ID。
jitter_threshold 别名：jitter-threshold 整数	SLA 以毫秒为单位做出决定的抖动。
latency_threshold 别名：latency-threshold 整数	SLA做出决策的延迟时间（毫秒）。
link_cost_factor 别名：link-cost-factor 列表 / 元素=字符串	选择链路的依据。选项 `"延迟"` `"抖动"` `"丢包率"`
packetloss_threshold 别名：packetloss-threshold 整数	SLA做出决策的丢包率（百分比）。
sla_fail_log_period 别名：sla-fail-log-period 整数	生成SLA失败日志消息的时间间隔（秒）。
sla_pass_log_period 别名：sla-pass-log-period 整数	生成SLA成功日志消息的时间间隔（秒）。
system_dns 别名：system-dns 字符串	启用/禁用系统DNS作为探测服务器。选项 `"disable"` `"enable"`
threshold_alert_jitter 别名：threshold-alert-jitter 整数	抖动的告警阈值。
threshold_alert_latency 别名：threshold-alert-latency 整数	延迟的告警阈值。
threshold_alert_packetloss 别名：threshold-alert-packetloss 整数	丢包率的告警阈值。
threshold_warning_jitter 别名：threshold-warning-jitter 整数	抖动的警告阈值。
threshold_warning_latency 别名：threshold-warning-latency 整数	延迟的警告阈值。
threshold_warning_packetloss 别名：threshold-warning-packetloss 整数	丢包率的警告阈值。
超时整数	在未收到服务器回复之前等待的时间（如果超过此时间，则认为连接尝试失败）。
update_cascade_interface 别名：update-cascade-interface 字符串	启用/禁用级联接口更新。选项 `"disable"` `"enable"`
update_static_route 别名：update-static-route 字符串	启用/禁用静态路由更新。选项 `"disable"` `"enable"`
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: SD-WAN status checking or health checking.
      fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_healthcheck:
        # 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>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_virtualwanlink_healthcheck:
          _dynamic_server: <string>
          addr_mode: <value in [ipv4, ipv6]>
          failtime: <integer>
          http_agent: <string>
          http_get: <string>
          http_match: <string>
          interval: <integer>
          members: <list or string>
          name: <string>
          packet_size: <integer>
          password: <list or string>
          port: <integer>
          protocol: <value in [ping, tcp-echo, udp-echo, ...]>
          recoverytime: <integer>
          security_mode: <value in [none, authentication]>
          server: <list or string>
          sla:
            -
              id: <integer>
              jitter_threshold: <integer>
              latency_threshold: <integer>
              link_cost_factor:
                - "latency"
                - "jitter"
                - "packet-loss"
              packetloss_threshold: <integer>
          threshold_alert_jitter: <integer>
          threshold_alert_latency: <integer>
          threshold_alert_packetloss: <integer>
          threshold_warning_jitter: <integer>
          threshold_warning_latency: <integer>
          threshold_warning_packetloss: <integer>
          update_cascade_interface: <value in [disable, enable]>
          update_static_route: <value in [disable, enable]>
          internet_service_id: <string>
          probe_packets: <value in [disable, enable]>
          sla_fail_log_period: <integer>
          sla_pass_log_period: <integer>
          timeout: <integer>
          ha_priority: <integer>
          diffservcode: <string>
          probe_timeout: <integer>
          dns_request_domain: <string>
          probe_count: <integer>
          system_dns: <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 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。返回：复杂类型

作者

杜欣伟 (@dux-fortinet)
李星 (@lix-fortinet)
薛杰 (@JieX19)
郑琳 (@chillancezen)
沈峰 (@fshen01)
卢宏斌 (@fgtdev-hblu)