cableTestFromSwitch
TDR can be performed from the Switch. The output will be available through websocket. As there can be multiple commands issued against the same Switch 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
{ "event": "data", "channel": "/sites/4ac1dcf4-9d8b-7211-65c4-057819f0862b/devices/00000000-0000-0000-1000-5c5b350e0060/cmd", "data": { "session": "session_id", "raw": "Interface TDR detail:\nTest status : Test successfully executed ge-0/0/0\n" }}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
Request body for running a switch cable test on a port
The port to run the cable test
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/cable_test" \ -H "Content-Type: application/json" \ -d '{ "port": "ge-0/0/0" }'{ "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}uploadSiteDeviceSupportFile POST
Support / Upload device support files #### Info Param | Name | Type | Description | | --- | --- | --- | | process | string | Upload 1 file with output of show system processes extensive | | outbound-ssh | string | Upload 1 file that concatenates all /var/log/outbound-ssh.log* files | | messages | string | Upload 1 to 10 /var/log/messages* files | | core-dumps | string | Upload all core dump files, if any. Uploads for all members of VC on switches.| | full | string | Upload 1 file with output of request support information, 1 file that concatenates all /var/log/outbound-ssh.log files, all core dump files, the 3 most recent /var/log/messages files, and Mist agent logs (for Junos devices running the Mist agent) | | var-logs | string | Upload all non-empty files in the /var/log/ directory | | jma-logs | string | Upload Mist agent logs (for Junos devices running the Mist agent only) | "
clearAllLearnedMacsFromPortOnSwitch POST
Clear all learned MAC addresses, including persistent MAC addresses, on a port.