fortinet.fortimanager.fmgr_wanprof_system_sdwan 模块 – 使用 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_sdwan。

fortinet.fortimanager 2.1.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_sdwan 字典	设置的顶级参数。
app_perf_log_period 别名：app-perf-log-period 整数	生成应用程序性能日志的时间间隔（秒）
duplication 列表 / 元素=字典	重复。
dstaddr 任意	(列表或字符串) 目标地址或地址组名称。
dstaddr6 任意	(列表或字符串) 目标地址6 或地址6 组名称。
dstintf 任意	(列表或字符串) 出站
id 整数	重复规则 ID
packet_de_duplication 别名：packet-de-duplication 字符串	启用/禁用丢弃已重复的数据包。 选项 "disable" "enable"
packet_duplication 别名：packet-duplication 字符串	配置数据包复制方法。 选项 "disable" "force" "on-demand"
service 任意	(列表或字符串) 服务和服务组名称。
service_id 别名：service-id 任意	(列表或字符串) SD-WAN 服务规则 ID 列表。
sla_match_service 别名：sla-match-service 字符串	启用/禁用数据包复制匹配服务规则中的健康检查 SLA。 选项 "disable" "enable"
srcaddr 任意	(列表或字符串) 源地址或地址组名称。
srcaddr6 任意	(列表或字符串) 源地址6 或地址6 组名称。
srcintf 任意	(列表或字符串) 入站
duplication_max_num 别名：duplication-max-num 整数	数据包在 SD-WAN 区域中复制到的接口成员的最大数量
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"
class_id 别名：class-id 字符串	流量类 ID。
detect_mode 别名：detect-mode 字符串	确定如何检测服务器的模式。 选项 "active" "passive" "prefer-passive" "remote" "agent-based"
diffservcode 字符串	区分服务代码点
dns_match_ip 别名：dns-match-ip 字符串	如果协议是 DNS，则预期来自 DNS 服务器的响应 IP。
dns_request_domain 别名：dns-request-domain 字符串	DNS 探测要解析的完全限定域名。
embed_measured_health 别名：embed-measured-health 字符串	启用/禁用嵌入测量的健康信息。 选项 "disable" "enable"
failtime 整数	服务器被认为失效前的失败次数
ftp_file 别名：ftp-file 字符串	FTP 服务器上要下载的文件的完整路径和文件名，用于 FTP 健康检查探测。
ftp_mode 别名：ftp-mode 字符串	FTP 模式。 选项 "passive" "port"
ha_priority 别名：ha-priority 整数	HA 选举优先级
http_agent 别名：http-agent 字符串	HTTP 头中 http-agent 字段中的字符串。
http_get 别名：http-get 字符串	如果协议是 HTTP，则用于与服务器通信的 URL。
http_match 别名：http-match 字符串	如果协议是 HTTP，则服务器应返回的响应字符串。
interval 整数	状态检查间隔（毫秒），或尝试连接到服务器之间的时间
members 任意	(列表或字符串) 成员序号列表。
mos_codec 别名：mos-codec 字符串	用于 MOS 计算的编解码器 选项 "g711" "g722" "g729"
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" "tcp-connect" "ftp" "https"
quality_measured_method 别名：quality-measured-method 字符串	测量 tcp-connect 质量的方法。 选项 "half-close" "half-open"
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 列表 / 元素=字符串	确定链路选择的标准。 选项 "latency" "jitter" "packet-loss" "mos" "remote"
mos_threshold 别名：mos-threshold 字符串	SLA 要标记为通过的最小平均意见分数。
packetloss_threshold 别名：packetloss-threshold 整数	SLA 用于决策的丢包率（百分比）。
priority_in_sla 别名：priority-in-sla 整数	在 SLA 内分配到路由表中的值
priority_out_sla 别名：priority-out-sla 整数	在 SLA 外分配到路由表中的值
sla_fail_log_period 别名：sla-fail-log-period 整数	生成 SLA 失败日志消息的时间间隔（秒）
sla_id_redistribute 别名：sla-id-redistribute 整数	从 SLA 子表中选择 ID。
sla_pass_log_period 别名：sla-pass-log-period 整数	生成 SLA 通过日志消息的时间间隔（秒）
source 字符串	健康检查数据包中用于连接到服务器的源 IP 地址。
source6 字符串	健康检查数据包中用于连接到服务器的源 IPv6 地址。
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"
user 字符串	访问探测服务器的用户名。
vrf 整数	虚拟路由转发 ID。
health_check_fortiguard 别名：health-check-fortiguard 列表 / 元素=字典	FortiGuard 健康检查。
addr_mode 别名：addr-mode 字符串	地址模式 选项 "ipv4" "ipv6"
class_id 别名：class-id 任意	(列表) 流量类别 ID。
detect_mode 别名：detect-mode 字符串	确定如何检测服务器的模式。 选项 "active" "passive" "prefer-passive" "remote" "agent-based"
diffservcode 字符串	区分服务代码点
dns_match_ip 别名：dns-match-ip 字符串	如果协议是 DNS，则预期来自 DNS 服务器的响应 IP。
dns_request_domain 别名：dns-request-domain 字符串	DNS 探测要解析的完全限定域名。
embed_measured_health 别名：embed-measured-health 字符串	启用/禁用嵌入测量的健康信息。 选项 "disable" "enable"
failtime 整数	服务器被认为失效前的失败次数
ftp_file 别名：ftp-file 字符串	FTP 服务器上要下载的文件的完整路径和文件名，用于 FTP 健康检查探测。
ftp_mode 别名：ftp-mode 字符串	FTP 模式。 选项 "passive" "port"
ha_priority 别名：ha-priority 整数	HA 选举优先级
http_agent 别名：http-agent 字符串	HTTP 头中 http-agent 字段中的字符串。
http_get 别名：http-get 字符串	如果协议是 HTTP，则用于与服务器通信的 URL。
http_match 别名：http-match 字符串	如果协议是 HTTP，则服务器应返回的响应字符串。
interval 整数	状态检查间隔（毫秒），或尝试连接到服务器之间的时间
members 任意	(列表) 成员序号列表。
mos_codec 别名：mos-codec 字符串	用于 MOS 计算的编解码器 选项 "g711" "g722" "g729"
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" "dns" "tcp-connect" "ftp" "https"
quality_measured_method 别名：quality-measured-method 字符串	测量 tcp-connect 质量的方法。 选项 "half-close" "half-open"
recoverytime 整数	服务器被认为恢复之前收到的成功响应次数
security_mode 别名：security-mode 字符串	TWAMP 控制器安全模式。 选项 "none" "authentication"
server 任意	(列表) 来自 FortiGuard 的预定义 IP 地址或 FQDN 名称。
sla 列表 / 元素=字典	SLA。
id 整数	SLA ID。
jitter_threshold 别名：jitter-threshold 整数	SLA 用于决策的抖动（毫秒）。
latency_threshold 别名：latency-threshold 整数	SLA 用于决策的延迟（毫秒）。
link_cost_factor 别名：link-cost-factor 列表 / 元素=字符串	确定链路选择的标准。 选项 "latency" "jitter" "packet-loss" "mos" "remote"
mos_threshold 别名：mos-threshold 字符串	SLA 要标记为通过的最小平均意见分数。
packetloss_threshold 别名：packetloss-threshold 整数	SLA 用于决策的丢包率（百分比）。
priority_in_sla 别名：priority-in-sla 整数	在 SLA 内分配到路由表中的值
priority_out_sla 别名：priority-out-sla 整数	在 SLA 外分配到路由表中的值
sla_fail_log_period 别名：sla-fail-log-period 整数	生成 SLA 失败日志消息的时间间隔（秒）
sla_id_redistribute 别名：sla-id-redistribute 整数	从 SLA 子表中选择 ID。
sla_pass_log_period 别名：sla-pass-log-period 整数	生成 SLA 通过日志消息的时间间隔（秒）
source 字符串	健康检查数据包中用于连接到服务器的源 IP 地址。
source6 字符串	用于健康检查数据包到服务器的源 IPv6 地址。
system_dns 别名：system-dns 字符串	启用/禁用系统 DNS 作为探测服务器。 选项 "disable" "enable"
target_name 别名: target-name 字符串	状态检查或预定义健康检查目标名称。
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"
user 字符串	访问探测服务器的用户名。
vrf 整数	虚拟路由转发 ID。
load_balance_mode 别名: load-balance-mode 字符串	用于将互联网流量负载均衡到 SD-WAN 成员的算法或模式。 选项 "基于源IP" "基于权重" "基于使用率" "基于源-目标IP" "基于测量流量"
members 列表 / 元素=字典	成员。
_dynamic_member 别名: _dynamic-member 字符串	动态成员。
comment 字符串	注释。
cost 整数	SLA 模式下此接口的服务成本
gateway 字符串	此接口的默认网关。
gateway6 字符串	IPv6 网关。
ingress_spillover_threshold 别名: ingress-spillover-threshold 整数	此接口的入流量溢出阈值
interface 字符串	接口名称。
preferred_source 别名: preferred-source 字符串	此成员的优选路由源。
priority 整数	接口优先级
priority6 整数	IPv6 接口优先级
priority_in_sla 别名：priority-in-sla 整数	此成员处于 SLA 状态时，到此成员的路由的优选优先级
priority_out_sla 别名：priority-out-sla 整数	此成员处于 SLA 外状态时，到此成员的路由的优选优先级
seq_num 别名: seq-num 整数	序号
source 字符串	健康检查数据包中用于连接到服务器的源 IP 地址。
source6 字符串	用于健康检查数据包到服务器的源 IPv6 地址。
spillover_threshold 别名: spillover-threshold 整数	此接口的出流量溢出阈值
status 字符串	在 SD-WAN 中启用/禁用此接口。 选项 "disable" "enable"
transport_group 别名: transport-group 整数	测量的传输组
volume_ratio 别名: volume-ratio 整数	测量的流量比率
weight 整数	此接口的加权负载均衡权重。
zone 字符串	区域名称。
neighbor 列表 / 元素=字典	邻居。
health_check 别名：health-check 字符串	SD-WAN 健康检查名称。
ip 字符串	邻居的 IP/IPv6 地址。
member 任意	(列表或字符串) 成员序号。
minimum_sla_meet_members 别名: minimum-sla-meet-members 整数	邻居优先时，满足 SLA 的最小成员数。
mode 字符串	选择邻居的指标。 选项 "sla" "speedtest"
role 字符串	邻居的角色。 选项 "primary" "secondary" "standalone"
service_id 别名：service-id 字符串	与邻居一起工作的 SD-WAN 服务 ID。
sla_id 别名: sla-id 整数	SLA ID。
neighbor_hold_boot_time 别名: neighbor-hold-boot-time 整数	从邻居启动时，从主邻居切换到备用邻居的等待时间（秒）。
neighbor_hold_down 别名: neighbor-hold-down 字符串	启用/禁用从备用邻居切换到主邻居的保持切换。 选项 "disable" "enable"
neighbor_hold_down_time 别名: neighbor-hold-down-time 整数	禁用保持时，从备用邻居切换到主邻居的等待时间（秒）。
选项 列表 / 元素=字符串	选项。 选项 "sdwan-overlay" "sdwan-manager"
service 列表 / 元素=字典	服务。
addr_mode 别名：addr-mode 字符串	地址模式 选项 "ipv4" "ipv6"
agent_exclusive 别名: agent-exclusive 字符串	将服务设置为/取消设置为仅代理使用。 选项 "disable" "enable"
bandwidth_weight 别名: bandwidth-weight 整数	在自定义配置文件1公式中，可用双向带宽倒数的系数。
comment 字符串	注释。
默认 字符串	启用/禁用使用SD-WAN作为默认服务。 选项 "disable" "enable"
dscp_forward 别名: dscp-forward 字符串	启用/禁用转发流量DSCP标记。 选项 "disable" "enable"
dscp_forward_tag 别名: dscp-forward-tag 字符串	转发流量DSCP标记。
dscp_reverse 别名: dscp-reverse 字符串	启用/禁用反向流量DSCP标记。 选项 "disable" "enable"
dscp_reverse_tag 别名: dscp-reverse-tag 字符串	反向流量DSCP标记。
目标地址 任意	(列表或字符串) 目标地址名称。
目标IPv6地址 任意	(列表或字符串) 目标IPv6地址名称。
dst_negate 别名: dst-negate 字符串	启用/禁用目标地址匹配的反转。 选项 "disable" "enable"
end_port 别名: end-port 整数	结束目标端口号。
end_src_port 别名: end-src-port 整数	结束源端口号。
gateway 字符串	启用/禁用SD-WAN服务网关。 选项 "disable" "enable"
用户组 任意	(列表或字符串) 用户组。
hash_mode 别名: hash-mode 字符串	用于负载均衡模式下所选优先成员的哈希算法。 选项 "轮询" "基于源IP" "基于源-目标IP" "入带宽" "出带宽" "双向带宽"
health_check 别名：health-check 任意	(列表或字符串) 健康检查列表。
hold_down_time 别名: hold-down-time 整数	从备份成员切换到主成员的等待时间（秒）。
id 整数	SD-WAN规则ID
input_device 别名: input-device 任意	(列表或字符串) 源接口名称。
input_device_negate 别名: input-device-negate 字符串	启用/禁用输入设备匹配的反转。 选项 "disable" "enable"
input_zone 别名: input-zone 任意	(列表) 源输入区域名称。
internet_service 别名: internet-service 字符串	启用/禁用使用Internet服务进行基于应用程序的负载均衡。 选项 "disable" "enable"
internet_service_app_ctrl 别名: internet-service-app-ctrl 任意	(列表) 基于应用程序控制的Internet服务ID列表。
internet_service_app_ctrl_category 别名: internet-service-app-ctrl-category 任意	(列表) 一个或多个应用程序控制类别的ID。
internet_service_app_ctrl_group 别名: internet-service-app-ctrl-group 任意	(列表或字符串) 基于应用程序控制的Internet服务组列表。
internet_service_custom 别名: internet-service-custom 任意	(列表或字符串) 自定义Internet服务名称列表。
internet_service_custom_group 别名: internet-service-custom-group 任意	(列表或字符串) 自定义Internet服务组列表。
internet_service_group 别名: internet-service-group 任意	(列表或字符串) Internet服务组列表。
internet_service_name 别名: internet-service-name 任意	(列表或字符串) Internet服务名称列表。
jitter_weight 别名: jitter-weight 整数	在自定义配置文件1公式中，抖动的系数。
latency_weight 别名: latency-weight 整数	在自定义配置文件1公式中，延迟的系数。
link_cost_factor 别名：link-cost-factor 字符串	链路成本因子。 选项 "latency" "jitter" "packet-loss" "入带宽" "出带宽" "双向带宽" "custom-profile-1"
link_cost_threshold 别名: link-cost-threshold 整数	链路成本值的百分比阈值变化，将导致策略路由重新生成。
load_balance 别名: load-balance 字符串	启用/禁用负载均衡。 选项 "disable" "enable"
minimum_sla_meet_members 别名: minimum-sla-meet-members 整数	满足SLA的最小成员数。
mode 字符串	控制SD-WAN规则如何设置SD-WAN中接口的优先级。 选项 "自动" "手动" "优先级" "sla" "负载均衡"
名称 字符串	SD-WAN规则名称。
packet_loss_weight 别名: packet-loss-weight 整数	在自定义配置文件1公式中，丢包率的系数。
passive_measurement 别名: passive-measurement 字符串	启用/禁用基于服务标准的被动测量。 选项 "disable" "enable"
priority_members 别名: priority-members 任意	(列表或字符串) 成员序号列表。
priority_zone 别名: priority-zone 任意	(列表或字符串) 优先区域名称列表。
协议 整数	协议号。
quality_link 别名: quality-link 整数	质量等级。
role 字符串	与邻居一起工作的服务角色。 选项 "primary" "secondary" "standalone"
route_tag 别名: route-tag 整数	IPv4路由映射路由标签。
快捷方式 字符串	启用/禁用此服务的快捷方式。 选项 "disable" "enable"
shortcut_priority 别名: shortcut-priority 字符串	此服务的ADVPN快捷方式的高优先级。 选项 "disable" "enable" "自动"
shortcut_stickiness 别名: shortcut-stickiness 字符串	启用/禁用ADVPN的快捷方式粘性。 选项 "disable" "enable"
SLA 列表 / 元素=字典	SLA。
health_check 别名：health-check 字符串	SD-WAN健康检查。
id 整数	SLA ID。
sla_compare_method 别名: sla-compare-method 字符串	比较SLA模式下SLA值的方法。 选项 "顺序" "数量"
sla_stickiness 别名: sla-stickiness 字符串	启用/禁用SLA粘性。 选项 "disable" "enable"
源地址 任意	(列表或字符串) 源地址名称。
源IPv6地址 任意	(列表或字符串) 源IPv6地址名称。
src_negate 别名: src-negate 字符串	启用/禁用源地址匹配的反转。 选项 "disable" "enable"
standalone_action 别名: standalone-action 字符串	当选择的邻居角色为独立模式而服务角色不是独立模式时，启用/禁用服务。 选项 "disable" "enable"
start_port 别名: start-port 整数	开始目标端口号。
start_src_port 别名: start-src-port 整数	开始源端口号。
status 字符串	启用/禁用SD-WAN服务。 选项 "disable" "enable"
tie_break 别名: tie-break 字符串	如果多个成员满足SLA，则选择成员的方法。 选项 "区域" "配置顺序" "FIB最佳匹配" "输入设备"
TOS 字符串	服务类型位模式。
tos_mask 别名: tos-mask 字符串	服务类型评估位。
use_shortcut_sla 别名: use-shortcut-sla 字符串	启用/禁用使用ADVPN快捷方式进行质量比较。 选项 "disable" "enable"
用户 任意	(列表或字符串) 用户名。
zone_mode 别名: zone-mode 字符串	启用/禁用区域模式。 选项 "disable" "enable"
speedtest_bypass_routing 别名：speedtest-bypass-routing 字符串	在SD-WAN成员上进行速度测试时，启用/禁用旁路路由。 选项 "disable" "enable"
status 字符串	启用/禁用SD-WAN。 选项 "disable" "enable"
zone 列表 / 元素=字典	区域。
advpn_health_check 别名：advpn-health-check 字符串	ADVPN本地覆盖链路质量的健康检查。
advpn_select 别名：advpn-select 字符串	启用/禁用基于SDWAN信息选择ADVPN。 选项 "disable" "enable"
minimum_sla_meet_members 别名: minimum-sla-meet-members 整数	邻居优先时，满足 SLA 的最小成员数。
名称 字符串	区域名称。
service_sla_tie_break 别名：service-sla-tie-break 字符串	如果多个成员满足SLA，则选择成员的方法。 选项 "配置顺序" "FIB最佳匹配" "输入设备"
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_sdwan:
        # 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_sdwan:
          duplication:
            -
              dstaddr: <list or string>
              dstaddr6: <list or string>
              dstintf: <list or string>
              id: <integer>
              packet_de_duplication: <value in [disable, enable]>
              packet_duplication: <value in [disable, force, on-demand]>
              service: <list or string>
              srcaddr: <list or string>
              srcaddr6: <list or string>
              srcintf: <list or string>
              service_id: <list or string>
              sla_match_service: <value in [disable, enable]>
          duplication_max_num: <integer>
          fail_detect: <value in [disable, enable]>
          health_check:
            -
              _dynamic_server: <string>
              addr_mode: <value in [ipv4, ipv6]>
              diffservcode: <string>
              dns_match_ip: <string>
              dns_request_domain: <string>
              failtime: <integer>
              ftp_file: <string>
              ftp_mode: <value in [passive, port]>
              ha_priority: <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>
              probe_count: <integer>
              probe_packets: <value in [disable, enable]>
              probe_timeout: <integer>
              protocol: <value in [ping, tcp-echo, udp-echo, ...]>
              quality_measured_method: <value in [half-close, half-open]>
              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"
                    - "mos"
                    - "remote"
                  packetloss_threshold: <integer>
                  mos_threshold: <string>
                  priority_in_sla: <integer>
                  priority_out_sla: <integer>
              sla_fail_log_period: <integer>
              sla_pass_log_period: <integer>
              system_dns: <value in [disable, enable]>
              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]>
              user: <string>
              detect_mode: <value in [active, passive, prefer-passive, ...]>
              mos_codec: <value in [g711, g722, g729]>
              source: <string>
              vrf: <integer>
              embed_measured_health: <value in [disable, enable]>
              sla_id_redistribute: <integer>
              class_id: <string>
              source6: <string>
          load_balance_mode: <value in [source-ip-based, weight-based, usage-based, ...]>
          members:
            -
              _dynamic_member: <string>
              comment: <string>
              cost: <integer>
              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>
              zone: <string>
              priority6: <integer>
              preferred_source: <string>
              transport_group: <integer>
              priority_in_sla: <integer>
              priority_out_sla: <integer>
          neighbor:
            -
              health_check: <string>
              ip: <string>
              member: <list or string>
              role: <value in [primary, secondary, standalone]>
              sla_id: <integer>
              minimum_sla_meet_members: <integer>
              mode: <value in [sla, speedtest]>
              service_id: <string>
          neighbor_hold_boot_time: <integer>
          neighbor_hold_down: <value in [disable, enable]>
          neighbor_hold_down_time: <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>
              hash_mode: <value in [round-robin, source-ip-based, source-dest-ip-based, ...]>
              health_check: <list or string>
              hold_down_time: <integer>
              id: <integer>
              input_device: <list or string>
              input_device_negate: <value in [disable, enable]>
              internet_service: <value in [disable, enable]>
              internet_service_app_ctrl: <list or integer>
              internet_service_app_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_name: <list or string>
              jitter_weight: <integer>
              latency_weight: <integer>
              link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
              link_cost_threshold: <integer>
              minimum_sla_meet_members: <integer>
              mode: <value in [auto, manual, priority, ...]>
              name: <string>
              packet_loss_weight: <integer>
              priority_members: <list or string>
              protocol: <integer>
              quality_link: <integer>
              role: <value in [primary, secondary, standalone]>
              route_tag: <integer>
              sla:
                -
                  health_check: <string>
                  id: <integer>
              sla_compare_method: <value in [order, number]>
              src: <list or string>
              src_negate: <value in [disable, enable]>
              src6: <list or string>
              standalone_action: <value in [disable, enable]>
              start_port: <integer>
              status: <value in [disable, enable]>
              tos: <string>
              tos_mask: <string>
              users: <list or string>
              tie_break: <value in [zone, cfg-order, fib-best-match, ...]>
              use_shortcut_sla: <value in [disable, enable]>
              input_zone: <list or string>
              internet_service_app_ctrl_category: <list or integer>
              passive_measurement: <value in [disable, enable]>
              priority_zone: <list or string>
              agent_exclusive: <value in [disable, enable]>
              shortcut: <value in [disable, enable]>
              shortcut_stickiness: <value in [disable, enable]>
              end_src_port: <integer>
              load_balance: <value in [disable, enable]>
              sla_stickiness: <value in [disable, enable]>
              start_src_port: <integer>
              zone_mode: <value in [disable, enable]>
              shortcut_priority: <value in [disable, enable, auto]>
              comment: <string>
          status: <value in [disable, enable]>
          zone:
            -
              name: <string>
              service_sla_tie_break: <value in [cfg-order, fib-best-match, input-device]>
              minimum_sla_meet_members: <integer>
              advpn_health_check: <string>
              advpn_select: <value in [disable, enable]>
          speedtest_bypass_routing: <value in [disable, enable]>
          fail_alert_interfaces: <list or string>
          app_perf_log_period: <integer>
          health_check_fortiguard:
            -
              addr_mode: <value in [ipv4, ipv6]>
              class_id: <list or string>
              detect_mode: <value in [active, passive, prefer-passive, ...]>
              diffservcode: <string>
              dns_match_ip: <string>
              dns_request_domain: <string>
              embed_measured_health: <value in [disable, enable]>
              failtime: <integer>
              ftp_file: <string>
              ftp_mode: <value in [passive, port]>
              ha_priority: <integer>
              http_agent: <string>
              http_get: <string>
              http_match: <string>
              interval: <integer>
              members: <list or string>
              mos_codec: <value in [g711, g722, g729]>
              packet_size: <integer>
              password: <list or string>
              port: <integer>
              probe_count: <integer>
              probe_packets: <value in [disable, enable]>
              probe_timeout: <integer>
              protocol: <value in [ping, tcp-echo, udp-echo, ...]>
              quality_measured_method: <value in [half-close, half-open]>
              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"
                    - "mos"
                    - "remote"
                  mos_threshold: <string>
                  packetloss_threshold: <integer>
                  priority_in_sla: <integer>
                  priority_out_sla: <integer>
              sla_fail_log_period: <integer>
              sla_id_redistribute: <integer>
              sla_pass_log_period: <integer>
              source: <string>
              source6: <string>
              system_dns: <value in [disable, enable]>
              target_name: <string>
              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]>
              user: <string>
              vrf: <integer>
          option:
            - "sdwan-overlay"
            - "sdwan-manager"

返回值

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

键	描述
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)

收藏链接

• 问题追踪器
• 主页
• 代码库 (源代码)