export_openvpn_client_config
Generate a downloadable OpenVPN client configuration file or installer package for a pfSense OpenVPN server, with optional overrides for hostname, port, TLS, proxy, and export format.
Instructions
Export an OpenVPN client configuration file or installer package.
Generates downloadable client configuration for connecting to a pfSense OpenVPN server instance.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"server_id": "<server_id>"
},
"name": "export_openvpn_client_config"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | Override port in the exported config | |
| use_tls | No | Include TLS key in the exported config | |
| hostname | No | Override hostname/IP in the exported config | |
| server_id | Yes | OpenVPN server ID to export configuration for | |
| use_token | No | Include token authentication | |
| proxy_addr | No | Proxy address for client config | |
| proxy_mode | No | Proxy mode for client config | |
| proxy_port | No | Proxy port for client config | |
| common_name | No | Client common name (CN) for which to generate config | |
| export_type | No | Export format (config, viscosity, inline, etc.) | |
| proxy_authtype | No | Proxy authentication type | |
| silent_install | No | Silent install mode for Windows installers | |
| random_local_port | No | Use a random local port in client config |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||