create_openvpn_server
Creates an OpenVPN server instance on pfSense with mode, protocol, interface, and port settings to let remote clients access network resources.
Instructions
Create an OpenVPN server instance on pfSense.
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": {
"mode": "<mode>",
"protocol": "<protocol>",
"dev_mode": "<dev_mode>",
"interface": "<interface>",
"local_port": "<local_port>"
},
"name": "create_openvpn_server"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ca | No | Certificate Authority reference/name | |
| tls | No | TLS key for additional authentication (base64 or reference) | |
| cert | No | Server certificate reference/name | |
| mode | Yes | Server mode (p2p_tls, server_tls, server_user, server_tls_user) | |
| 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 server starts disabled | |
| protocol | Yes | Protocol (UDP4, TCP4, UDP6, TCP6) | |
| topology | No | Topology type (subnet or net30) | |
| dh_length | No | Diffie-Hellman parameter length (1024, 2048, 3072, 4096) | |
| interface | Yes | Interface to bind to (wan, lan, any, etc.) | |
| dynamic_ip | No | Allow dynamic IP addressing for clients | |
| local_port | Yes | Local port number for the server to listen on | |
| maxclients | No | Maximum number of concurrent clients | |
| compression | No | Compression setting (omit, no, adaptive, lz4, lz4-v2, lzo, stub, stub-v2) | |
| description | No | Optional description for the server instance | |
| dns_server1 | No | DNS server 1 pushed to clients | |
| dns_server2 | No | DNS server 2 pushed to clients | |
| duplicate_cn | No | Allow duplicate client certificates | |
| local_network | No | Local network(s) accessible to clients (e.g., 192.168.1.0/24) | |
| custom_options | No | Custom OpenVPN options (advanced) | |
| remote_network | No | Remote network(s) accessible from server | |
| 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 | |||