get_teleport_config
get_teleport_config
Section titled “get_teleport_config”Return Teleport VPN state and any wireguard-server networks.
Side effects: None (read-only).
Returns {"enabled": bool, "vpn_networks": [...], "clients_via_local_api": false, "notes": [...]}. The enabled
flag is the global Teleport listener toggle; vpn_networks
lists the underlying wireguard-server network records (Teleport
rides on these for tunnel termination); clients_via_local_api
is a hard false on UniFi Network 9.x — the client roster and
invitation lifecycle are only reachable via the Ubiquiti mobile
app pairing flow, not the local API.
Example
Section titled “Example”get_teleport_config(controller="default")Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
controller | string | no | ”default” | Name of the UniFi controller to target. Defaults to "default". |