PUT /nodes/{UUID}/mediaMount/{UID}

Use this method to unmount specific media that was previously mounted to a specific server.

Note:
  • This API is not supported for ThinkServer servers. To unmount media from a ThinkServer server, use the PUT /nodes/{UUID}/mediaMount method.

  • This API requires Lenovo XClarity Administrator v2.4.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

PUT https://{management_server_IP}/nodes/{UUID}/mediaMount/{UID>
where
  • {UUID} is the UUID of a server. To obtain the server UUID, use the GET /nodes method.

  • {UID} is the UID of the mounted media. To obtain the mounted-media UID, use the GET /nodes/{UUID}/mediaMount method.

Query parameters

None

Request body

Attributes Required / Optional Type Description
action Required String Unmounts an image when unmount is specified
This example unmounts the specified media from the specified server.
{
   "action": "unmount",
}

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.
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. If the management server is not license compliant, the compliance response code is set to 0.

500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
statusCode Integer Return code
statusDescription String Description of the return code
messages Array of objects Information about one or more messages
  explanation String Additional information to clarify the reason for the message
  id String Message identifier of a returned message
  recovery String Recovery information
  recoveryURL String Link to the help system for more information about how to recover, if available
  text String Message text associated with the message identifier
The following example is returned if the request is successful.
{
   "statusCode": 403,
   "statusDescription": "The request is forbidden by server.",
   "messages": [{
      "explanation": "The mount media request to the endpoint has been rejected..",
      "id": "FQXDM0403N",
      "recovery": "Verify the request and make sure it is allowed by server."
      "recoveryUrl": "",
      "text": "The request is forbidden by server
   }]
}