add steering-object

In the R81.10.X releases, this command is available starting from the R81.10.10 version.

Description

Adds a steering behavior object.

See also:

Syntax

add steering-object

name "<Name>"

comment "<Text>"

candidates-selected

all

specific

add candidate <Name of Internet Connection>

additional-candidate <Name of Internet Connection>

<the same parameters as for 'steering-object'>

jitter <0-10000>

latency <0-10000>

link-utilization {link-aggregation | prioritize}

packet-loss <0-100>

probing-host <IPv4 Address or Hostname>

second-probing-host <IPv4 Address or Hostname>

third-probing-host <IPv4 Address or Hostname>

probing-interval <500-4294967295>

probing-mode {best | average | worst}

selection-method <Method>

Parameters

Parameter	Description
name	Specifies the name of the SD-WAN steering object. A string that begins with a letter and contains up to 32 characters, of this set: `a-z` (lower-case letters) `A-Z` (upper-case letters) `0-9` (digits) '`.`' (period) '`-`' (minus) '`~`' (tilde) ' ' (space)
comment	Optional: Specifies the comment text for the SD-WAN rule. A string that contains less than 257 characters, of this set: `a-z` (lower-case letters) `A-Z` (upper-case letters) `0-9` (digits) '`,`' (comma) '`.`' (period) '`-`' (minus) '`(`' (opening round bracket) '`)`' (closing round bracket) '`:`' (colon) '`@`' (at)
candidates-selected	Specifies the ISP links: `all` - All relevant links (default) `specific` - Specific links
add candidate	Specifies the name of the Internet connection. Press the TAB key to see the available options.
additional-candidate	Specifies the name of the Internet connection. Press the TAB key to see the available options.
jitter	Configures the jitter threshold (in msec). Default: 30
latency	Configures the latency threshold (in msec). Default: 120
link-utilization	Specifies the ISP link utilization mechanism: `link-aggregation` - Link Aggregation (default). `prioritize` - Prioritize.
packet-loss	Configures the packet loss threshold (in %). Default: 1
probing-host	Configures the IPv4 Address or Hostname for the first probing destination. Default: `dns.google.com`
second-probing-host	Configures the IPv4 Address or Hostname for the second probing destination. Default: `dns.cloudflare.com`
third-probing-host	Configures the IPv4 Address or Hostname for the third probing destination. Default: `dns.opendns.com`
probing-interval	Configures the interval duration between probes (in msec). Default: 1000
probing-mode	Controls which Internet connection the appliance selects in each steering object based on the probing results: `best` - Selects the Internet connection that has the best probing results (the lowest values for the probing characteristics of packet loss, latency, and jitter). This is the default. `average` - Selects the Internet connection that has the average probing results. `worst` - Selects the Internet connection that has the worst probing results (the highest values for the probing characteristics of packet loss, latency, and jitter). For more details, see the explanation for this parameter in set internet-connection-settings.
selection-method	Configures the ISP link selection method: `connection-hash` - Connection hash (default) `proportionally-to-download-bandwidth` - Proportionally to download bandwidth `proportionally-to-upload-bandwidth` - Proportionally to upload bandwidth `round-robin` - Round robin

Example Command

add steering-object name "Test Steering" comment "My Test Steering" candidates-selected specific add candidate Internet2 link-utilization prioritize