Cisco D9800 Reference Manual page 293

API Definitions
operation passed, failed, or is in progress]]></HELP_STR_1><HELP_STR_2><![CDATA[This item
has 3 options
available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D2601</ID><VALUE><![CDATA[Failed]]>
</VALUE><NAME><![CDATA[DETAILEDSTATUS]]></NAME><HELP_STR_1><![CDATA[State of the current
Ping
Traceroute collection operation]]></HELP_STR_1><HELP_STR_2><![CDATA[This item has 6 options
available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D2602</ID><VALUE><![CDATA[100]]></VALUE>
<NAME><![CDATA[PERCENTCOMPLETE]]></NAME><HELP_STR_1><![CDATA[Progress of the current
Ping Traceroute Collection operation as a percent]]></HELP_STR_1><HELP_STR_2>
<![CDATA[Item attribute: min(0), max(100), step size(1), unit()]]></HELP_STR_2>
</ITEM></RECORD></TABLE></HDR>
Client software is expected to poll the status by calling this API every 5 seconds, while the Inprogress state
is active, and until the OPERSTATUS is Pass and PERCENTCOMPLETE is 100 or OPERSTATUS is Fail.
The first call will wait a minimum of 1 second, after the IP diagnostics trigger API, in order to allow the
internal states to clear. If, at any time, the OPERSTATUS is Fail, then the client software will abort additional
checking and report the last DETAILEDSTATUS.
IP Diagnostics Report Retrieval Command
Table 235: Command Details
Command Detail
Command URL
Command Information
HTTP Method
Access Type
Access Level
GET Syntax
Options: NA
Example (issue the IP diagnostics retrieval command):
Input (append &js for output in JSON format):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/ip_diags"
Expected output (example for Success case which indicates only that Diag Package Retrieval was
completed):
XML format:
HTTP/1.1 200 OK
Date: Mon, 26 Jun 2017 13:00:58 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 200
Content-type: application/xml
Description
https://192.168.0.1/ws/v2/ip_diags
Retrieves the last IP diagnostics report (after last 100% completed
operation status).
GET
Read
User, Admin
Restricted to Lock Level 0 only.
GET "https://192.168.0.1/ws/v2/ip_diags"
Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
IP Diagnostics Commands
281