DELETE /osImages/{images_list}

Use this method to remove one or more OS images, OS image-profiles, and custom files (such as device drivers, boot files, configuration settings, installation scripts, software, and unattend files) from the Lenovo XClarity Administrator OS images repository.

Authentication

Authentication with user name and password is required.

Request URL

DELETE https://{management_server_IP}/osImages/{images_list}

where <images_list} is a list of one or more IDs, separated by a comma, for OS images, OS image profile, and custom files such as device drivers, boot files, configuration settings, installation scripts, software, and unattend files (for example, hba-elxcna-windows2016-v1,hba-elxfc-windows2016-v1). To obtain the ID, use the GET /osImages method.

Note:
  • If you specify an operating-system image, the operating system image and all associated profiles are deleted. If you specify an OS profile, only the profile is deleted; all other profiles for the operating system remain.

  • Specify either a full OS image ID or one or more OS image profile IDs for that OS image. Specifying both the full OS image ID and OS image profile IDs for that OS image in the same URI might result in errors.

Query parameters

None

Request body

None

Response codes

Code Description Comments
204 No Content The request completed successfully, but no response content is returned (for example, a successful DELETE request).
401 Unauthorized The user cannot be authenticated. Authentication has not been provided or has failed. 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.

For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions.

412 Precondition failed Specified data is invalid because of missing values. 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

None