Tests

Tests to run in order to determine if interface is ready.

Tests are executed in order until a test result determines the state of the interface, or, all tests have run and at least one passed.

Test

A single interface test.

Properties

Condition

OptionLabelDescription
requiredRequiredIf this test fails, the interface is considered not ready and testing stops.
If this test passes, testing continue with the next test.
sufficientSufficientIf this test passes, the interface is considered ready and testing stops.
If this test fails, testing continue with the next test.
  • Data type: string select
  • Default: required
  • Configuration
  • Required

CLI: (cli)> config vpn wireguard <key> interface connectivity test <index> condition

Number of runs

The number of times in a row that this test must run succesfully to pass. If a run fails the test fails immediately.

  • Data type: integer
  • Default: 3
  • Minimum: 1
  • Configuration
  • Required

CLI: (cli)> config vpn wireguard <key> interface connectivity test <index> runs

Run interval

The time to wait between test runs.

  • Data type: integer
  • Units: seconds
  • Default: 1
  • Minimum: 0
  • Configuration
  • Required

CLI: (cli)> config vpn wireguard <key> interface connectivity test <index> interval

Timeout period

Consider the run failed if it does not receive a successful response within a set period of time.

  • Data type: integer
  • Units: seconds
  • Default: 3
  • Minimum: 1
  • Configuration
  • Required

CLI: (cli)> config vpn wireguard <key> interface connectivity test <index> timeout

Test type

OptionLabelDescription
pingPingPerform an ICMP ping/response sequence.
fetchFetch (HTTP/HTTPS/FTP)Connection to a network host.
dnsDNSPerform a DNS lookup.
  • Data type: string select
  • Default: ping
  • Configuration
  • Required

CLI: (cli)> config vpn wireguard <key> interface connectivity test <index> type