showSiteGatewayOspfDatabase
Get OSPF Database 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
{ "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}Example output from ws stream
===== ==================== ========== ======= ======== ================ =================== =================Vrf Neighbor Router ID Priority State Uptime Dead Timer Due Interface Address Interface State===== ==================== ========== ======= ======== ================ =================== ================= 1.0.0.3 1 Full 852 38 172.16.3.2 Backup 1.0.0.4 1 Full 811 33 172.16.3.2 DROther 1.0.0.3 1 Full 852 38 172.16.4.2 Backup 1.0.0.4 1 Full 811 34 172.16.4.2 DROtherPreferred 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
OSPF database command request for SSR and SRX devices
HA cluster node on which to show the OSPF database. enum: node0, node1.
Value in
- "node0"
- "node1"
Whether to show only self-originated OSPF database entries
falseRouting instance or VRF filter for OSPF database output
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/show_ospf_database" \ -H "Content-Type: application/json" \ -d '{}'{ "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}servicePingFromSsr POST
Ping from SSR Service Ping can be performed from 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 { "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd", "data": { "session": "session_id", "raw": "64 bytes from 23.211.0.110: seq=8 ttl=58 time=12.323 ms\n" } } ```
showSiteGatewayOspfInterfaces POST
Get OSPF interfaces 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 Device Interface Network Interface Interface Up IP address OSPF Type Area ID Area Type ===== ================== =================== ============== =============== =========== ========= =========== net1 g1 True 172.16.1.2/24 Broadcast 0.0.0.0 default net3 g3 True 172.16.3.2/24 Broadcast 0.0.0.0 default net4 g4 True 172.16.4.2/24 Broadcast 0.0.0.4 default ```