GET /osImages/{file_name}

Use this method to export a customized OS image profile to a remote file server or local system.

You must first create a tar.gz file that contains the customized OS image profile using the GET /osImages/{id} method.

Note: This REST API requires Lenovo XClarity Administrator v1.3.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/osImages/{file_name}

where {file_name} is the name of the tar.gz file that contains the customized OS image profile. The file name was returned when the GET /osImages/{id} method completed successfully.

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
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.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

None

Parent topic: /osImages/{file_name}