Skip to main content

GET /cryptoSettings

Use this method to return information about current cryptographic settings on Lenovo XClarity Administrator.

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/cryptoSettings

Query parameters​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
responseArray of objectsInformation about each cryptography setting
 cipherSuiteString
Attention
This attribute will be deprecated in a future release.

Minimum cipher suite version to use for server connections. This can be one of the following values.

  • tls1.2. TLS v1.2 or v1.3 cipher suite is required for both servers and clients.

    Specify tls1.2 for the minTlsVersionClient and minTlsVersionServer attributes instead.

  • tls1.2-flexcat. TLS v1.2 compliance with exceptions for deploying operating systems from the XClarity Administrator. Specify tls1.2 for the minTlsVersionClient, minTlsVersionServer, minTlsVersionOsDeploy attributes instead.
 minTlsVersionClientStringMinimum TLS protocol version to use for client connections to other servers (such as the LDAP client). This can be one of the following values.
  • TLS1.2. Enforces TLS v1.2 cryptography protocols.
  • TLS1.3. Enforces TLS v1.3 cryptography protocols.
 minTlsVersionOsDeployStringMinimum TLS protocol version to for the Lenovo XClarity Administrator operating-system deployment server. This can be one of the following values.
  • TLS1.2. Enforces TLS v1.2 cryptography protocols.
  • TLS1.3. Enforces TLS v1.3 cryptography protocols.
 minTlsVersionServerStringMinimum TLS protocol version to use for server connections (such as the web server). This can be one of the following values.
  • TLS1.2. Enforces TLS v1.2 cryptography protocols.
  • TLS1.3. Enforces TLS v1.3 cryptography protocols.
 nistModeStringCryptographic mode of Lenovo XClarity Administrator and all managed chassis. This can be one of the following values.
  • nistcomp. NIST compatibility mode.
  • nist800-131a. NIST800-131A strict compatibility mode. When this option is selected, you must also select tls1.2 for the minTlsVersionClient and minTlsVersionServer attributes.
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failure. The request failed. A descriptive error message was returned.
messagesArray of objectsInformation about one or more messages
 explanationStringAdditional information to clarify the reason for the message
 idStringMessage identifier of a returned 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
 textStringMessage text associated with the message identifier
The following example is returned if the request is successful.
{
   "response": {
      "cipherSuite": "tls1.2"
      "minTlsVersionClient": "tls1.2",
      "minTlsVersionOsDeploy": "tls1.2",
      "minTlsVersionServer": "tls1.2",
      "nistMode": "nist800-131a"
   },
   "result": "success",
   "messages": [{
      "explanation": "",
      "id": "FQXHMSE0001I",
      "recovery": {
         "text": "Information only; no action is required.",
         "URL": ""
      },
      "text": "The request completed successfully."
   }]
}