Tunnel health configuration
tunnels[].health
- Type
object- Required
- No
- Default
- No probes
- Validation
- Each non-empty nested target is validated before it reaches a process argument.
- Secret classification
- No; targets may reveal monitoring intent.
- Side effects
- Defines checks run by hubctl and subscription selection.
- Minimal example
health: { dns_name: example.com }
tunnels[].health.tcp_address
- Type
host:port string- Required
- No
- Default
- Empty
- Validation
- Valid host or IP plus numeric port 1–65535; unsafe hostname characters and leading dashes are rejected.
- Secret classification
- No.
- Side effects
- Attempts a TCP connection from the tunnel context.
- Minimal example
192.0.2.53:53
tunnels[].health.https_url
- Type
HTTPS URL string- Required
- No
- Default
- Empty
- Validation
- Must use https, include a safe hostname, and contain no whitespace.
- Secret classification
- Do not put credentials or tokens in probe URLs.
- Side effects
- Fetches the URL through the tunnel.
- Minimal example
https://example.com/health
tunnels[].health.dns_name
- Type
hostname or IP string- Required
- No
- Default
- Empty
- Validation
- At most 253 characters with safe host-label syntax; leading dashes are rejected.
- Secret classification
- No.
- Side effects
- Resolves the name through the tunnel's DNS context.
- Minimal example
example.com
sudo hubctl --config /etc/vpn-hub test tunnel officeNo configured probe means unknown and a non-zero exit, never an inferred healthy status.
Next: Health semantics.