showSiteGatewayOspfNeighbors
Get OSPF Neighbors 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 neighbors command request for SSR and SRX devices
OSPF neighbor IP address filter
HA cluster node on which to show OSPF neighbors. enum: node0, node1.
Value in
- "node0"
- "node1"
Network interface filter for OSPF neighbor output
Routing instance or VRF filter for OSPF neighbor 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_neighbors" \ -H "Content-Type: application/json" \ -d '{}'{ "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}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 ```
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 ```