Diagnostics Package Retrieval Command - Cisco D9800 Reference Manual

Diagnostics Package (Export Debug File) Commands
available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D25CE</ID><VALUE><![CDATA[Done]]>
</VALUE><NAME><![CDATA[DETAILEDSTATUS]]></NAME><HELP_STR_1><![CDATA[State of the current
Export Debug Support Data operation]]></HELP_STR_1><HELP_STR_2><![CDATA[This item has 6
options
a v a i l a b l e . ] ] > < / H E L P _ S T R _ 2 > < / I T E M > < I T E M > < I D > 0 x 0 0 2 D 2 5 C F < / I D > < V A L U E > < ! [ C D A T A [ 1 0 0 ] ] > < / V A L U E > < N A M E > < ! [ C D A T A [ P E R C E N T C O M P L E T E ] ] > < / N A M E > < H E L P _ S T R _ 1 > < ! [ C D A T A [ P r o g r e s s
of the current Export Debug Support Data 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 of when diagnostics package preparation fails, and detailed reason why it
failed):
<?xml version="1.0" encoding="ISO-8859-1"
? > < H D R > < T A B L E > < R E C O R D > < I T E M > < I D > 0 x 0 0 2 D 2 5 C D < / I D > < V A L U E > < ! [ C D A T A [ F a i l ] ] > < / V A L U E > < N A M E > < ! [ C D A T A [ O P E R S T A T U S ] ] > < / N A M E > < H E L P _ S T R _ 1 > < ! [ C D A T A [ I n d i c a t e s
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>0x002D25CE</ID><VALUE><![CDATA[Lock level too
high for Export Debug Support Data
operation]]></VALUE><NAME><![CDATA[DETAILEDSTATUS]]></NAME><HELP_STR_1><![CDATA[State of
the current Export Debug Support Data operation]]></HELP_STR_1><HELP_STR_2><![CDATA[This
item has 6 options
a v a i l a b l e . ] ] > < / H E L P _ S T R _ 2 > < / I T E M > < I T E M > < I D > 0 x 0 0 2 D 2 5 C F < / I D > < V A L U E > < ! [ C D A T A [ 2 0 ] ] > < / V A L U E > < N A M E > < ! [ C D A T A [ P E R C E N T C O M P L E T E ] ] > < / N A M E > < H E L P _ S T R _ 1 > < ! [ C D A T A [ P r o g r e s s
of the current Export Debug Support Data 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 the PERCENTCOMPLETE is 100 or the OPERSTATUS
is Fail. The first call should wait a minimum of 10 seconds, after the diagnostics trigger API, to allow the
internal states to clear. If, at any time, the OPERSTATUS is Fail, then the client software should abort additional
checking and report the last DETAILEDSTATUS.

Diagnostics Package Retrieval Command

Table 13: Command Details
Command Detail
Command URL
Command Information
HTTP Method
Access Type
Access Level
Options: NA
Example of issuing the diagnostics package retrieval command:
Input:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v1/diagnostics" -o diagnostics
Expected output (example for success case, which indicates that Diag Package Retrieval was completed):
% Total
Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
24
% Received % Xferd Average Speed
Dload
Description
https://192.168.0.1/ws/v1/diagnostics
Retrieves the diagnostics package file.
GET
Read
User, Admin
Restricted to Lock Level 0 only.
Time Time
Upload Total Spent
API Definitions
Time Current
Left Speed