uploadSiteDeviceSupportFile
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) |
| " |
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
Request to upload support files from a device
Support file bundle type to upload. enum: code-dumps, full, messages, outbound-ssh, process, var-logs.
"full"Value in
- "code-dumps"
- "full"
- "messages"
- "outbound-ssh"
- "process"
- "var-logs"
Optional for SSR: if node is not present, both nodes support files are uploaded
Number of most recent messages files to upload when info==messages
1 <= value <= 101Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/support" \ -H "Content-Type: application/json" \ -d '{ "info": "full" }'tracerouteFromDevice POST
Traceroute can be performed from the Device. 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 ```json { "channel": "/sites/d6fb4f96-xxxx-xxxx-xxxx-xxxxxxxxxxxx/devices/00000000-0000-0000-1000-xxxxxxxxxxxx/cmd", "event": "data", "data": { "session": "9106e908-74dc-4a4f-9050-9c2adcaf44a5", "raw": "Running traceroute...\ntraceroute to 8.8.8.8, 64 hops max\n 0 192.168.1.1 1 ms 192.168.1.1 1 ms 192.168.1.1 1 ms\n 1 80.10.236.81 2 ms 80.10.236.81 4 ms 80.10.236.81 2 ms\n 2 193.253.80.250 3 ms 193.253.80.250 2 ms 193.253.80.250 2 ms\n 3 193.252.159.41 2 ms 193.252.159.41 1 ms 193.252.159.41 3 ms\n" } ```
cableTestFromSwitch POST
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` ```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": "Interface TDR detail:\nTest status : Test successfully executed ge-0/0/0\n" } } ```