{"type":"api","title":"Ping checks reachability 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":"Ping checks reachability from CDG to destination.","operationId":"SubmitPingCommand","deprecated":false,"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"Body","in":"body","required":true,"description":"Request payload to check reachability from CDG to a destination address","schema":{"title":"PingCommandPayload","example":{"id":"4053d5c9-354c-1970-b151-9c08c8fea601","commandName":"PING","clientId":{"uuid":"1358e717-78de-47c0-81fc-efb5bddb5e5c"},"args":[{"key":"protocol","value":{"str":"icmp"}},{"key":"destinationAddress","value":{"str":"localhost"}},{"key":"count","value":{"u32":5}}]},"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":"PingArg","example":{"key":"protocol","value":{"str":"icmp"}},"type":"object","properties":{"key":{"type":"string"},"value":{"title":"PingValue","example":{"str":"icmp"},"type":"object","properties":{"str":{"type":"string"},"u32":{"type":"integer","format":"int32"}},"$$ref":"#/definitions/PingValue"}},"required":["key","value"],"$$ref":"#/definitions/PingArg"}}},"required":["id","commandName","clientId","args"],"$$ref":"#/definitions/SubmitPingCommand"}}],"responses":{"200":{"description":"OK. The ping command was submitted and successfully executed on the CDG.","headers":{},"schema":{"title":"PingStatusResponse","example":{"clientId":{"uuid":"f3395806-a44f-45fa-9760-01d35425d002"},"responseId":"a6f4e4b1-be22-4060-b1d6-ca33acbb4c00","commandName":"PING","value":{"str":"Ping Result: PING 172.29.194.130 (172.29.194.130) 56(84) bytes of data.\n64 bytes from 172.29.194.130: icmp_seq=1 ttl=63 time=0.919 ms\n64 bytes from 172.29.194.130: icmp_seq=2 ttl=63 time=0.929 ms\n64 bytes from 172.29.194.130: icmp_seq=3 ttl=63 time=0.704 ms\n\n--- 172.29.194.130 ping statistics ---\n3 packets transmitted, 3 received, 0% packet loss, time 2002ms\nrtt min/avg/max/mdev = 0.704/0.850/0.929/0.103 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/PingStatusResponse"}},"400":{"description":"Bad Request. The request is malformed in some way and the server cannot process it."}},"__originalOperationId":"SubmitPingCommand","security":[{"bearerAuth":[]}],"method":"post","path":"/command/ping"}}