export_openvpn_client_config
Generate a downloadable OpenVPN client configuration or installer for connecting to a pfSense OpenVPN server. Supports overrides for hostname, port, proxy, and more.
Instructions
Export an OpenVPN client configuration file or installer package.
Generates downloadable client configuration for connecting to a pfSense OpenVPN server instance.
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 | |||