update_interface
Modify an existing pfSense interface by ID to change its description, IPv4 settings, gateway, and network blocking options.
Instructions
Update an existing interface 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": {
"interface_id": "<interface_id>"
},
"name": "update_interface"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| descr | No | Interface description/friendly name | |
| enable | No | Whether the interface is enabled | |
| ipaddr | No | IPv4 address | |
| subnet | No | Subnet mask bits | |
| typev4 | No | IPv4 configuration type (static, dhcp, none) | |
| gateway | No | Gateway name | |
| blockpriv | No | Block private networks (RFC 1918) | |
| blockbogons | No | Block bogon networks | |
| interface_id | Yes | Interface ID, which the API keys by name: "wan", "lan", or "optN" (e.g. "opt16"). Take it from the "id" field returned by search_interface_configs, not from the row's position. | |
| apply_immediately | No | Whether to apply changes immediately |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||