fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service 模块 – 创建 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_service。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。
参数
参数 |
注释 |
|---|---|
用于在不使用用户名和密码的情况下访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。 选项
|
|
启用/禁用任务的日志记录。 选项
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
覆盖底层 Json RPC 请求的方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
请求 URL 中的参数 (wanprof)。 |
|
顶层参数集。 |
|
地址模式 选项
|
|
在自定义配置文件 1 的公式中，可用双向带宽倒数的系数。 |
|
启用/禁用将 SD-WAN 用作默认服务。 选项
|
|
启用/禁用转发流量 DSCP 标记。 选项
|
|
转发流量 DSCP 标记。 |
|
启用/禁用反向流量 DSCP 标记。 选项
|
|
反向流量 DSCP 标记。 |
|
（列表或字符串）目标地址名称。 |
|
（列表或字符串）目标地址 6 名称。 |
|
启用/禁用目标地址匹配的否定。 选项
|
|
目标端口号的末尾。 |
|
启用/禁用 SD-WAN 服务网关。 选项
|
|
（列表或字符串）用户组。 |
|
健康检查。 |
|
从备份成员切换到主成员时的等待时间（以秒为单位） |
|
优先级规则 ID |
|
（列表或字符串）源接口名称。 |
|
启用/禁用输入设备匹配的否定。 选项
|
|
启用/禁用使用 Internet 服务进行基于应用程序的负载均衡。 选项
|
|
（列表）基于应用程序控制的 Internet 服务 ID 列表。 |
|
（列表或字符串）基于应用程序控制的 Internet 服务组列表。 |
|
（列表）基于控制的 Internet 服务 ID 列表。 |
|
（列表或字符串）基于控制的 Internet 服务组列表。 |
|
（列表或字符串）自定义 Internet 服务名称列表。 |
|
（列表或字符串）自定义 Internet 服务组列表。 |
|
（列表或字符串）Internet 服务组列表。 |
|
（列表或字符串）Internet 服务 ID 列表。 |
|
互联网服务名称列表。 |
|
自定义配置文件 1 公式中抖动的系数。 |
|
自定义配置文件 1 公式中延迟的系数。 |
|
链路成本因子。 选项
|
|
链路成本值变化的百分比阈值，这将导致策略路由重新生成 |
|
成员序列号。 |
|
控制优先级规则如何在 SD-WAN 中设置接口的优先级。 选项
|
|
优先级规则名称。 |
|
自定义配置文件 1 公式中丢包的系数。 |
|
(列表或字符串) 成员序列号列表。 |
|
协议号。 |
|
质量等级。 |
|
与邻居协同工作的服务角色。 选项
|
|
IPv4 路由映射路由标签。 |
|
SLA。 |
|
虚拟 WAN 链路健康检查。 |
|
SLA ID。 |
|
在 SLA 和负载均衡模式下比较 SLA 值的方法。 选项
|
|
(列表或字符串) 源地址名称。 |
|
(列表或字符串) 源地址6 名称。 |
|
启用/禁用源地址匹配的否定。 选项
|
|
当选择的邻居角色为独立，而服务角色不是独立时，启用/禁用服务。 选项
|
|
起始目标端口号。 |
|
启用/禁用 SD-WAN 服务。 选项
|
|
服务类型位模式。 |
|
服务类型评估位。 |
|
(列表或字符串) 用户名。 |
|
在工作区模式下运行时，要锁定的 FortiManager 的 ADOM，该值可以是全局值和其他值，包括 root。 |
|
等待其他用户释放工作区锁的最长时间（以秒为单位）。 默认值: |
备注
注意
从 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: Create SD-WAN rules or priority rules
fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service:
# 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_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]>
返回值
常见的返回值记录在 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 总是 |
|
请求的完整 URL。 返回: 总是 示例: |
|
API 请求的状态。 返回: 总是 示例: |
|
API 响应。 返回: 总是 |
|
API 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。 返回: 复杂 |