set steering-object

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

Description

Configure a specified user-defined steering behavior object.

See also:

Syntax

set steering-object <Name>

      new-name "<Name>"

      comment "<Text>"

      add

            candidate <Name of Internet Connection>

      candidates-selected {all | specific}

      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}

      remove

            all-candidates

            candidate <Name of Internet Connection>

      selection-method <Method>

      set

            candidate <Name of Internet Connection>

                  move {down | up}

                  position <Number>

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)

add

Adds the specified Internet connection to the steering behavior object.

Press the TAB key to see the available options.

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.

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 - use all links equally (default).

  • prioritize - Prioritize the Internet connections in the specified order.

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.

remove

Removes the specified Internet connection from the steering behavior object.

Press the TAB key to see the available options.

selection-method

Configures the ISP link selection method:

  • connection-hash - Connection hash. This is the default.

  • proportionally-to-download-bandwidth - Proportionally to download bandwidth.

  • proportionally-to-upload-bandwidth - Proportionally to upload bandwidth.

  • round-robin - Round robin.

set

Configures settings for the specified Internet connection in the steering behavior object.

Press the TAB key to see the available options.

move

Moves the Internet connection in the steering behavior object above or below its current priority.

position

Configures the position (priority) of the Internet connection in the steering behavior object.

Example Command

set steering-object Test\ Steering latency 100 jitter 20