PUT /hostPlatforms/<UUID>

Use this PUT method to modify OS deployment status.

Note: This API requires Lenovo XClarity Administrator v2.0.0 or later.

Authentication

Certificates are used to authenticate to the management server.

Request URL

PUT https://<management_server_IP>:8443/hostPlatforms/<UUID>
where <UUID> is the UUID of the target server. To obtain the UUIDs, complete one of the following steps.
  • Use the urlStatus object in the OS-profile configuration file (custom_payload.json) on the host server.

  • Use the predefined macro otherSettings.statusSettings.urlStatus.

  • Use the GET /nodes method.

Note: You must include port 8443 in the URL for this method.

Query parameters

None

Request body

Attributes Required / Optional Type Description
deployStatus Required Object Information about the OS deployment status
  id Required String Deployment status ID
  • 0. Ready
  • 1. Not Ready
  • 2. Unknown OS Deploy Status
  • 3. No OS being deployed
  • 4. OS Deployment Starting
  • 5. Pre-deployment Validation
  • 6. Node Created
  • 7. Node Updated
  • 8. Bootable ISO Created
  • 9. Bootable ISO Mounted
  • 10. Boot Order Sequence Modified
  • 11. Node Rebooting
  • 12. Node Restarted
  • 13. Preparing Server for OS installation
  • 14. Installing OS
  • 15. Post-Installation Processing
  • 16. Starting newly installed OS
  • 17. OS Installation Completed
  • 18. OS Discovery Started
  • 19. Post-Deployment Cleanup Started
  • 20. OS Deployment Failed
  • 21. OS Deployment Stopped
  • 22. Failed Preparing Server for OS Installation - storage failure
  • 23. Failed Preparing Server for OS Installation - unsupported USB storage failure
  • 24. Failed Preparing Server for OS Installation - unsupported SAN detected failure
  • 25. Failed Preparing Server for OS Installation - Windows partition failure XCAT status
  • 26. Active directory join failed
  • 27. Active directory join succeeded using domain credentials

  • 28. Active directory join succeeded using blob

  • 29. Failed Preparing Server for OS Installation – hypervisor key detected

  • 30. Custom post-install scripts started

  • 31. Custom post-install script started

  • 32. Custom post-install script completed

  • 33. Custom post-install scripts completed

  • 34. Downloading custom software payloads

  • 35. Downloading custom software payload

  • 36. Finished downloading custom software payload

  • 37. Error downloading custom software payload

  • 38. Finished downloading custom software payloads

  • 39. Extracting custom software payloads

  • 40. Extracting custom software payload

  • 41. Finished extracting custom software payload

  • 42. Error extracting custom software payload

  • 43. Finished extracting custom software payloads

  • 44. Workload deployment succeeded

  • 45. Workload deployment is running with warning

  • 46. Workload deployment failed

  • 47. Workload deployment message

  • 48. Custom post-install script error

  • 49. Installing custom drivers

  • 50. Installing custom driver

  • 51. Finished installing custom driver

  • 52. Error installing custom driver

  • 53. Finished installing custom drivers

Note: If the deployStatus is "Not Ready," use the readyCheck attribute to get information to help resolve the problem.
  Attributes Required Array of strings Message parameters
The parameters vary depending on the status ID:
  • 25. Disk ID that contains system partition or the partition ID that is system partition

  • 26. Error message for active directory join

  • 27. Name of active directory domain

  • 31. Name of post install script

  • 32. Name of post install script

  • 35. Name of custom software payload

  • 36. Name of custom software payload

  • 37. Name of custom software payload, error message

  • 40. Name of custom software payload

  • 41. Name of custom software payload

  • 42. Name of software payload, error message

  • 45. Warning message for workload deployment

  • 46. Error message for workload deployment

  • 47. Message for workload deployment

  • 48. Name of post install script, error message

  • 50. Name of driver file

  • 51. Name of driver file

  • 52. Name of driver file, error message

Request example

{
   "deployStatus": {
      "id": "32",
      "parameters": [ "customscript.sh", "-1" ]
   }
}

Response codes

Code Description
200 OK. The request completed successfully.
409 Conflict. The request could not be completed due to a conflict with the current state of the resource. Wait until the state is valid, and attempt the request again.
500 Internal server error. An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

{
   "result": "success",
   "messages": []
}