| source: | fortios_system_sdwan.py |
|---|---|
| orphan: |
fortios_system_sdwan -- Configure redundant Internet connections with multiple outbound links and health-check profiles in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sdwan category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.9
Using member operation to add an element to an existing object.
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.0.12 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
| fortios_system_sdwan | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- system_sdwan - Configure redundant Internet connections with multiple outbound links and health-check profiles. type: dict
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0system_sdwan yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - app_perf_log_period - Time interval in seconds that applicationperformance logs are generated (0 - 3600). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0app_perf_log_period no no no no no no no no no no no no no no no no no yes - duplication - Create SD-WAN duplication rule. type: list member_path: duplication:id
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0duplication yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dstaddr - Destination address or address group names. type: list member_path: duplication:id/dstaddr:name
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dstaddr yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Address or address group name. Source firewall.address.name firewall.addrgrp.name. type: str required: true
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dstaddr6 - Destination address6 or address6 group names. type: list member_path: duplication:id/dstaddr6:name
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dstaddr6 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dstintf - Outgoing (egress) interfaces or zones. type: list member_path: duplication:id/dstintf:name
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dstintf yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Interface, zone or SDWAN zone name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - id - Duplication rule ID (1 - 255). see Notes. type: int required: true
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0id yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - packet_de_duplication - Enable/disable discarding of packets that have been duplicated. type: str choices: enable, disable
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0packet_de_duplication yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - packet_duplication - Configure packet duplication method. type: str choices: disable, force, on-demand
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0packet_duplication yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [force] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [on-demand] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - service - Service and service group name. type: list member_path: duplication:id/service:name
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0service yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Service and service group name. Source firewall.service.custom.name firewall.service.group.name. type: str required: true
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - service_id - SD-WAN service rule ID list. type: list member_path: duplication:id/service_id:id
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0service_id no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - id - SD-WAN service rule ID. see Notes. Source system.sdwan.service.id. type: int required: true
more...
v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0id yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - sla_match_service - Enable/disable packet duplication matching health-check SLAs in service rule. type: str choices: enable, disable
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0sla_match_service no no no no no no no no no no no no yes yes yes yes yes [enable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes [disable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes - srcaddr - Source address or address group names. type: list member_path: duplication:id/srcaddr:name
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0srcaddr yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Address or address group name. Source firewall.address.name firewall.addrgrp.name. type: str required: true
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - srcaddr6 - Source address6 or address6 group names. type: list member_path: duplication:id/srcaddr6:name
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0srcaddr6 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - srcintf - Incoming (ingress) interfaces or zones. type: list member_path: duplication:id/srcintf:name
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0srcintf yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Interface, zone or SDWAN zone name. Source system.interface.name system.zone.name system.sdwan.zone.name. type: str required: true
more...
v6.4.0v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - duplication_max_num - Maximum number of interface members a packet is duplicated in the SD-WAN zone (2 - 4). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0duplication_max_num yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - fail_alert_interfaces - Physical interfaces that will be alerted. type: list member_path: fail_alert_interfaces:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0fail_alert_interfaces yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Physical interface name. Source system.interface.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - fail_detect - Enable/disable SD-WAN Internet connection status checking (failure detection). type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0fail_detect yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - health_check - SD-WAN status checking or health checking. Identify a server on the Internet and determine how SD-WAN verifies that the FortiGate can communicate with it. type: list member_path: health_check:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0health_check yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - addr_mode - Address mode (IPv4 or IPv6). type: str choices: ipv4, ipv6
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0addr_mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [ipv4] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [ipv6] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - class_id - Traffic class ID. Source firewall.traffic-class.class-id. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0class_id no no no no no no no no no no no no no no no no no yes - detect_mode - The mode determining how to detect the server. type: str choices: active, passive, prefer-passive, remote, agent-based
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0detect_mode no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [active] n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [passive] n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [prefer-passive] n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [remote] n/a n/a n/a no no no no no no no no no no no yes yes yes yes [agent-based] n/a n/a n/a no no no no no no no no no no no no no yes yes - diffservcode - Differentiated services code point (DSCP) in the IP header of the probe packet. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0diffservcode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dns_match_ip - Response IP expected from DNS server if the protocol is DNS. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dns_match_ip yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dns_request_domain - Fully qualified domain name to resolve for the DNS probe. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dns_request_domain yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - embed_measured_health - Enable/disable embedding measured health information. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0embed_measured_health no no no no no no no no no no no no no no yes yes yes yes [enable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes [disable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes - failtime - Number of failures before server is considered lost (1 - 3600). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0failtime yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - ftp_file - Full path and file name on the FTP server to download for FTP health-check to probe. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0ftp_file yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - ftp_mode - FTP mode. type: str choices: passive, port
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0ftp_mode yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [passive] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [port] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - ha_priority - HA election priority (1 - 50). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0ha_priority yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - http_agent - String in the http-agent field in the HTTP header. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0http_agent yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - http_get - URL used to communicate with the server if the protocol if the protocol is HTTP. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0http_get yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - http_match - Response string expected from the server if the protocol is HTTP. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0http_match yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - interval - Status check interval in milliseconds, or the time between attempting to connect to the server (20 - 3600*1000 msec). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0interval yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - members - Member sequence number list. type: list member_path: health_check:name/members:seq_num
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0members yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - seq_num - Member sequence number. see Notes. Source system.sdwan.members.seq-num. type: int required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0seq_num yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - mos_codec - Codec to use for MOS calculation . type: str choices: g711, g722, g729
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0mos_codec no no no no no no no no no no no no no yes yes yes yes yes [g711] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes [g722] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes [g729] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes yes yes yes - name - Status check or health check name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - packet_size - Packet size of a TWAMP test session. (124/158 - 1024) type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0packet_size yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - password - TWAMP controller password in authentication mode. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0password yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - port - Port number used to communicate with the server over the selected protocol (0 - 65535). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0port yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - probe_count - Number of most recent probes that should be used to calculate latency and jitter (5 - 30). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0probe_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - probe_packets - Enable/disable transmission of probe packets. type: str choices: disable, enable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0probe_packets yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - probe_timeout - Time to wait before a probe packet is considered lost (20 - 3600*1000 msec). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0probe_timeout yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - protocol - Protocol used to determine if the FortiGate can communicate with the server. type: str choices: ping, tcp-echo, udp-echo, http, twamp, dns, tcp-connect, ftp, ping6
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0protocol yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [ping] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [tcp-echo] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [udp-echo] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [http] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [twamp] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [dns] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [tcp-connect] yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [ftp] yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [ping6] no yes n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a - quality_measured_method - Method to measure the quality of tcp-connect. type: str choices: half-open, half-close
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0quality_measured_method yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [half-open] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [half-close] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - recoverytime - Number of successful responses received before server is considered recovered (1 - 3600). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0recoverytime yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - security_mode - Twamp controller security mode. type: str choices: none, authentication
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0security_mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [none] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [authentication] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - server - IP address or FQDN name of the server. type: list
- sla - Service level agreement (SLA). type: list member_path: health_check:name/sla:id
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0sla yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - id - SLA ID. see Notes. type: int required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0id yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - jitter_threshold - Jitter for SLA to make decision in milliseconds. (0 - 10000000). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0jitter_threshold yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - latency_threshold - Latency for SLA to make decision in milliseconds. (0 - 10000000). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0latency_threshold yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - link_cost_factor - Criteria on which to base link selection. type: list choices: latency, jitter, packet-loss, mos
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0link_cost_factor yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [latency] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [jitter] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [packet-loss] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [mos] no no no no no no no no no no no no no yes yes yes yes yes - mos_threshold - Minimum Mean Opinion Score for SLA to be marked as pass. (1.0 - 5.0). type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0mos_threshold no no no no no no no no no no no no no yes yes yes yes yes - packetloss_threshold - Packet loss for SLA to make decision in percentage. (0 - 100). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0packetloss_threshold yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - priority_in_sla - Value to be distributed into routing table when in-sla (0 - 65535). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0priority_in_sla no no no no no no no no no no no no no no yes yes yes yes - priority_out_sla - Value to be distributed into routing table when out-sla (0 - 65535). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0priority_out_sla no no no no no no no no no no no no no no yes yes yes yes - sla_fail_log_period - Time interval in seconds that SLA fail log messages will be generated (0 - 3600). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0sla_fail_log_period yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - sla_id_redistribute - Select the ID from the SLA sub-table. The selected SLA"s priority value will be distributed into the routing table (0 - 32). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0sla_id_redistribute no no no no no no no no no no no no no no yes yes yes yes - sla_pass_log_period - Time interval in seconds that SLA pass log messages will be generated (0 - 3600). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0sla_pass_log_period yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - source - Source IP address used in the health-check packet to the server. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0source no no no no no no no no no no no no no yes yes yes yes yes - source6 - Source IPv6 addressused in the health-check packet to server. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0source6 no no no no no no no no no no no no no no no no no yes - system_dns - Enable/disable system DNS as the probe server. type: str choices: disable, enable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0system_dns yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - threshold_alert_jitter - Alert threshold for jitter (ms). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0threshold_alert_jitter yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - threshold_alert_latency - Alert threshold for latency (ms). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0threshold_alert_latency yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - threshold_alert_packetloss - Alert threshold for packet loss (percentage). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0threshold_alert_packetloss yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - threshold_warning_jitter - Warning threshold for jitter (ms). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0threshold_warning_jitter yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - threshold_warning_latency - Warning threshold for latency (ms). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0threshold_warning_latency yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - threshold_warning_packetloss - Warning threshold for packet loss (percentage). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0threshold_warning_packetloss yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - update_cascade_interface - Enable/disable update cascade interface. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0update_cascade_interface yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - update_static_route - Enable/disable updating the static route. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0update_static_route yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - user - The user name to access probe server. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0user yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - vrf - Virtual Routing Forwarding ID. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0vrf no no no no no no no no no no no no no yes yes yes yes yes - load_balance_mode - Algorithm or mode to use for load balancing Internet traffic to SD-WAN members. type: str choices: source-ip-based, weight-based, usage-based, source-dest-ip-based, measured-volume-based
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0load_balance_mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [source-ip-based] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [weight-based] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [usage-based] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [source-dest-ip-based] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [measured-volume-based] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - members - FortiGate interfaces added to the SD-WAN. type: list member_path: members:seq_num
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0members yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - comment - Comments. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0comment yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - cost - Cost of this interface for services in SLA mode (0 - 4294967295). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0cost yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - gateway - The default gateway for this interface. Usually the default gateway of the Internet service provider that this interface is connected to. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0gateway yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - gateway6 - IPv6 gateway. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0gateway6 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - ingress_spillover_threshold - Ingress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0ingress_spillover_threshold yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - interface - Interface name. Source system.interface.name. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0interface yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - preferred_source - Preferred source of route for this member. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0preferred_source no no no no no no no no no no no no no no no no no yes - priority - Priority of the interface for IPv4 (1 - 65535). Used for SD-WAN rules or priority rules. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0priority yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - priority6 - Priority of the interface for IPv6 (1 - 65535). Used for SD-WAN rules or priority rules. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0priority6 no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - seq_num - Sequence number(1-512). see Notes. type: int required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0seq_num yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - source - Source IP address used in the health-check packet to the server. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0source yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - source6 - Source IPv6 address used in the health-check packet to the server. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0source6 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - spillover_threshold - Egress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0spillover_threshold yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - status - Enable/disable this interface in the SD-WAN. type: str choices: disable, enable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0status yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - volume_ratio - Measured volume ratio (this value / sum of all values = percentage of link volume, 1 - 255). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0volume_ratio yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - weight - Weight of this interface for weighted load balancing. (1 - 255) More traffic is directed to interfaces with higher weights. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0weight yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - zone - Zone name. Source system.sdwan.zone.name. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0zone yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - neighbor - Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status. type: list member_path: neighbor:ip
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0neighbor yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - health_check - SD-WAN health-check name. Source system.sdwan.health-check.name. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0health_check yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - ip - IP/IPv6 address of neighbor. Source router.bgp.neighbor.ip. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0ip yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - member - Member sequence number list. Source system.sdwan.members.seq-num. type: list member_path: neighbor:ip/member:seq_num
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0member yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - seq_num - Member sequence number. see Notes. Source system.sdwan.members.seq-num. type: int required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0seq_num no no no no no no no no no no no no no yes yes yes yes yes - minimum_sla_meet_members - Minimum number of members which meet SLA when the neighbor is preferred. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0minimum_sla_meet_members no no no no no no no no no no no no no yes yes yes yes yes - mode - What metric to select the neighbor. type: str choices: sla, speedtest
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0mode no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes [sla] n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes [speedtest] n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes - role - Role of neighbor. type: str choices: standalone, primary, secondary
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0role yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [standalone] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [primary] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [secondary] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - sla_id - SLA ID. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0sla_id yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - neighbor_hold_boot_time - Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. (0 - 10000000). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0neighbor_hold_boot_time yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - neighbor_hold_down - Enable/disable hold switching from the secondary neighbor to the primary neighbor. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0neighbor_hold_down yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - neighbor_hold_down_time - Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. (0 - 10000000). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0neighbor_hold_down_time yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - service - Create SD-WAN rules (also called services) to control how sessions are distributed to interfaces in the SD-WAN. type: list member_path: service:id
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0service yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - addr_mode - Address mode (IPv4 or IPv6). type: str choices: ipv4, ipv6
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0addr_mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [ipv4] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [ipv6] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - agent_exclusive - Set/unset the service as agent use exclusively. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0agent_exclusive no no no no no no no no no no no no no no no no yes yes [enable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes [disable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes yes - bandwidth_weight - Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0bandwidth_weight yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - default - Enable/disable use of SD-WAN as default service. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0default yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dscp_forward - Enable/disable forward traffic DSCP tag. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dscp_forward yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dscp_forward_tag - Forward traffic DSCP tag. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dscp_forward_tag yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dscp_reverse - Enable/disable reverse traffic DSCP tag. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dscp_reverse yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dscp_reverse_tag - Reverse traffic DSCP tag. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dscp_reverse_tag yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dst - Destination address name. type: list member_path: service:id/dst:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dst yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Address or address group name. Source firewall.address.name firewall.addrgrp.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dst_negate - Enable/disable negation of destination address match. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dst_negate yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - dst6 - Destination address6 name. type: list member_path: service:id/dst6:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0dst6 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - end_port - End destination port number. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0end_port yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - gateway - Enable/disable SD-WAN service gateway. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0gateway yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - groups - User groups. type: list member_path: service:id/groups:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0groups yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Group name. Source user.group.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - hash_mode - Hash algorithm for selected priority members for load balance mode. type: str choices: round-robin, source-ip-based, source-dest-ip-based, inbandwidth, outbandwidth, bibandwidth
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0hash_mode yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [round-robin] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [source-ip-based] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [source-dest-ip-based] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [inbandwidth] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [outbandwidth] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [bibandwidth] yes n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - health_check - Health check list. type: list member_path: service:id/health_check:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0health_check yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Health check name. Source system.sdwan.health-check.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - hold_down_time - Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0hold_down_time yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - id - SD-WAN rule ID (1 - 4000). see Notes. type: int required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0id yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - input_device - Source interface name. type: list member_path: service:id/input_device:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0input_device yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Interface name. Source system.interface.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - input_device_negate - Enable/disable negation of input device match. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0input_device_negate yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - input_zone - Source input-zone name. type: list member_path: service:id/input_zone:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0input_zone no no no no no no no no no no no no no yes yes yes yes yes - name - Zone. Source system.sdwan.zone.name. type: str required: true
more...
v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes - internet_service - Enable/disable use of Internet service for application-based load balancing. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0internet_service yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - internet_service_app_ctrl - Application control based Internet Service ID list. type: list member_path: service:id/internet_service_app_ctrl:id
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0internet_service_app_ctrl yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - id - Application control based Internet Service ID. see Notes. type: int required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0id yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - internet_service_app_ctrl_category - IDs of one or more application control categories. type: list member_path: service:id/internet_service_app_ctrl_category:id
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0internet_service_app_ctrl_category no no no no no no no no no no no no no yes yes yes yes yes - id - Application control category ID. see Notes. type: int required: true
more...
v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0id yes yes yes yes yes - internet_service_app_ctrl_group - Application control based Internet Service group list. type: list member_path: service:id/internet_service_app_ctrl_group:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0internet_service_app_ctrl_group yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Application control based Internet Service group name. Source application.group.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - internet_service_custom - Custom Internet service name list. type: list member_path: service:id/internet_service_custom:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0internet_service_custom yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Custom Internet service name. Source firewall.internet-service-custom.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - internet_service_custom_group - Custom Internet Service group list. type: list member_path: service:id/internet_service_custom_group:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0internet_service_custom_group yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - internet_service_group - Internet Service group list. type: list member_path: service:id/internet_service_group:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0internet_service_group yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - internet_service_name - Internet service name list. type: list member_path: service:id/internet_service_name:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0internet_service_name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Internet service name. Source firewall.internet-service-name.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - jitter_weight - Coefficient of jitter in the formula of custom-profile-1. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0jitter_weight yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - latency_weight - Coefficient of latency in the formula of custom-profile-1. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0latency_weight yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - link_cost_factor - Link cost factor. type: str choices: latency, jitter, packet-loss, inbandwidth, outbandwidth, bibandwidth, custom-profile-1
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0link_cost_factor yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [latency] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [jitter] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [packet-loss] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [inbandwidth] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [outbandwidth] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [bibandwidth] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [custom-profile-1] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - link_cost_threshold - Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000). type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0link_cost_threshold yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - minimum_sla_meet_members - Minimum number of members which meet SLA. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0minimum_sla_meet_members yes no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - mode - Control how the SD-WAN rule sets the priority of interfaces in the SD-WAN. type: str choices: auto, manual, priority, sla, load-balance
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [auto] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [manual] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [priority] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [sla] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [load-balance] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - SD-WAN rule name. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - packet_loss_weight - Coefficient of packet-loss in the formula of custom-profile-1. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0packet_loss_weight yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - passive_measurement - Enable/disable passive measurement based on the service criteria. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0passive_measurement no no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] n/a n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes - priority_members - Member sequence number list. type: list member_path: service:id/priority_members:seq_num
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0priority_members yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - seq_num - Member sequence number. see Notes. Source system.sdwan.members.seq-num. type: int required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0seq_num yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - priority_zone - Priority zone name list. type: list member_path: service:id/priority_zone:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0priority_zone no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Priority zone name. Source system.sdwan.zone.name. type: str required: true
more...
v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes - protocol - Protocol number. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0protocol yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - quality_link - Quality grade. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0quality_link yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - role - Service role to work with neighbor. type: str choices: standalone, primary, secondary
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0role yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [standalone] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [primary] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [secondary] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - route_tag - IPv4 route map route-tag. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4route_tag yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - shortcut - Enable/disable shortcut for this service. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0shortcut no no no no no no no no no no no no no no no no no yes [enable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes [disable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes - shortcut_stickiness - Enable/disable shortcut-stickiness of ADVPN. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0shortcut_stickiness no no no no no no no no no no no no no no no no no yes [enable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes [disable] n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a n/a yes - sla - Service level agreement (SLA). type: list member_path: service:id/sla:health_check
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0sla yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - health_check - SD-WAN health-check. Source system.sdwan.health-check.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0health_check yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - id - SLA ID. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0id yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - sla_compare_method - Method to compare SLA value for SLA mode. type: str choices: order, number
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0sla_compare_method yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [order] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [number] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - src - Source address name. type: list member_path: service:id/src:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0src yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Address or address group name. Source firewall.address.name firewall.addrgrp.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - src_negate - Enable/disable negation of source address match. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0src_negate yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - src6 - Source address6 name. type: list member_path: service:id/src6:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0src6 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - standalone_action - Enable/disable service when selected neighbor role is standalone while service role is not standalone. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0standalone_action yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - start_port - Start destination port number. type: int
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0start_port yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - status - Enable/disable SD-WAN service. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0status yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - tie_break - Method of selecting member if more than one meets the SLA. type: str choices: zone, cfg-order, fib-best-match, input-device
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0tie_break no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [zone] n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [cfg-order] n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [fib-best-match] n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [input-device] n/a n/a no no no no no no no no no no no yes yes yes yes yes - tos - Type of service bit pattern. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0tos yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - tos_mask - Type of service evaluated bits. type: str
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0tos_mask yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - use_shortcut_sla - Enable/disable use of ADVPN shortcut for quality comparison. type: str choices: enable, disable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0use_shortcut_sla no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - users - User name. type: list member_path: service:id/users:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0users yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - User name. Source user.local.name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - speedtest_bypass_routing - Enable/disable bypass routing when speedtest on a SD-WAN member. type: str choices: disable, enable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0speedtest_bypass_routing no no no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] n/a n/a n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes - status - Enable/disable SD-WAN. type: str choices: disable, enable
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0status yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - zone - Configure SD-WAN zones. type: list member_path: zone:name
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0zone yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - name - Zone name. type: str required: true
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0name yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes - service_sla_tie_break - Method of selecting member if more than one meets the SLA. type: str choices: cfg-order, fib-best-match, input-device
more...
v6.4.0v6.4.1v6.4.4v7.0.0v7.0.1v7.0.2v7.0.3v7.0.4v7.0.5v7.0.6v7.0.7v7.0.8v7.0.12v7.2.0v7.2.1v7.2.2v7.2.4v7.4.0service_sla_tie_break no no yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [cfg-order] n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [fib-best-match] n/a n/a yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes [input-device] n/a n/a no no no no no no no no no no no yes yes yes yes yes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure redundant Internet connections with multiple outbound links and health-check profiles.
fortios_system_sdwan:
vdom: "{{ vdom }}"
system_sdwan:
app_perf_log_period: "0"
duplication:
-
dstaddr:
-
name: "default_name_6 (source firewall.address.name firewall.addrgrp.name)"
dstaddr6:
-
name: "default_name_8 (source firewall.address6.name firewall.addrgrp6.name)"
dstintf:
-
name: "default_name_10 (source system.interface.name system.zone.name system.sdwan.zone.name)"
id: "11"
packet_de_duplication: "enable"
packet_duplication: "disable"
service:
-
name: "default_name_15 (source firewall.service.custom.name firewall.service.group.name)"
service_id:
-
id: "17 (source system.sdwan.service.id)"
sla_match_service: "enable"
srcaddr:
-
name: "default_name_20 (source firewall.address.name firewall.addrgrp.name)"
srcaddr6:
-
name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name)"
srcintf:
-
name: "default_name_24 (source system.interface.name system.zone.name system.sdwan.zone.name)"
duplication_max_num: "2"
fail_alert_interfaces:
-
name: "default_name_27 (source system.interface.name)"
fail_detect: "enable"
health_check:
-
addr_mode: "ipv4"
class_id: "0"
detect_mode: "active"
diffservcode: "<your_own_value>"
dns_match_ip: "<your_own_value>"
dns_request_domain: "<your_own_value>"
embed_measured_health: "enable"
failtime: "5"
ftp_file: "<your_own_value>"
ftp_mode: "passive"
ha_priority: "1"
http_agent: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "500"
members:
-
seq_num: "<you_own_value>"
mos_codec: "g711"
name: "default_name_48"
packet_size: "124"
password: "<your_own_value>"
port: "0"
probe_count: "30"
probe_packets: "disable"
probe_timeout: "500"
protocol: "ping"
quality_measured_method: "half-open"
recoverytime: "5"
security_mode: "none"
server: "192.168.100.40"
sla:
-
id: "61"
jitter_threshold: "5"
latency_threshold: "5"
link_cost_factor: "latency"
mos_threshold: "<your_own_value>"
packetloss_threshold: "0"
priority_in_sla: "0"
priority_out_sla: "0"
sla_fail_log_period: "0"
sla_id_redistribute: "0"
sla_pass_log_period: "0"
source: "<your_own_value>"
source6: "<your_own_value>"
system_dns: "disable"
threshold_alert_jitter: "0"
threshold_alert_latency: "0"
threshold_alert_packetloss: "0"
threshold_warning_jitter: "0"
threshold_warning_latency: "0"
threshold_warning_packetloss: "0"
update_cascade_interface: "enable"
update_static_route: "enable"
user: "<your_own_value>"
vrf: "0"
load_balance_mode: "source-ip-based"
members:
-
comment: "Comments."
cost: "0"
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
ingress_spillover_threshold: "0"
interface: "<your_own_value> (source system.interface.name)"
preferred_source: "<your_own_value>"
priority: "1"
priority6: "1024"
seq_num: "<you_own_value>"
source: "<your_own_value>"
source6: "<your_own_value>"
spillover_threshold: "0"
status: "disable"
volume_ratio: "1"
weight: "1"
zone: "<your_own_value> (source system.sdwan.zone.name)"
neighbor:
-
health_check: "<your_own_value> (source system.sdwan.health-check.name)"
ip: "<your_own_value> (source router.bgp.neighbor.ip)"
member:
-
seq_num: "<you_own_value>"
minimum_sla_meet_members: "1"
mode: "sla"
role: "standalone"
sla_id: "0"
neighbor_hold_boot_time: "0"
neighbor_hold_down: "enable"
neighbor_hold_down_time: "0"
service:
-
addr_mode: "ipv4"
agent_exclusive: "enable"
bandwidth_weight: "0"
default: "enable"
dscp_forward: "enable"
dscp_forward_tag: "<your_own_value>"
dscp_reverse: "enable"
dscp_reverse_tag: "<your_own_value>"
dst:
-
name: "default_name_126 (source firewall.address.name firewall.addrgrp.name)"
dst_negate: "enable"
dst6:
-
name: "default_name_129 (source firewall.address6.name firewall.addrgrp6.name)"
end_port: "65535"
gateway: "enable"
groups:
-
name: "default_name_133 (source user.group.name)"
hash_mode: "round-robin"
health_check:
-
name: "default_name_136 (source system.sdwan.health-check.name)"
hold_down_time: "0"
id: "138"
input_device:
-
name: "default_name_140 (source system.interface.name)"
input_device_negate: "enable"
input_zone:
-
name: "default_name_143 (source system.sdwan.zone.name)"
internet_service: "enable"
internet_service_app_ctrl:
-
id: "146"
internet_service_app_ctrl_category:
-
id: "148"
internet_service_app_ctrl_group:
-
name: "default_name_150 (source application.group.name)"
internet_service_custom:
-
name: "default_name_152 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_154 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_156 (source firewall.internet-service-group.name)"
internet_service_name:
-
name: "default_name_158 (source firewall.internet-service-name.name)"
jitter_weight: "0"
latency_weight: "0"
link_cost_factor: "latency"
link_cost_threshold: "10"
minimum_sla_meet_members: "0"
mode: "auto"
name: "default_name_165"
packet_loss_weight: "0"
passive_measurement: "enable"
priority_members:
-
seq_num: "<you_own_value>"
priority_zone:
-
name: "default_name_171 (source system.sdwan.zone.name)"
protocol: "0"
quality_link: "0"
role: "standalone"
route_tag: "0"
shortcut: "enable"
shortcut_stickiness: "enable"
sla:
-
health_check: "<your_own_value> (source system.sdwan.health-check.name)"
id: "180"
sla_compare_method: "order"
src:
-
name: "default_name_183 (source firewall.address.name firewall.addrgrp.name)"
src_negate: "enable"
src6:
-
name: "default_name_186 (source firewall.address6.name firewall.addrgrp6.name)"
standalone_action: "enable"
start_port: "1"
status: "enable"
tie_break: "zone"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
use_shortcut_sla: "enable"
users:
-
name: "default_name_195 (source user.local.name)"
speedtest_bypass_routing: "disable"
status: "disable"
zone:
-
name: "default_name_199"
service_sla_tie_break: "cfg-order"
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.