create_gateway
Creates a pfSense routing gateway by defining its interface, name, and IP address, with optional monitoring, load-balancing weight, protocol, and immediate apply settings.
Instructions
Create a routing gateway
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": "<interface>",
"name": "<name>",
"gateway": "<gateway>"
},
"name": "create_gateway"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Gateway name (alphanumeric and underscores only) | |
| descr | No | Optional description | |
| weight | No | Gateway weight for load balancing (1-30) | |
| gateway | Yes | Gateway IP address | |
| monitor | No | Monitor IP address (defaults to gateway IP if omitted) | |
| disabled | No | Whether the gateway starts disabled | |
| interface | Yes | Interface for the gateway (wan, lan, opt1, etc.) | |
| ipprotocol | No | IP protocol version (inet for IPv4, inet6 for IPv6) | inet |
| apply_immediately | No | Whether to apply changes immediately |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||