Skip to main content

PUT /nodes/cryptoSettings

Use this method to modify the current cryptographic settings on one or more managed servers with XCC2.

This method starts a job that runs in the background to perform the operation. The response header includes a URI in the form /tasks/{task_id} (for example, /tasks/12) that represents the job that is created to perform this request. You can use GET /tasks/{job_list} to monitor the status and progress of the job. If a job was not successfully started, refer to the response code and response body for details.

Attention
A successful response indicates that the request was successfully created and accepted by the management server. It does not indicate that the operation that is associated with the job was successful.

To modify the current cryptographic setting for the management server, use PUT /cryptoSettings.

Note
This REST API requires Lenovo XClarity Administrator v4.0.0 or later.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/nodes/cryptoSettings

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
uuidRequiredStringUUID of the managed device to configure
securityModeRequiredStringSecurity Mode. This can be one of the following values.
  • NIST SP 800-131A
  • Compatibility Security
  • Standard Security
  • Enterprise Strict Security
The following example set security mode for all target servers.
[{
   "uuid": "fbb43c13103511e785f2e4a2ced78753",
   "securityMode": "Standard Security"
},
{
   "uuid": "23abc13103511e785f2e4a2ced787de",
   "securityMode": "Standard Security"
}]

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
resultStringResults 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.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
    "result": "success",
    "messages": [{
        "explanation": "",
        "id": "FQXHMSE0001I",
        "recovery": {
            "text": "Information only; no action is required.",
            "URL": ""
        },
        "text": "The request completed successfully."
    }]
}