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。
要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包含所有需要在使用前调整为数据源的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务的日志记录。 选项
|
|
使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
请求 URL 中的参数 (wanprof)。 |
|
设置的顶级参数。 |
|
(列表) 将被告警的物理接口。 |
|
启用/禁用 SD-WAN 互联网连接状态检查 选项
|
|
健康检查。 |
|
动态服务器。 |
|
地址模式 选项
|
|
差异化服务代码点 |
|
要为 DNS 探测解析的完全限定域名。 |
|
服务器被认为丢失之前的失败次数 |
|
HA 选举优先级 |
|
HTTP 标头中 http-agent 字段中的字符串。 |
|
如果协议是 HTTP，则用于与服务器通信的 URL。 |
|
如果协议是 HTTP，则服务器预期的响应字符串。 |
|
互联网服务 ID。 |
|
状态检查间隔，或尝试连接到服务器之间的时间 |
|
(列表或字符串) 成员序列号列表。 |
|
状态检查或健康检查名称。 |
|
Twamp 测试会话的数据包大小， |
|
(列表) 身份验证模式下的 Twamp 控制器密码 |
|
用于通过所选协议与服务器通信的端口号。 |
|
应用于计算延迟和抖动的最新探测数量 |
|
启用/禁用探测数据包的传输。 选项
|
|
在探测数据包被认为丢失之前要等待的时间 |
|
用于确定 FortiGate 是否可以与服务器通信的协议。 选项
|
|
服务器被认为恢复之前收到的成功响应次数 |
|
TWAMP 控制器安全模式。 选项
|
|
(列表) 服务器的IP地址或FQDN名称。 |
|
SLA。 |
|
SLA ID。 |
|
SLA 抖动决策阈值（毫秒）。 |
|
SLA 延迟决策阈值（毫秒）。 |
|
用于链路选择的标准。 选项
|
|
SLA 丢包率决策阈值（百分比）。 |
|
生成 SLA 失败日志消息的时间间隔（秒）。 |
|
生成 SLA 成功日志消息的时间间隔（秒）。 |
|
启用/禁用系统 DNS 作为探测服务器。 选项
|
|
抖动告警阈值。 |
|
延迟告警阈值。 |
|
丢包率告警阈值。 |
|
抖动警告阈值。 |
|
延迟警告阈值。 |
|
丢包率警告阈值。 |
|
在未收到服务器回复之前等待多长时间才认为连接尝试失败。 |
|
启用/禁用更新级联接口。 选项
|
|
启用/禁用更新静态路由。 选项
|
|
用于将互联网流量负载均衡到 SD-WAN 成员的算法或模式。 选项
|
|
成员。 |
|
动态成员。 |
|
注释。 |
|
在 SLA 模式下，此接口的服务成本。 |
|
此接口的默认网关。 |
|
IPv6 网关。 |
|
此接口的入站溢出阈值。 |
|
接口名称。 |
|
接口优先级。 |
|
序列号。 |
|
用于发送健康检查数据包到服务器的源 IP 地址。 |
|
用于发送健康检查数据包到服务器的源 IPv6 地址。 |
|
此接口的出站溢出阈值。 |
|
启用/禁用 SD-WAN 中的此接口。 选项
|
|
测量的流量比率。 |
|
此接口的加权负载均衡权重。 |
|
邻居。 |
|
SD-WAN 健康检查名称。 |
|
邻居的IP地址。 |
|
成员序列号。 |
|
邻居的角色。 选项
|
|
SLA ID。 |
|
从邻居启动时，从主邻居切换到备用邻居的等待时间（秒）。 |
|
启用/禁用从备用邻居切换到主邻居的保持切换。 选项
|
|
禁用保持时，从备用邻居切换到主邻居的等待时间（秒）。 |
|
服务。 |
|
地址模式 选项
|
|
在自定义配置文件 1 公式中，可用双向带宽倒数的系数。 |
|
启用/禁用使用 SD-WAN 作为默认服务。 选项
|
|
启用/禁用转发流量 DSCP 标记。 选项
|
|
转发流量 DSCP 标记。 |
|
启用/禁用反向流量 DSCP 标记。 选项
|
|
反向流量 DSCP 标记。 |
|
(列表或字符串) 目的地址名称。 |
|
(列表或字符串) 目的地址 6 名称。 |
|
启用/禁用目的地址匹配的反向。 选项
|
|
结束目的端口号。 |
|
启用/禁用 SD-WAN 服务网关。 选项
|
|
(列表或字符串) 用户组。 |
|
健康检查。 |
|
从备份成员切换到主成员的等待时间（秒）。 |
|
优先级规则 ID。 |
|
(列表或字符串) 源接口名称。 |
|
启用/禁用输入设备匹配的反向。 选项
|
|
启用/禁用使用 Internet 服务进行基于应用程序的负载均衡。 选项
|
|
(列表) 基于应用程序控制的 Internet 服务 ID 列表。 |
|
(列表或字符串) 基于应用程序控制的 Internet 服务组列表。 |
|
(列表) 基于控制的 Internet 服务 ID 列表。 |
|
(列表或字符串) 基于控制的 Internet 服务组列表。 |
|
(列表或字符串) 自定义 Internet 服务名称列表。 |
|
(列表或字符串) 自定义互联网服务组列表。 |
|
(列表或字符串) 互联网服务组列表。 |
|
(列表或字符串) 互联网服务ID列表。 |
|
互联网服务名称列表。 |
|
自定义配置文件1公式中抖动的系数。 |
|
自定义配置文件1公式中延迟的系数。 |
|
链路成本系数。 选项
|
|
链路成本值变化的百分比阈值，将导致策略路由重新生成。 |
|
成员序列号。 |
|
控制优先级规则如何设置SD-WAN中接口的优先级。 选项
|
|
优先级规则名称。 |
|
自定义配置文件1公式中丢包率的系数。 |
|
(列表或字符串) 成员序列号列表。 |
|
协议号。 |
|
质量等级。 |
|
与邻居一起工作的服务角色。 选项
|
|
IPv4路由映射路由标签。 |
|
SLA。 |
|
虚拟WAN链路健康检查。 |
|
SLA ID。 |
|
比较SLA值的方法，用于sla和负载均衡模式。 选项
|
|
(列表或字符串) 源地址名称。 |
|
(列表或字符串) 源地址6名称。 |
|
启用/禁用源地址匹配的反转。 选项
|
|
当选择的邻居角色为独立角色而服务角色不为独立角色时，启用/禁用服务。 选项
|
|
起始目标端口号。 |
|
启用/禁用SD-WAN服务。 选项
|
|
服务类型位模式。 |
|
服务类型评估位。 |
|
(列表或字符串) 用户名。 |
|
启用/禁用SD-WAN。 选项
|
|
在工作区模式下运行FortiManager时要锁定的ADOM，该值可以是global和其他包括root。 |
|
等待其他用户释放工作区锁的最大时间（秒）。 默认值: |
注释
注意
从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>
返回值
常用的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 始终 |
|
请求的完整URL。 返回: 始终 示例: |
|
API请求的状态。 返回: 始终 示例: |
|
API响应。 返回: 始终 |
|
API响应的描述性消息。 返回: 始终 示例: |
|
目标系统的信息。 返回: 始终 |
|
请求的状态。 返回: 始终 示例: |
|
如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回: 复杂 |