Cisco D9800 User Manual

IP Diagnostics Operation Status Command
Table 234: Command Details
DescriptionCommand Detail
https://192.168.0.1/ws/v1/table?t=IPDIAGSTATCommand URL
Return information about IP Diagnostics Status.Command Information
GETHTTP Method
ReadAccess Type
User, AdminAccess Level
GET "https://192.168.0.1/ws/v1/table?t=IPDIAGSTAT"GET Syntax
Example (issue the IP DIAG Status command):
Input:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v1/table?t=IPDIAGSTAT"
Expected output (example when diagnostics package preparation is in progress):
<?xml version="1.0" encoding="ISO-8859-1"
?><HDR><TABLE><RECORD><ITEM><ID>0x002D2600</ID><VALUE><![CDATA[Inprogress]]></VALUE><NAME>
<![CDATA[OPERSTATUS]]></NAME><HELP_STR_1><![CDATA[Indicates whether the most recent
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[Processing]]></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[23]]></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>
Expected output (example when diagnostics package preparation is 100% completed successfully):
<?xml version="1.0" encoding="ISO-8859-1"
?><HDR><TABLE><RECORD><ITEM><ID>0x002D2600</ID><VALUE><![CDATA[Pass]]></VALUE><NAME>
<![CDATA[OPERSTATUS]]></NAME><HELP_STR_1><![CDATA[Indicates whether the most recent 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[Done]]></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>
Expected output (example when ip diagnostics operation did not succeed):
<?xml version="1.0" encoding="ISO-8859-1"
?><HDR><TABLE><RECORD><ITEM><ID>0x002D2600</ID><VALUE><![CDATA[Fail]]></VALUE>
<NAME><![CDATA[OPERSTATUS]]></NAME><HELP_STR_1><![CDATA[Indicates whether the most recent
Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
280
API Definitions
IP Diagnostics Commands

Cisco D9800 Specifications

General

Brand	Cisco
Model	D9800
Category	Receiver
Language	English