create_virtual_ip
Adds a virtual IP address to a pfSense interface for CARP failover, proxy ARP, or IP aliasing to enable high availability.
Instructions
Create a virtual IP address
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>",
"interface": "<interface>",
"subnet": "<subnet>",
"subnet_bits": "<subnet_bits>"
},
"name": "create_virtual_ip"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | VIP mode (ipalias, carp, proxyarp, other) | |
| type | No | Address type (single, network) | single |
| vhid | No | VHID group number (required for CARP, 1-255) | |
| descr | No | Optional description | |
| subnet | Yes | IP address for the virtual IP | |
| advbase | No | Advertisement base frequency for CARP (1-254 seconds) | |
| advskew | No | Advertisement skew for CARP (0-254, lower = higher priority) | |
| password | No | CARP password (required for CARP) | |
| interface | Yes | Interface to assign the VIP to (wan, lan, opt1, etc.) | |
| subnet_bits | Yes | Subnet mask bits (e.g., 32 for single host, 24 for /24) | |
| apply_immediately | No | Whether to apply changes immediately |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||