delete_virtual_ip
Remove a Virtual IP object from a FortiGate device configuration, and block deletion when the VIP is still used by policies.
Instructions
Delete a Virtual IP from a FortiGate device.
This tool removes an existing Virtual IP object from the device configuration. Note that Virtual IPs in use by policies cannot be deleted.
Parameters:
device_id: Identifier of the FortiGate device
name: Name of the Virtual IP to delete
vdom: Virtual Domain name (optional, uses device default)
Returns:
Deletion status confirmation
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": {
"device_id": "<device_id>",
"name": "<name>"
},
"name": "delete_virtual_ip"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Virtual IP name | |
| vdom | No | Virtual Domain | |
| device_id | Yes | FortiGate device identifier |