UtilitiesCommon
showSiteDeviceBgpSummary
Get BGP Summary from SSR, SRX and Switch.
The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, session is introduced for demux.
Subscribe to Device Command outputs
WS /api-ws/v1/stream
{ "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}Example output from ws stream
Tue 2024-04-23 16:36:06 UTCRetrieving bgp entries...BGP table version is 354, local router ID is 10.224.8.16, vrf id 0Default local pref 100, local AS 65000Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, i internal, r RIB_failure, S Stale, R RemovedNexthop codes: @NNN nexthop's vrf id, < announce-nh-selfOrigin codes: i - IGP, e - EGP, ? - incompleteRPKI validation codes: V valid, I invalid, N Not found Network Next Hop Metric LocPrf Weight Path*> 161.161.161.0/24```"Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
site_id*string
Format
uuiddevice_id*string
Format
uuidRequest Body
application/json
All attributes are optional
BGP summary command request
node?ha_cluster_node_enum
HA cluster node on which to show the BGP summary. enum: node0, node1.
Value in
- "node0"
- "node1"
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/show_bgp_summary" \ -H "Content-Type: application/json" \ -d '{}'{ "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}