create_openvpn_client
Create an OpenVPN client instance on pfSense by providing the remote server address, port, protocol, device mode, and interface to set up a VPN connection.
Instructions
Create an OpenVPN client instance on pfSense.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ca | No | Certificate Authority reference/name | |
| tls | No | TLS key for additional authentication | |
| cert | No | Client certificate reference/name | |
| crypto | No | Data encryption algorithm (e.g., AES-256-GCM) | |
| digest | No | Auth digest algorithm (e.g., SHA256) | |
| dev_mode | Yes | Device mode (tun or tap) | |
| disabled | No | Whether the client starts disabled | |
| protocol | Yes | Protocol (UDP4, TCP4, UDP6, TCP6) | |
| auth_pass | No | Password for user authentication | |
| auth_user | No | Username for user authentication | |
| interface | Yes | Interface to bind to (wan, lan, any, etc.) | |
| proxy_addr | No | HTTP proxy address | |
| proxy_port | No | HTTP proxy port | |
| compression | No | Compression setting (omit, no, adaptive, lz4, lz4-v2, lzo, stub, stub-v2) | |
| description | No | Optional description for the client instance | |
| server_addr | Yes | Remote server address (IP or hostname) | |
| server_port | Yes | Remote server port number | |
| custom_options | No | Custom OpenVPN options (advanced) | |
| proxy_authtype | No | Proxy authentication type (none, basic, ntlm) | |
| remote_network | No | Remote network(s) accessible via tunnel | |
| tunnel_network | No | Tunnel network CIDR (e.g., 10.0.8.0/24) | |
| apply_immediately | No | Whether to apply changes immediately |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||