Get the results of tuning devices

Use this API to get the results of tuning devices.

Resource Information

Method

URL

Required authentication

Get

/V1/CMDB/TuneDevices

Yes

Parameters

Name

Description

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

taskId (string)
(query)

The task ID of tuning devices.

begin (int)
(query)

Specify from which row to begin indexing data. For example, the begin is 0, and the API will return tuning result starting from the first row. This parameter is required when the hostnames parameter is not specified.

count (int)
(query)

Specify the maximum number of returned data. This parameter is required when the hostnames parameter is not specified.

hostnames (list)
(query)

List all devices that need to return tuning result.

if this parameter is specified, the begin and count parameters are useless.

If not specified, use the begin and count to return tune results.

Response

Parameter

Type

Description

Example

devices

list

A list of devices that return tuning result.

{
  "devices": [
    {
      "deviceName""string",
      "log""string",
      "TuneState": {
        "Enable""string",
        "Hostname""string",
        "LiveHostname""string",
        "Login""string",
        "MgrIntf""string",
        "MgrIp""string",
        "Model""string",
        "NetworkServer""string",
        "Ping""string",
        "SnmpRo""string",
        "TelnetSSH""string",
        "Vendor""string"
      }
    }
  ],
  "statusCode""200",
  "statusDescription""Success"
}

deviceName

string

The name of a tuned device.

log

string

The log of device tuning.

tuneState

object

The tune state.

enable

string

The result of logging into Enable mode.

hostname

string

The hostname of a tuned device.

liveHostname

string

The live hostname of a device.

login

string

The login result of a device.

mgrIntf

string

The management interface of a device.

mgrIp

string

The management IP of a device.

model

string

The model name of a device.

networkServer

string

The front sever name of a device.

ping

string

The ping result.

snmpRo

string

The SNMPRO information of a device

telnetSSH

string

The Telnet and SSH result of a device.

vendor

string

The vendor name of a device.

deviceName

string

The device name.

log

string

The log of tuning a device.

statusCode

integer

The returned status code of executing the API.

statusDescription

string

The explanation of the status code.