Get connection status
get_statusCheck VPN connection state for every profile or one profile: disconnected, connecting or connected, tunnel IP, last error and cause, retry timing, and whether the privileged helper is installed.
Instructions
Returns the connection state of every profile (or only profile_id): disconnected, connecting or connected, the tunnel IP, since when, the last error and why it happened (failure: auth_rejected, host_not_found, unreachable, configuration, setup, timeout, cancelled, tool_unsupported (the VPN tool does not run on this macOS version), host_scan_required (a Cisco AnyConnect server requires a host scan, which PassTunnel never runs), sso_required (a Palo Alto GlobalProtect portal or gateway signs in with single sign-on, which PassTunnel does not support) or failed; for a configuration failure, server_cert (the key of the server whose certificate was not trusted) and, for GlobalProtect, gateways (the portal's gateways when the profile's gateway names none of them); the server's reply; whether the sign-in and a one-time code were sent; for a rejected sign-in, clock: how far this computer's clock was off, when known), when the app tries a server that did not answer again (next_try_at, tries), and whether the privileged helper that starts VPNs is installed and current. connect_refusal says why a profile cannot be connected on this system at all. experimental is true on a profile of an experimental type (Palo Alto GlobalProtect); notices lists what the user should know about a connected profile (hip_report_not_sent).
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| profile_id | No | A profile id from list_profiles; omit for all profiles. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| helper | Yes | ||
| profiles | Yes |