update_openvpn_server
Modify an existing OpenVPN server instance by ID to adjust its configuration, including certificates, protocol, tunnel network, clients, DNS, and other pfSense VPN settings.
Instructions
Update an existing OpenVPN server instance by ID.
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": "update_openvpn_server"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ca | No | Certificate Authority reference/name | |
| tls | No | TLS key for additional authentication | |
| cert | No | Server certificate reference/name | |
| mode | No | Server mode (p2p_tls, server_tls, server_user, server_tls_user) | |
| crypto | No | Data encryption algorithm | |
| digest | No | Auth digest algorithm | |
| dev_mode | No | Device mode (tun or tap) | |
| disabled | No | Whether the server is disabled | |
| protocol | No | Protocol (UDP4, TCP4, UDP6, TCP6) | |
| topology | No | Topology type (subnet or net30) | |
| dh_length | No | Diffie-Hellman parameter length (1024, 2048, 3072, 4096) | |
| interface | No | Interface to bind to (wan, lan, any, etc.) | |
| server_id | Yes | Server ID (from search_openvpn_servers) | |
| dynamic_ip | No | Allow dynamic IP addressing for clients | |
| local_port | No | Local port number | |
| maxclients | No | Maximum number of concurrent clients | |
| compression | No | Compression setting | |
| description | No | Server description | |
| 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 | |
| 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 | |||