ModifyKeyServerKmip

You can use the ModifyKeyServerKmip method to modify an existing Key Management Interoperability Protocol (KMIP) key server to the specified attributes. Although the only required parameter is the keyServerID, a request containing only the keyServerID will take no action and return no error. Any other parameters you specify will replace the existing values for the key server with the specified keyServerID. The key server is contacted during the operation to ensure that it is functional. You can provide multiple hostnames or IP addresses with the kmipKeyServerHostnames parameter, but only if the key servers are in a clustered configuration.

Parameters

This method has the following input parameters:

Name Description Type Default value Required
keyServerID The ID of the KMIP Key Server to modify. integer None Yes
kmipCaCertificate The public key certificate of the external key server’s root CA. This will be used to verify the certificate presented by external key server in the TLS communication. For key server clusters where individual servers use different CAs, provide a concatenated string containing the root certificates of all the CAs. string None No
kmipClientCertificate A PEM format Base64 encoded PKCS#10 X.509 certificate used by the Solidfire KMIP client. string None No
kmipKeyServerHostnames Array of the hostnames or IP addresses associated with this KMIP key server. Multiple hostnames or IP addresses must only be provided if the key servers are in a clustered configuration. string array None No
kmipKeyServerName The name of the KMIP key server. This name is only used for display purposes and does not need to be unique. string None No
kmipKeyServerPort The port number associated with this KMIP key server (typically 5696). integer None No

Return values

This method has the following return values:

Name Description Type
kmipKeyServer An object containing details about the newly modified key server. KeyServerKmip

Request example

Requests for this method are similar to the following example:

{
  "method": "ModifyKeyServerKmip",
  "params": {
    "keyServerID": 15
    "kmipCaCertificate": "CPDCCAaUCEDyRMcsf9tAbDpq40ES/E...",
    "kmipClientCertificate": "kirWmnWXbj9T/UWZYB2oK0z5...",
    "kmipKeyServerHostnames" : ["server1.hostname.com", "server2.hostname.com"],
    "kmipKeyServerName" : "keyserverName",
    "kmipKeyServerPort" : 5696
  },
"id": 1
}

Response example

This method returns a response similar to the following example:

{
   "id": 1,
   "result": 
      {
        "kmipKeyServer": {
            "kmipCaCertificate":"CPDCCAaUCEDyRMcsf9tAbDpq40ES/E...",
            "kmipKeyServerHostnames":[
                "server1.hostname.com", "server2.hostname.com"
            ],
            "keyProviderID":1,
            "kmipKeyServerName":"keyserverName",
            "keyServerID":1
            "kmipKeyServerPort":1,
            "kmipClientCertificate":"kirWmnWXbj9T/UWZYB2oK0z5...",
            "kmipAssignedProviderIsActive":true
        }
    }
}

New since version

11.7