INC Platform - iCC Management

Query Deployment Task Results

Query the execution result of a deployment task with the specified ID.

Interface URI

/icc/deploy/confFileTask/{taskId}

Access Method

HTTP method: GET
Parameters

Return Values

Status codes

200(OK): Success.

Message header

HTTP/1.1 200 OK

Message body

<taskResult>
  <taskId>28</taskId>
  <taskName>cli 5.2</taskName>
  <taskSubType>1</taskSubType>
  <status>1</status>
  <operationResult>4</operationResult>
  <scheduleType>2</scheduleType>
  <creator>admin</creator>
  <lastBeginTime>2018-04-09 11:34:36</lastBeginTime>
  <nextBeginTime>2018-04-09 00:00:00</nextBeginTime>
  <executionResult>
    <executionTime>2018-04-09 11:34:41</executionTime>
    <deviceResult>
      <deviceId>5</deviceId>
      <deviceName>mycompany(172.22.5.2)</deviceName>
      <startTimeOnDevice>2018-04-09 11:34:36</startTimeOnDevice>
      <endTimeOnDevice>2018-04-09 11:34:41</endTimeOnDevice>
      <executionStatus>14</executionStatus>
      <executionStatusStr>Execution finished on a device</executionStatusStr>
      <operationResult>6033</operationResult>
      <operationResultStr>CLI command execution failed.</operationResultStr>
      <detail>
        <index>1</index>
        <description>Initialize task parameters. </description>
        <result>0</result>
        <resultStr>Operation succeeded. </resultStr>
        <suggestion></suggestion>
        <beginTime>2018-04-09 11:34:36</beginTime>
        <finishTime>2018-04-09 11:34:37</finishTime>
      </detail>
      <detail>
        <index>2</index>
        <description>Deploy the running configuration file to the device. </description>
        <result>6033</result>
        <resultStr>CLI command execution failed. </resultStr>
        <suggestion>1. Verify that the CLI commands are correct. 2. Verify that the Telnet/SSH username and password are correct. </suggestion>
        <beginTime>2018-04-09 11:34:38</beginTime>
        <finishTime>2018-04-09 11:34:41</finishTime>
      </detail>
      <cliScriptRunningProcess>
        <index>1</index>
        <command>system-view</command>
        <responsePrompt>System View: return to User View with Ctrl+Z.</responsePrompt>
        <responseExpect>System View: return to User View with Ctrl+Z.</responseExpect>
        <result>0</result>
        <resultStr>操作成功。</resultStr>
      </cliScriptRunningProcess>
      <cliScriptRunningProcess>
        <index>2</index>
        <command>VLANa 100</command>
        <responsePrompt></responsePrompt>
        <responseExpect></responseExpect>
        <result>6128</result>
        <resultStr>Result is unknown,command has not been executed.</resultStr>
      </cliScriptRunningProcess>
    </deviceResult>
  </executionResult>
</taskResult>

Element description

taskResult subelements
taskId	Deployment task ID. Long integer type.
taskName	Deployment task name. String type.
taskSubType	Task subtype. Integer type. Options are: 1: Deploy device configuration. 2: Restore device configuration. 3: Back up device software. 4: Deploy device software. 5: Restore device software from NMS. 6: Restore device software from device. 15: Automatically back up device configuration. 16: Manually back up device configuration. 17: Back up network-wide device configuration.
status	Status. Integer type. 1: Waiting for execution. 2: Executing. 3: Suspending. 4: Suspended. 5: Finished. 6: Task expired. 7: To be approved. 8: Disapproved. 9: To be submitted for approval. 10: Approval process deleted.
operationResult	Execution result. Integer type. 1: Success. 2: Failure. 3: Partial success. 4: Unfinished.
scheduleType	Execution period. Integer type. 0: Executed immediately. 1: Once scheduled task. 2: Daily. 3: Weekly. 4: Monthly.
creator	Creator. String type.
lastBeginTime	Last start time. String time.
nextBeginTime	Next start time. String type.
executionResult	Task execution result. A taskResult element can contain multiple executionResult elements.

executionResult subelements
executionTime	Execution time. String type.
deviceResult	Execution result on a device. An executionResult element can contain multiple deviceResult elements.

deviceResult subelements
deviceId	Device ID. Long integer type.
deviceName	Device name. String type.
startTimeOnDevice	Execution start time on a device. String type.
endTimeOnDevice	Execution end time on a device. String type.
executionStatus	Execution status code. Integer type.
executionStatusStr	Execution status. String type.
operationResult	Execution result code. Integer type.
operationResultStr	Execution result. String type.
detail	Detailed procedure. A deviceResult element can contain multiple detail elements.
cliScriptRunningProcess	CLI script execution process. A deviceResult element can contain multiple cliScriptRunningProcess elements.

detail subelements
index	Step number. Integer type.
description	Step description. String type.
result	Result. Integer type.
resultStr	Result. String type.
suggestion	Repairing suggestion. String type.
beginTime	Start time. String type.
finishTime	End time. String type.

cliScriptRunningProcess subelements
index	Execution number. Integer type.
command	Command. String type.
responsePrompt	Response. String type.
responseExpect	Response Expect. String type.
result	Result Code. Integer type.
resultStr	Result. String type.

Example

Query the result of the deployment task with ID 28.

Request
Response