fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink 模块 – 使用 SD-WAN 配置冗余互联网连接

注意

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

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

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

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

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 代码列表。
wanprof 字符串 / 必需	请求 URL 中的参数 (wanprof)。
wanprof_system_virtualwanlink 字典	设置的顶级参数。
fail_alert_interfaces 别名：fail-alert-interfaces 任何	（列表）将发出警报的物理接口。
fail_detect 别名：fail-detect 字符串	启用/禁用 SD-WAN 互联网连接状态检查选择 `"disable"` `"enable"`
health_check 别名：health-check 列表 / 元素=字典	运行状况检查。
_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"`
恢复时间整数	服务器被视为恢复正常前收到的成功响应次数
安全模式别名: security-mode 字符串	Twamp 控制器安全模式。选择 `"none"` `"authentication"`
服务器任何	(列表) 服务器的 IP 地址或 FQDN 名称。
SLA 列表 / 元素=字典	SLA。
ID 整数	SLA ID。
抖动阈值别名: jitter-threshold 整数	用于 SLA 决策的抖动，单位为毫秒。
延迟阈值别名: latency-threshold 整数	用于 SLA 决策的延迟，单位为毫秒。
链路成本因子别名: link-cost-factor 列表 / 元素=字符串	用于链路选择的标准。选择 `"latency"` `"jitter"` `"packet-loss"`
丢包阈值别名: packetloss-threshold 整数	用于 SLA 决策的丢包率，单位为百分比。
SLA 失败日志周期别名: sla-fail-log-period 整数	生成 SLA 失败日志消息的时间间隔，单位为秒
SLA 通过日志周期别名: sla-pass-log-period 整数	生成 SLA 通过日志消息的时间间隔，单位为秒
系统 DNS 别名: system-dns 字符串	启用/禁用系统 DNS 作为探测服务器。选择 `"disable"` `"enable"`
抖动告警阈值别名: threshold-alert-jitter 整数	抖动的告警阈值
延迟告警阈值别名: threshold-alert-latency 整数	延迟的告警阈值
丢包告警阈值别名: threshold-alert-packetloss 整数	丢包的告警阈值
抖动警告阈值别名: threshold-warning-jitter 整数	抖动的警告阈值
延迟警告阈值别名: threshold-warning-latency 整数	延迟的警告阈值
丢包警告阈值别名: threshold-warning-packetloss 整数	丢包的警告阈值
超时整数	在未收到服务器回复而将连接尝试视为失败之前等待的时间
更新级联接口别名: update-cascade-interface 字符串	启用/禁用更新级联接口。选择 `"disable"` `"enable"`
更新静态路由别名: update-static-route 字符串	启用/禁用更新静态路由。选择 `"disable"` `"enable"`
负载均衡模式别名: load-balance-mode 字符串	用于将 Internet 流量负载均衡到 SD-WAN 成员的算法或模式。选择 `"source-ip-based"` `"weight-based"` `"usage-based"` `"source-dest-ip-based"` `"measured-volume-based"`
成员列表 / 元素=字典	成员。
动态成员别名: _dynamic-member 字符串	动态成员。
注释字符串	注释。
成本整数	此接口在 SLA 模式下的服务成本
网关字符串	此接口的默认网关。
网关 6 字符串	IPv6 网关。
入口溢出阈值别名: ingress-spillover-threshold 整数	此接口的入口溢出阈值
接口字符串	接口名称。
优先级整数	接口的优先级
序列号别名: seq-num 整数	序列号
源字符串	在发送到服务器的健康检查数据包中使用的源 IP 地址。
源 6 字符串	在发送到服务器的健康检查数据包中使用的源 IPv6 地址。
溢出阈值别名: spillover-threshold 整数	此接口的出口溢出阈值
状态字符串	在 SD-WAN 中启用/禁用此接口。选择 `"disable"` `"enable"`
容量比率别名: volume-ratio 整数	测量的容量比率
权重整数	此接口用于加权负载均衡的权重。
邻居列表 / 元素=字典	邻居。
健康检查别名：health-check 字符串	SD-WAN 健康检查名称。
IP 字符串	邻居的 IP 地址。
成员字符串	成员序列号。
角色字符串	邻居的角色。选择 `"primary"` `"secondary"` `"standalone"`
SLA ID 别名: sla-id 整数	SLA ID。
邻居保持启动时间别名: neighbor-hold-boot-time 整数	从邻居启动时从主邻居切换到辅助邻居的等待时间，单位为秒。
邻居保持禁用别名: neighbor-hold-down 字符串	启用/禁用从辅助邻居切换到主邻居的保持。选择 `"disable"` `"enable"`
邻居保持禁用时间别名: neighbor-hold-down-time 整数	当禁用保持时，从辅助邻居切换到主邻居的等待时间，单位为秒。
服务列表 / 元素=字典	服务。
地址模式别名：addr-mode 字符串	地址模式选择 `"ipv4"` `"ipv6"`
带宽权重别名: bandwidth-weight 整数	自定义配置文件 1 公式中可用双向带宽倒数的系数。
默认字符串	启用/禁用将 SD-WAN 用作默认服务。选择 `"disable"` `"enable"`
DSCP 转发别名: dscp-forward 字符串	启用/禁用转发流量 DSCP 标记。选择 `"disable"` `"enable"`
DSCP 转发标记别名: dscp-forward-tag 字符串	转发流量 DSCP 标记。
DSCP 反向别名: dscp-reverse 字符串	启用/禁用反向流量 DSCP 标记。选择 `"disable"` `"enable"`
DSCP 反向标记别名: dscp-reverse-tag 字符串	反向流量 DSCP 标记。
目标任何	(列表或字符串) 目标地址名称。
目标 6 任何	(列表或字符串) 目标地址 6 名称。
目标取反别名: dst-negate 字符串	启用/禁用目标地址匹配的取反。选择 `"disable"` `"enable"`
结束端口别名: end-port 整数	结束目标端口号。
网关字符串	启用/禁用 SD-WAN 服务网关。选择 `"disable"` `"enable"`
组任何	(列表或字符串) 用户组。
健康检查别名：health-check 字符串	运行状况检查。
保持禁用时间别名: hold-down-time 整数	从备份成员切换到主成员的等待时间，单位为秒
ID 整数	优先级规则 ID
输入设备别名: input-device 任何	(列表或字符串) 源接口名称。
输入设备取反别名: input-device-negate 字符串	启用/禁用输入设备匹配的取反。选择 `"disable"` `"enable"`
互联网服务别名: internet-service 字符串	启用/禁用使用互联网服务进行基于应用的负载均衡。选择 `"disable"` `"enable"`
互联网服务应用控制别名: internet-service-app-ctrl 任何	(列表) 基于应用控制的互联网服务 ID 列表。
互联网服务应用控制组别名: internet-service-app-ctrl-group 任何	(列表或字符串) 基于应用控制的互联网服务组列表。
互联网服务控制别名: internet-service-ctrl 任何	(列表) 基于控制的互联网服务 ID 列表。
互联网服务控制组别名: internet-service-ctrl-group 任何	(list 或 str) 基于控制的互联网服务组列表。
internet_service_custom 别名: internet-service-custom 任何	(list 或 str) 自定义互联网服务名称列表。
internet_service_custom_group 别名: internet-service-custom-group 任何	(list 或 str) 自定义互联网服务组列表。
internet_service_group 别名: internet-service-group 任何	(list 或 str) 互联网服务组列表。
internet_service_id 别名：internet-service-id 任何	(list 或 str) 互联网服务 ID 列表。
internet_service_name 别名: internet-service-name 字符串	互联网服务名称列表。
jitter_weight 别名: jitter-weight 整数	自定义配置文件 1 中抖动的系数。
latency_weight 别名: latency-weight 整数	自定义配置文件 1 中延迟的系数。
link_cost_factor 别名: link-cost-factor 字符串	链路成本因子。选择 `"latency"` `"jitter"` `"packet-loss"` `"inbandwidth"` `"outbandwidth"` `"bibandwidth"` `"custom-profile-1"`
link_cost_threshold 别名: link-cost-threshold 整数	链路成本值变化导致策略路由重新生成的百分比阈值。
成员字符串	成员序列号。
mode 字符串	控制优先级规则如何在 SD-WAN 中设置接口的优先级。选择 `"auto"` `"manual"` `"priority"` `"sla"` `"load-balance"`
name 字符串	优先级规则名称。
packet_loss_weight 别名: packet-loss-weight 整数	自定义配置文件 1 中丢包的系数。
priority_members 别名: priority-members 任何	（列表或字符串）成员序列号列表。
protocol 整数	协议号。
quality_link 别名: quality-link 整数	质量等级。
角色字符串	与邻居协同工作的服务角色。选择 `"primary"` `"secondary"` `"standalone"`
route_tag 别名: route-tag 整数	IPv4 路由映射路由标签。
sla 列表 / 元素=字典	SLA。
health_check 别名：health-check 字符串	虚拟 WAN 链路健康检查。
ID 整数	SLA ID。
sla_compare_method 别名: sla-compare-method 字符串	在 SLA 和负载均衡模式下比较 SLA 值的方法。选择 `"order"` `"number"`
src 任何	(list 或 str) 源地址名称。
src6 任何	(list 或 str) 源地址 IPv6 名称。
src_negate 别名: src-negate 字符串	启用/禁用源地址匹配的取反。选择 `"disable"` `"enable"`
standalone_action 别名: standalone-action 字符串	当选择的邻居角色为独立，而服务角色不为独立时，启用/禁用服务。选择 `"disable"` `"enable"`
start_port 别名: start-port 整数	起始目标端口号。
状态字符串	启用/禁用 SD-WAN 服务。选择 `"disable"` `"enable"`
tos 字符串	服务类型位模式。
tos_mask 别名: tos-mask 字符串	评估的服务类型位。
users 任何	(list 或 str) 用户名。
状态字符串	启用/禁用 SD-WAN。选择 `"disable"` `"enable"`
workspace_locking_adom 字符串	在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是全局的和其他值（包括 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 redundant internet connections using SD-WAN
      fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink:
        # 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>
        wanprof_system_virtualwanlink:
          fail_detect: <value in [disable, enable]>
          health_check:
            -
              _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]>
          load_balance_mode: <value in [source-ip-based, weight-based, usage-based, ...]>
          members:
            -
              _dynamic_member: <string>
              comment: <string>
              gateway: <string>
              gateway6: <string>
              ingress_spillover_threshold: <integer>
              interface: <string>
              priority: <integer>
              seq_num: <integer>
              source: <string>
              source6: <string>
              spillover_threshold: <integer>
              status: <value in [disable, enable]>
              volume_ratio: <integer>
              weight: <integer>
              cost: <integer>
          service:
            -
              addr_mode: <value in [ipv4, ipv6]>
              bandwidth_weight: <integer>
              default: <value in [disable, enable]>
              dscp_forward: <value in [disable, enable]>
              dscp_forward_tag: <string>
              dscp_reverse: <value in [disable, enable]>
              dscp_reverse_tag: <string>
              dst: <list or string>
              dst_negate: <value in [disable, enable]>
              dst6: <list or string>
              end_port: <integer>
              gateway: <value in [disable, enable]>
              groups: <list or string>
              health_check: <string>
              hold_down_time: <integer>
              id: <integer>
              internet_service: <value in [disable, enable]>
              internet_service_ctrl: <list or integer>
              internet_service_ctrl_group: <list or string>
              internet_service_custom: <list or string>
              internet_service_custom_group: <list or string>
              internet_service_group: <list or string>
              internet_service_id: <list or string>
              jitter_weight: <integer>
              latency_weight: <integer>
              link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
              link_cost_threshold: <integer>
              member: <string>
              mode: <value in [auto, manual, priority, ...]>
              name: <string>
              packet_loss_weight: <integer>
              priority_members: <list or string>
              protocol: <integer>
              quality_link: <integer>
              route_tag: <integer>
              sla:
                -
                  health_check: <string>
                  id: <integer>
              src: <list or string>
              src_negate: <value in [disable, enable]>
              src6: <list or string>
              start_port: <integer>
              status: <value in [disable, enable]>
              tos: <string>
              tos_mask: <string>
              users: <list or string>
              internet_service_app_ctrl: <list or integer>
              internet_service_app_ctrl_group: <list or string>
              role: <value in [primary, secondary, standalone]>
              sla_compare_method: <value in [order, number]>
              standalone_action: <value in [disable, enable]>
              input_device: <list or string>
              internet_service_name: <string>
              input_device_negate: <value in [disable, enable]>
          status: <value in [disable, enable]>
          neighbor:
            -
              health_check: <string>
              ip: <string>
              member: <string>
              role: <value in [primary, secondary, standalone]>
              sla_id: <integer>
          neighbor_hold_boot_time: <integer>
          neighbor_hold_down: <value in [disable, enable]>
          neighbor_hold_down_time: <integer>
          fail_alert_interfaces: <list or string>

返回值 

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

键	描述
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 版本支持，则发出警告。返回: complex

作者

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)