Add a benchmark task

POST

/V1/CMDB/Benchmark/Tasks

Yes

Token*required
(header)

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

Request*required
(body)

The body contains the following parameters:

▪taskName* (string): the name of the task.

▪description (string): the description of the task.

▪startDate* (string): the date when the task starts to run. The standard time format is required. For example, 2017-07-13, or 2017/07/13.

▪schedule* (object): the schedule to run the task. The following subparameters are included in this object:

ofrequency* (string): the frequency to run the task. It includes ”once”, “hourly”,” daily”, “weekly” and “monthly” options.

ointerval (integer): the interval to run the task. This field is only valid for “hourly”,” daily”, and “weekly” options and the default value is 1, such as every 1 hour, 1 week.

ostartTime* (string): the time to run the task. The time format is full UTC time. For example, 2017/7/11 16:20:20.

Note: Set the time according to your IIS server timezone.

oweekday (integer): the day of the week to run the task. This field is only valid when the frequency is weekly.

➢0: Sunday

➢1: Monday

➢2: Tuesday

➢3: Wednesday

➢4: Thursday

➢5: Friday

➢6: Saturday

odayOfMonth (integer): which day of a month to run the task. This field is only valid when the frequency is monthly. The default is 1.

oMonths: which month to run the task. This field is optional and only valid when the frequency is monthly. The default value is 12.

▪deviceScope* (string): the devices included in this task. The device scope includes three types - 'all’, ‘deviceGroup’ and 'site’.

oFor the deviceGroup type, the scope should be the array of full path of deviceGroups. For example, Public/xxx, Private/xxx, or System/xxx.

oFor the site type, the scope should be the array of full path of sites. For example, My Network/Unnamed-site1/Site1.

▪limitRunMins (string): the time used to retrieve the data. When it reaches the specified time, the task will stop retrieving more data.

▪cliCommands (string): the customized CLI command to retrieve data. For example, show version.

▪isBuildIPv4L3Topo (bool): determine whether to build IPv4 L3 topology. The default value is false.

▪isBuildIPv6L3Topo (bool): determine whether to build IPv6 L3 topology. The default value is false.

▪isBuildL2Topo (bool): determine whether to build L2 topology. The default value is false.

▪isBuildIPsecVPNTopology (bool): determine whether to build IPsecVPN topology. The default value is false.

▪isRecalculateDynamicDeviceGroups (bool): determine whether to recalculate dynamic device groups. The default value is false.

▪isRecalculateSite (bool): determine whether to rebuild sites. This field is optional and the default value is false.

▪isRecalculateMPLSVirtualRouteTables (bool): determine whether to recalculate MPLS Virtual Route Table. The default value is false.

▪isbuildDefaultDeviceDataView (bool): determine whether to build default device data view. The default value is false.

▪isEnable (bool): determine whether to enable the task. The default value is true.

statusCode

integer

The returned status code of executing the API.

{
  "statusCode": 790200,
  "statusDescription": "success"
}

statusDescription

string

The explanation of the status code.