Skip to main content

DELETE /osImages

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 username and password is required.

Request URL​

DELETE https://{management_server_IP}/osImages

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
selectedFilesListRequiredStringList 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

To obtain the image IDs, use GET /osImages.

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.

The following example removes multiple OS images.
{
   "selectedFilesList": "other-amdchipset-ccp-win2022,other-amdchipset-amddrtm-win2022"
}

Response codes​

CodeDescriptionComments
204No ContentThe request completed successfully, but no response content is returned.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403ForbiddenThe 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.

412Precondition failedSpecified data is invalid because of missing values. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

None