get_device_bgp_status
Retrieves a device's live BGP state through the FortiManager proxy, showing peer establishment, learned paths, and BGP routes in the routing table to verify whether neighbors are up and what they advertised.
Instructions
Read a device's LIVE BGP state through the FortiManager proxy.
Unlike get_device_bgp (which reads the device-DB BGP config), this
proxies the device's monitor API to answer "are the peers established and
which routes did they bring":
peer state (
router/bgp/neighbors)local and learned paths (
router/bgp/paths)BGP routes in the routing table (
router/ipv4)
Dynamic peers from a neighbor-range are not configured neighbors: a hub lists none until a spoke connects, so an empty list there means no spoke is up, not that BGP is unconfigured. Check the spoke's state too.
Args: adom: ADOM name (defaults to DEFAULT_ADOM / "root" when omitted) device: Managed device name (e.g. "FGT-HQ"). Defaults to DEFAULT_DEVICE when omitted; required if that is not configured.
Returns: dict with keys: - adom, device - summary: neighbors with state, established_count, learned paths, BGP routes in the routing table - unverified: sources that could not be read - error / error_code: on failure
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_device_bgp_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| adom | No | ||
| device | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||