update_gateway_group
Modify an existing pfSense gateway group by ID, including its name, description, failover trigger, and gateway priorities, with optional immediate apply.
Instructions
Update an existing gateway group 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": {
"group_id": "<group_id>"
},
"name": "update_gateway_group"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Gateway group name | |
| descr | No | Description | |
| trigger | No | Failover trigger level (down, downloss, downlatency, downlosslatency) | |
| group_id | Yes | Gateway group ID (from search_gateway_groups) | |
| priorities | No | Array of gateway priority entries | |
| apply_immediately | No | Whether to apply changes immediately |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||