-
Notifications
You must be signed in to change notification settings - Fork 2
openvpn client
The OpenVPN Client feature surfaces every configured OpenVPN client profile on your GL.iNet router as a switch so you can turn individual tunnels on or off.
To enable this feature, check the OpenVPN Client option under Enabled Features in the integration configuration or options flow.
-
Option key:
ovpn_client
The integration adapts to the router's firmware. On older firmware you get one switch per configured OpenVPN client; on 4.9 and newer you get one switch per dashboard tunnel.
| Entity | Description | API Source |
|---|---|---|
| OpenVPN client switches | One switch per configured OpenVPN client profile returned by the router. Toggles the specific client connection on or off. |
ovpn-client API. |
The active client profile and its location are stored on the router but are not exposed as Home Assistant entities. They can be read directly from the router's web UI.
Firmware 4.9 introduces a unified VPN dashboard. The integration only sees the OpenVPN profiles that the router exposes on this dashboard — so a new OpenVPN client has to be added to the VPN Dashboard before it appears in Home Assistant. Once it is on the dashboard the integration queries vpn-client.get_tunnel and surfaces one switch per dashboard tunnel whose via.type is openvpn.
Adding OpenVPN profiles on 4.9+:
- Create / import the OpenVPN client in the router's admin UI as usual.
- Open the VPN Dashboard section of the admin UI and preconfigure the client onto a dashboard tunnel (assign it explicitly to a tunnel slot).
- Reload the integration in Home Assistant. The new tunnel switch will appear under the OpenVPN Client device.
Do not simply toggle the client on through the dashboard to "register" it. Toggling a tunnel that has no profile preconfigured overwrites the slot and leaves the existing configuration empty, which causes the integration to lose that tunnel. Always assign the client to a tunnel slot before you toggle anything.
Removing OpenVPN profiles on 4.9+: if you remove (or unassign) an OpenVPN client from the VPN Dashboard on the router, the corresponding switch in Home Assistant is automatically removed on the next coordinator refresh. The dashboard should always reflect exactly what is currently configured on the router.
No profiles configured on the dashboard: if you have not pre-configured any OpenVPN profiles on the VPN dashboard, the router's firmware falls back to whatever tunnel was used last (or to the "default" /
novpntunnel) when a toggle is sent. The integration sendsvpn-client.set_tunnelfor the requestedtunnel_id, but with no preconfigured profile the router will start whichever tunnel it currently considers the default. To get predictable, per-profile switches, preconfigure the OpenVPN clients on the VPN dashboard first.
| Entity | Description | API Source |
|---|---|---|
| OpenVPN Tunnel <name> | One switch per dashboard tunnel. Reports the live link state from vpn-client.get_status and toggles the tunnel via vpn-client.set_tunnel. |
vpn-client API (get_tunnel, set_tunnel, get_status). |
Backwards compatibility: 4.8 routers keep the per-profile switches — the dashboard path activates only when the firmware reports version 4.9 or newer. Switching between firmware versions (downgrade or upgrade) may require reloading the integration so the entity registry picks the correct representation.
- Services & Actions — How to use Home Assistant services with this integration.
- Entity Reference — All core and optional entities.