ModifyKeyServerKmip

ModifyKeyServerKmipメソッドを使用すると、既存のKey Management Interoperability Protocol(KMIP)キー サーバを指定した属性に変更できます。唯一の必須パラメータはkeyServerIDですが、keyServerIDのみを含む要求は処理を実行せず、エラーは返されません。その他のパラメータを指定すると、キー サーバの既存の値が指定したkeyServerIDに置き換えられます。キー サーバは、機能していることを確認するため操作中に接続されます。キー サーバがクラスタ構成になっている場合にのみ、kmipKeyServerHostnamesパラメータに複数のホスト名またはIPアドレスを指定できます。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
keyServerID 変更するKMIPキー サーバのID。 整数 なし 有効
kmipCaCertificate 外部キー サーバのルートCAの公開鍵証明書。これは、TLS通信で外部キー サーバから提示された証明書を検証するために使用されます。個々のサーバが異なるCAを使用するキー サーバ クラスタの場合は、すべてのCAのルート証明書を含む連結文字列を指定します。 文字列 なし 無効
kmipClientCertificate SolidFire KMIPクライアントで使用されるPEM形式Base64エンコードPKCS#10 X.509証明書。 文字列 なし 無効
kmipKeyServerHostnames このKMIPキー サーバに関連付けられているホスト名またはIPアドレスの配列。キー サーバがクラスタ構成の場合にのみ、複数のホスト名またはIPアドレスを指定する必要があります。 文字列の配列 なし 無効
kmipKeyServerName KMIPキー サーバの名前。この名前は表示専用であり、一意にする必要はありません。 文字列 なし 無効
kmipKeyServerPort KMIPキー サーバに関連付けられているポート番号(通常は5696)。 整数 なし 無効

戻り値

このメソッドの戻り値は次のとおりです。

名前 説明 タイプ
kmipKeyServer 変更されたキー サーバに関する詳細を含むオブジェクト。 KeyServerKmip

要求例

このメソッドの要求例を次に示します。

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

応答例

このメソッドの応答例を次に示します。

{
   "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
        }
    }
}

新規導入バージョン

11.7