GET /csvRequest/jobs/{job_id}

Use this method to monitor the status of a management request using a bulk-import CSV file.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/csvRequest/jobs/{job_id}

where {job_id} is the job ID that was returned by the POST /csvRequest method.

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404 Not found A specified resource cannot be found. A descriptive error message is returned in the response body.
409 Conflict There is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
progress Double Percentage complete of the bulk management job. This can be one of the following values.
  • 0.0. Created.
  • 50.0. In progress.
  • 100.0. Complete.
results Array of objects Results of the bulk management jobs
  messageBundle String Location where messages.properties can be found if it is not located in the default task management bundle. This value is always com.lenovo.lxca.discovery.bundle.tasks.messages.
  messageID String Message ID
  messageAttributes String This can be one of the following values.
  • device IP if not null
  • device serial number if not null
  • device UUID
  progress Long Percentage complete of the management job. If the job is complete, JOB_DONE is returned
  result String Result of the request. This can be one of the following values.
  • INCOMPLETE. The request is not complete.
  • SUCCESS. The request was successful.
  • FAILED. The request failed.
  resultLongDescription String Detailed description of the result
  resultShortDescription String Summarized description of the result
  status Object Status details about the list of management steps
    description Array of objects List of message descriptions
      messageBundle String Location where messages.properties can be found if it is not located in the default task management bundle. This value is always com.lenovo.lxca.discovery.bundle.tasks.messages.
      messageID String Message ID for the set of management steps
    percentage Long Percentage complete of the set of management steps
    state String State of the set of management steps. The can be one of the following values.
  • Error
  • Running
  • Running_Complete
    substatus Array of objects Results of each of the task in the management job
      completed Boolean Indicates whether the task completed. This can be one of the following values.
  • true. The step has completed.
  • false. The task has not completed.
      id String Name of the management step
      longDescription String Long message description
      messageBundle String Location where messages.properties can be found if it is not located in the default task management bundle. This value is always com.lenovo.lxca.discovery.bundle.tasks.messages.
      messageID String Message ID of the management step
      progress Integer Progress of the management step
      shortDescription String Short message description
      started Boolean Indicates if the management step has started. This can be one of the following values.
  • true. The step has started.
  • false. The step has not started.
      status Object Status details about the individual management step
        percentage Integer Percentage complete of the management step
        state String State of the management step. This can be one of the following values.
  • ERROR
  • PENDING
  • RUNNING
  • RUNNING_COMPLETE
        substatus Array of objects Results of each of the subtask in the management job
      userAction String Any user action that is required
  taskid Integer Task ID
  time_spent Long Duration of the task in milliseconds
  uuid String UUID
status   Status of the management job. This can be one of the following values.
  • 0. Created.
  • 50. Incomplete.
  • 100. Done.
  • 101. Done_Warnimg.
The following example is returned if the request is successful.
{
   "progress": 17.647058823529413,
   "results": [{
      "messageBundle": "com.lenovo.lxca.discovery.bundle.rest.messages",
      "messageID": "0509_LONG",
      "messageParameters": "10.243.3.55"
      "progress": 17.647058823529413,
      "result": "INCOMPLETE",
      "resultLongDescription": "Management job is incomplete",
      "resultShortDescription": "Incomplete",
      "status": {
         "description": [{
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1014_LONG"
         }],
         "percentage": 17.647058823529413,
         "state": "Running",
         "substatus": [{
            "completed": true,
            "id": "STARTING",
            "longDescription": "Starting device management job",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1000_SHORT",
            "progress": 100,
            "shortDescription": "Starting",
            "started": true,
            "status": {
               "percentage": 100,
               "state": "Complete"
            },
            "userAction": ""
         },
         {
            "completed": true,
            "id": "NETWORK_CHOICE",
            "longDescription": "Choosing best network path to manage the device",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1001_SHORT",
            "progress": 100,
            "shortDescription": "Network choice",
            "started": true,
            "status": {
               "percentage": 100,
               "state": "Complete"
            },
            "userAction": ""
         },
         {
            "completed": true,
            "id": "DESCRIPTOR",
            "longDescription": "Creating hardware descriptor",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1002_SHORT",
            "progress": 100,
            "shortDescription": "Descriptor",
            "started": true,
            "status": {
               "percentage": 100,
               "state": "Complete"
            },
            "userAction": ""
         },
         {
            "completed": true,
            "id": "LOGIN",
            "longDescription": "Logging in to device",
            "messageID": "1003_SHORT",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "progress": 100,
            "shortDescription": "Login",
            "started": true,
            "status": {
               "percentage": 100,
               "state": "Complete"
            },
            "userAction": ""
         },
         {
            "completed": true,
            "id": "DUPLICATE_CHECK",
            "longDescription": "Checking for duplicates of device management",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1004_SHORT",
            "progress": 100,
            "shortDescription": "Duplicate check",
            "started": true,
            "status": {
               "percentage": 100,
               "state": "Complete"
            },
            "userAction": ""
         },
         {
            "completed": false,
            "id": "INVENTORY",
            "longDescription": "Collecting device inventory",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1005_SHORT",
            "progress": 0,
            "shortDescription": "Inventory",
            "started": true,
            "status": {
               "percentage": 0,
               "state": "Running",
               "substatus": [{
                  "completed": false,
                  "id": "INV_CHASSIS",
                  "longDescription": "Collecting chassis inventory",
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1006_SHORT",
                  "progress": 0,
                  "shortDescription": "Chassis inventory",
                  "started": true,
                  "status": {
                     "percentage": 0,
                     "state": "Running"
                  },
                  "userAction": ""
               },
               {
                  "completed": false,
                  "id": "INV_NODES",
                  "longDescription": "Collecting node inventory",
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1007_SHORT",
                  "progress": 0,
                  "shortDescription": "Node inventory",
                  "started": true,
                  "status": {
                     "percentage": 0,
                     "state": "Running"
                  },
                  "userAction": ""
               },
               {
                  "completed": false,
                  "id": "INV_IOMS",
                  "longDescription": "Collection I/O module inventory",
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1008_SHORT",
                  "progress": 0,
                  "shortDescription": "I/O module inventory",
                  "started": true,
                  "status": {
                     "percentage": 0,
                     "state": "Running"
                  },
                  "userAction": ""
               }]
            },
            "userAction": ""
         },
         {
            "completed": false,
            "id": "INTEROP_CHECK",
            "longDescription": "Verifying device interoperability",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1009_SHORT",
            "progress": 0,
            "shortDescription": "Interoperability check",
            "started": false,
            "status": {
               "percentage": 0,
               "state": "Pending"
            },
            "userAction": ""
         },
         {
            "completed": false,
            "id": "CONFIGURATION",
            "longDescription": "Configuring device for management",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1010_SHORT",
            "progress": 0,
            "shortDescription": "Configuration",
            "started": false,
            "status": {
               "percentage": 0,
               "state": "Pending",
               "substatus": [{
                  "completed": false,
                  "id": "CFG_NTP",
                  "progress": 0,
                  "longDescription": "Configuring NTP",
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1011_SHORT",
                  "started": false,
                  "status": {
                     "percentage": 0,
                     "state": "Pending"
                  },
                  "shortDescription": "NTP",
                  "userAction": ""
               },
               {
                  "completed": false,
                  "id": "CFG_DNS_UPD",
                  "longDescription": "Updating DNS servers ip addresses on CMM as part of the manage chassis 
                                      process.",
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1067_SHORT",
                  "progress": 0,
                  "shortDescription": "Updating DNS servers ip addresses on CMM",
                  "started": false,
                  "status": {
                     "percentage": 0,
                     "state": "Pending"
                  },
                  "userAction": ""
               },
               {
                  "completed": false,
                  "id": "CFG_SECURITY",
                  "longDescription": "Configuring security",
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1012_SHORT",
                  "progress": 0,
                  "shortDescription": "Security",
                  "started": false,
                  "status": {
                     "percentage": 0,
                     "state": "Pending"
                  },
                  "userAction": ""
               },
               {
                  "completed": false,
                  "id": "CFG_CMGMT",
                  "longDescription": "Putting device under centralized management",
                  "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
                  "messageID": "1013_SHORT",
                  "progress": 0,
                  "shortDescription": "Centralized management",
                  "started": false,
                  "status": {
                     "percentage": 0,
                     "state": "Pending"
                  },
                  "userAction": ""
               }]
            },
            "userAction": ""
         },
         {
            "completed": false,
            "id": "CFG_CABINET",
            "longDescription": "Configuring Hardware location",
            "messageBundle": "com.lenovo.lxca.discovery.bundle.tasks.messages",
            "messageID": "1097_SHORT",
            "progress": 0,
            "status": {
               "percentage": 0,
               "state": "Pending"
            },
            "shortDescription": "Configuring Hardware location",
            "started": false,
            "userAction": ""
         }]
      },
      "taskid": 371,
      "time_spent": 117527,
      "uuid": "48331a223bf34fba90732b379b837b9c"
   }],
   "status": "INCOMPLETE"
}