update_openvpn_client
Modify an existing OpenVPN client configuration on pfSense by client ID, adjusting server, certificate, protocol, or authentication settings.
Instructions
Update an existing OpenVPN client 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": {
"client_id": "<client_id>"
},
"name": "update_openvpn_client"
}
}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 | |
| digest | No | Auth digest algorithm | |
| dev_mode | No | Device mode (tun or tap) | |
| disabled | No | Whether the client is disabled | |
| protocol | No | Protocol (UDP4, TCP4, UDP6, TCP6) | |
| auth_pass | No | Password for user authentication | |
| auth_user | No | Username for user authentication | |
| client_id | Yes | Client ID (from search_openvpn_clients) | |
| interface | No | Interface to bind to | |
| proxy_addr | No | HTTP proxy address | |
| proxy_port | No | HTTP proxy port | |
| compression | No | Compression setting | |
| description | No | Client description | |
| server_addr | No | Remote server address (IP or hostname) | |
| server_port | No | Remote server port number | |
| custom_options | No | Custom OpenVPN options (advanced) | |
| proxy_authtype | No | Proxy authentication type | |
| remote_network | No | Remote network(s) accessible via tunnel | |
| tunnel_network | No | Tunnel network CIDR | |
| apply_immediately | No | Whether to apply changes immediately |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||