{"type":"api","title":"TraceRoute checks route from CDG to destination","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/e05c97f6-c05c-3a2b-97ed-ca9f414d72b7","info":{"title":"Crosswork Data Gateway Troubleshooting API","description":"APIs to support CDG 3.0.0 troubleshooting","version":"7.1.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/CDG/cdg_troubleshooting_api_overview.md"}},"swagger":"2.0","basePath":"/crosswork/dg-manager/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer Auth Token"}}},"spec":{"summary":"TraceRoute checks route from CDG to destination","operationId":"SubmitTraceRouteCommand","deprecated":false,"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"Body","in":"body","required":true,"description":"Request payload to trace routes","schema":{"title":"TraceRouteCommandPayload","example":{"id":"5053d5c9-354c-1970-b151-9c08c8fea601","commandName":"TRACE_ROUTE","clientId":{"uuid":"1358e717-78de-47c0-81fc-efb5bddb5e5c"},"args":[{"key":"destinationAddress","value":{"str":"localhost"}}]},"type":"object","properties":{"id":{"type":"string"},"commandName":{"type":"string"},"clientId":{"title":"ClientId","example":{"uuid":"d58de587-5da2-4a62-b010-32395acc8dbc"},"type":"object","properties":{"uuid":{"type":"string"}},"required":["uuid"],"$$ref":"#/definitions/ClientId"},"args":{"type":"array","items":{"title":"TraceRouteArg","example":{"key":"destinationAddress","value":{"str":"localhost"}},"type":"object","properties":{"key":{"type":"string"},"value":{"title":"TraceRouteValue","example":{"str":"localhost"},"type":"object","properties":{"str":{"type":"string"}},"required":["str"],"$$ref":"#/definitions/TraceRouteValue"}},"required":["key","value"],"$$ref":"#/definitions/TraceRouteArg"}}},"required":["id","commandName","clientId","args"],"$$ref":"#/definitions/SubmitTraceRouteCommand"}}],"responses":{"200":{"description":"OK. The traceroute command was submitted and successfully executed on the CDG.","schema":{"title":"SubmitTraceRouteCommandResponse","example":{"clientId":{"uuid":"5cd4b30d-5137-4f28-a33c-1e25057de42f"},"responseId":"42812c3b-a48b-4bde-9d6f-57dd92a6efc7","commandName":"TRACE_ROUTE","value":{"str":"Traceroute Result: traceroute to 192.168.5.141 (192.168.5.141), 30 hops max, 60 byte packets\n 1 * * *\n 2 * * *\n 3 * * *\n 4 * * *\n 5 * * *\n 6 * * *\n 7 * * *\n 8 * * *\n 9 * * *\n10 * * *\n11 * * *\n12 * * *\n13 * * *\n14 192.168.5.141 (192.168.5.141) 0.164 ms * *\n"},"status":"SUCCESS"},"type":"object","properties":{"clientId":{"type":"object"},"uuid":{"type":"string"},"responseId":{"type":"string"},"commandName":{"type":"string"},"value":{"type":"object"},"str":{"type":"string"},"status":{"type":"string"}},"$$ref":"#/definitions/SubmitTraceRouteCommandResponse"}},"400":{"description":"Bad Request. The request is malformed in some way and the server cannot process it.","headers":{}}},"__originalOperationId":"SubmitTraceRouteCommand","security":[{"bearerAuth":[]}],"method":"post","path":"/command/traceroute"}}