fortinet.fortimanager.fmgr_wanprof_system_sdwan_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_sdwan_service。
fortinet.fortimanager 2.1.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 服务网关。 选项
|
|
(列表或字符串) 用户组。 |
|
为负载均衡模式选择的优先成员的哈希算法。 选项
|
|
(列表或字符串) 健康检查列表。 |
|
从备份成员切换到主成员时的等待时间（秒）。 |
|
SD-WAN 规则 ID |
|
(列表或字符串) 源接口名称。 |
|
启用/禁用输入设备匹配的否定。 选项
|
|
(列表) 源输入区域名称。 |
|
启用/禁用使用 Internet 服务进行基于应用程序的负载均衡。 选项
|
|
(列表) 基于应用程序控制的 Internet 服务 ID 列表。 |
|
(列表) 一个或多个应用程序控制类别的 ID。 |
|
(列表或字符串) 基于应用程序控制的 Internet 服务组列表。 |
|
(列表或字符串) 自定义 Internet 服务名称列表。 |
|
(列表或字符串) 自定义互联网服务组列表。 |
|
(列表或字符串) 互联网服务组列表。 |
|
(列表或字符串) 互联网服务名称列表。 |
|
自定义配置文件1公式中抖动的系数。 |
|
自定义配置文件1公式中延迟的系数。 |
|
链路成本因子。 选项
|
|
链路成本值变化的百分比阈值，将导致策略路由重新生成。 |
|
启用/禁用负载均衡。 选项
|
|
满足SLA的最小成员数量。 |
|
控制SD-WAN规则如何设置SD-WAN中接口的优先级。 选项
|
|
SD-WAN规则名称。 |
|
自定义配置文件1公式中丢包率的系数。 |
|
基于服务标准启用/禁用被动测量。 选项
|
|
(列表或字符串) 成员序列号列表。 |
|
(列表或字符串) 优先级区域名称列表。 |
|
协议号。 |
|
质量等级。 |
|
与邻居一起工作的服务角色。 选项
|
|
IPv4 路由映射路由标签。 |
|
启用/禁用此服务的快捷方式。 选项
|
|
此服务的ADVPN快捷方式的高优先级。 选项
|
|
启用/禁用ADVPN的快捷方式粘性。 选项
|
|
SLA。 |
|
SD-WAN健康检查。 |
|
SLA ID。 |
|
比较SLA模式下SLA值的方法。 选项
|
|
启用/禁用SLA粘性。 选项
|
|
(列表或字符串) 源地址名称。 |
|
(列表或字符串) 源地址6名称。 |
|
启用/禁用源地址匹配的反转。 选项
|
|
当选择的邻居角色为独立模式而服务角色不是独立模式时，启用/禁用服务。 选项
|
|
起始目标端口号。 |
|
起始源端口号。 |
|
启用/禁用SD-WAN服务。 选项
|
|
如果多个成员满足SLA，则选择成员的方法。 选项
|
|
服务类型位模式。 |
|
评估的服务类型位。 |
|
启用/禁用使用ADVPN快捷方式进行质量比较。 选项
|
|
(列表或字符串) 用户名。 |
|
启用/禁用区域模式。 选项
|
|
在工作区模式下运行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
fortinet.fortimanager.fmgr_wanprof_system_sdwan_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_sdwan_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>
返回值
常用返回值已在此处记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
请求的结果。 返回值：始终 |
|
请求的完整URL。 返回值：始终 示例： |
|
API请求的状态。 返回值：始终 示例： |
|
API响应。 返回值：始终 |
|
API响应的描述性消息。 返回值：始终 示例： |
|
目标系统的信息。 返回值：始终 |
|
请求的状态。 返回值：始终 示例： |
|
如果剧本中使用的参数不受当前FortiManager版本支持，则发出警告。 返回值：复杂 |