update_bgp_template
Modify neighbor-group settings in a BGP provisioning template, including route-reflector-client, next-hop-self, and soft-reconfiguration, to prepare FortiManager changes for device install.
Instructions
Change neighbor-group options inside a BGP provisioning template.
Only FortiManager changes here: the devices follow at the next install, so
run preview_install(package=None) first. BGP then needs a route refresh,
for example execute router clear bgp all soft out, before peers receive
what a new route-reflector client should get.
The neighbor-group path is not in the bundled FNDN specs; it is verified live on FortiManager 8.0.2 only.
Args:
adom: ADOM name
name: BGP template name (list_templates entries whose
template setting.stype is router_bgp)
neighbor_group: Neighbor group name, e.g. "EDGE"
settings: Options to change: route-reflector-client, next-hop-self,
next-hop-self-rr, soft-reconfiguration ("enable"/"disable") and
advertisement-interval (seconds). Anything else is refused.
Returns: dict: adom, name, neighbor_group, before, after (values read back from FortiManager, 1/0 for enable/disable), or error / error_code on failure
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": {
"adom": "<adom>",
"name": "<name>",
"neighbor_group": "<neighbor_group>",
"settings": "<settings>"
},
"name": "update_bgp_template"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| adom | Yes | ||
| name | Yes | ||
| settings | Yes | ||
| neighbor_group | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||