showSiteSsrAndSrxRoutes
Get routes 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
admin@labsystem1.fiedler# show bgp neighborsBGP neighbor is 192.168.4.1, remote AS 4200000001, local AS 4200000128, externallink BGP version 4, remote router ID 1.1.1.1 BGP state = Established, up for 00:27:25 Last read 00:00:25, hold time is 90, keepalive interval is 30 seconds Configured hold time is 90, keepalive interval is 30 seconds Neighbor capabilities: 4 Byte AS: advertised and received Route refresh: advertised and received(old & new) Address family IPv4 Unicast: advertised and received Graceful Restart Capability: advertised and received Remote Restart timer is 120 seconds Address families by peer: none ...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
uuiduuidRequest Body
application/json
All attributes are optional
Route table lookup request for device command output
Refresh duration in seconds; set only when interval is nonzero
0 <= value <= 3000Refresh interval in seconds for repeated command output
0 <= value <= 100BGP neighbor IP address filter for received or advertised routes
HA cluster node on which to show routes
IPv4 or IPv6 prefix filter for route entries
Routing protocol filter for route entries. enum: any, bgp, direct, evpn, ospf, static.
"bgp"Value in
- "any"
- "bgp"
- "direct"
- "evpn"
- "ospf"
- "static"
if neighbor is specified, received / advertised; if not specified, both will be shown
- for SSR, show bgp neighbors 10.250.18.202 received-routes/advertised-routes
- for SRX and Switches, show route receive-protocol/advertise-protocol bgp 192.168.255.12
Routing instance or VRF filter for route entries
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/show_route" \ -H "Content-Type: application/json" \ -d '{}'{ "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}showSiteGatewayOspfSummary POST
Get OSPF summary from SSR and SRX. 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` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` #### Example output from ws stream ``` ===== =========== ========== ============= ==================== ========= =========== ============= Vrf Router ID ABR Type ASBR Router External LSA Count Area ID Area Type Area Border Router ===== =========== ========== ============= ==================== ========= =========== ============= 1.0.0.2 cisco False 0 0.0.0.0 1.0.0.2 cisco False 0 0.0.0.4 default ```
showSiteSsrAndSrxSessions POST
Get active sessions passing through the Device. The output will be available through websocket. As there can be multiple command 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` ```json { "subscribe": "/sites/{site_id}/devices/{device_id}/cmd" } ``` #### Example output from ws stream ```json { "channel": "/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd", "event": "data", "data": { "session": "f517bf29-1141-41ae-a084-17cacb0ccb57", "raw": "{\"status\":\"SUCCESS\",\"finished\":true,\"rows\":[{\"session_id\":\"a04b1cc7-dcc1-40a6-a010-0fe46ca38551\",\"direction\":\"forward\",\"service\":\"internet\",\"tenant\":\"SRV.PRD-Core\",\"device_interface\":\"ge-0/0/3\",\"network_interface\":\"ge-0/0/3.100\",\"protocol\":\"TCP\",\"source_ip\":\"10.3.20.101\",\"source_port\":45733,\"destination_ip\":\"13.38.46.35\",\"destination_port\":443,\"nat_ip\":\"192.168.1.115\",\"nat_port\":45256,\"payload_encrypted\":false,\"timeout\":1581,\"uptime\":319},{\"session_id\":\"a04b1cc7-dcc1-40a6-a010-0fe46ca38551\",\"direction\":\"reverse\",\"service\":\"internet\",\"tenant\":\"SRV.PRD-Core\",\"device_interface\":\"ge-0/0/0\",\"network_interface\":\"ge-0/0/0\",\"protocol\":\"TCP\",\"source_ip\":\"13.38.46.35\",\"source_port\":443,\"destination_ip\":\"192.168.1.115\",\"destination_port\":45256,\"nat_ip\":\"0.0.0.0\",\"nat_port\":0,\"payload_encrypted\":false,\"timeout\":1581,\"uptime\":319}]}\n" } } ```