diff options
| author | Jeleel Muibi <jeleel-muibi@users.noreply.github.com> | 2026-08-24 20:21:14 +0100 |
|---|---|---|
| committer | Jeleel Muibi <jeleel-muibi@users.noreply.github.com> | 2026-08-24 20:21:14 +0100 |
| commit | 49418680a1a74fb0c312d8a096edb5af5145be10 (patch) | |
| tree | 3b53bc341a183973eafd767eac1aa732db9b97b5 | |
| parent | 3a1c6c3020c4ed819616098a91be670719e290cc (diff) | |
| download | vyos-documentation-49418680a1a74fb0c312d8a096edb5af5145be10.tar.gz vyos-documentation-49418680a1a74fb0c312d8a096edb5af5145be10.zip | |
docs: T9145: document WLB health script variables
| -rw-r--r-- | docs/configuration/loadbalancing/wan.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/configuration/loadbalancing/wan.md b/docs/configuration/loadbalancing/wan.md index a19bbfae..bcd83917 100644 --- a/docs/configuration/loadbalancing/wan.md +++ b/docs/configuration/loadbalancing/wan.md @@ -174,7 +174,9 @@ type WLB test type address or hostname. - `test-script`: A user-defined script must return 0 to succeed and non-zero to fail. Scripts reside in `/config/scripts`. For other locations, - provide the full path. + provide the full path. When the script runs, VyOS sets + `WLB_INTERFACE_NAME` to the interface under test. The same value is available + as `WLB_SCRIPT_IFACE` for backward compatibility. - `ttl-limit`: For the UDP TTL limit test, specify the hop count limit. The limit must be shorter than the path length. The test succeeds when an ICMP time-expired message is returned. Default `1`. |