Download Device Control Settings; Diagnostics Api; Ip Diagnostics Commands; Ip Diagnostics Trigger Command - Cisco D9800 Reference Manual

API Definitions

Download Device Control Settings

For a description of the ws/v2/device_ctl/download command, refer to
Upload Command, on page
This command is available for Version 2.75 or later. The previous versions returns HTTP 404 Not Found
error.

Diagnostics API

This section contains APIs that Administrators and Users may use to diagnose specific functionality on a
D9800 platform.
Note This is different from the APIs used for Diagnostics Package creation and retrieval (referred to as Export
Debug File operations on the D9800 web GUI).

IP Diagnostics Commands

The following is a list of the Client software requirements:
IP Diagnostics command may take up to 30 seconds, depending on status of the specified port and destination
ip_address.
To avoid blocking of the D9800 integrated applications, and to implement the Progress Bar feature on the
web GUI, the required client software operation is a four phase approach:
1 Trigger a request for IP diagnostic.
2 Wait on status (Diagnostics Operation Status API).
3 Retrieve the output data of the command (via GET API response).
4 Format the raw data retrieved from the GET API response elements into a format (for example, text box
Window on the web GUI) that is useful to the user.
The APIs that are involved in Steps 1 to 3 above are described below.

IP Diagnostics Trigger Command

Table 232: Command Details
Command Detail
Command URL
Command Information
HTTP Method
19.
Description
https://192.168.0.1/ws/v2/ip_diags/trigger
Trigger the ip_diags command.
POST
Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
Download Device Control Settings
Determining Support for Chunky CDT
277