update_virtual_ip
Modify an existing pfSense virtual IP by ID, including address, subnet, interface, mode, and CARP settings, then apply changes immediately when needed.
Instructions
Update an existing virtual IP 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": {
"vip_id": "<vip_id>"
},
"name": "update_virtual_ip"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | VIP mode (ipalias, carp, proxyarp, other) | |
| type | No | Address type (single, network) | |
| vhid | No | VHID group number (for CARP) | |
| descr | No | Description | |
| subnet | No | IP address for the virtual IP | |
| vip_id | Yes | Virtual IP ID (from search_virtual_ips) | |
| advbase | No | Advertisement base frequency for CARP | |
| advskew | No | Advertisement skew for CARP | |
| password | No | CARP password | |
| interface | No | Interface to assign the VIP to | |
| subnet_bits | No | Subnet mask bits | |
| apply_immediately | No | Whether to apply changes immediately |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||