manage_openvpn_cso
Create, update, or delete OpenVPN Client Specific Overrides to assign static tunnel IPs, push DNS and routes, or block individual clients on pfSense.
Instructions
Create, update, or delete an OpenVPN Client Specific Override (CSO).
CSOs allow per-client configuration such as assigning static tunnel IPs, pushing custom routes, or blocking specific clients.
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": {
"action": "<action>"
},
"name": "manage_openvpn_cso"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| block | No | Block this client from connecting | |
| action | Yes | Action to perform: "create", "update", or "delete" | |
| cso_id | No | CSO ID (required for update and delete) | |
| confirm | No | Must be set to True for delete operations. Safety gate for destructive operations. | |
| disabled | No | Whether the CSO is disabled | |
| push_reset | No | Reset all pushed options before applying CSO | |
| common_name | No | Client common name (CN) - required for create | |
| description | No | CSO description | |
| dns_server1 | No | DNS server 1 pushed to this client | |
| dns_server2 | No | DNS server 2 pushed to this client | |
| server_list | No | OpenVPN server interface names (vpnif, e.g. ["ovpns1"]) this override applies to. If omitted the override applies to ALL servers. | |
| local_network | No | Local network(s) pushed to this client | |
| custom_options | No | Custom OpenVPN options for this client | |
| remote_network | No | Remote network(s) for this client | |
| tunnel_network | No | Client tunnel network/IP (e.g., 10.0.8.5/32 for static IP) | |
| redirect_gateway | No | Whether to redirect all client traffic through the tunnel | |
| apply_immediately | No | Whether to apply changes immediately |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||