KMIP for vSphere

Add a KMS to vCenter Server in vSphere Web Client

Create a KMIP Client on Akeyless Gateway

  1. From Akeyless CLI - enable the KMIP server:

    akeyless kmip-server-setup --hostname <akeyless.gateway.hostname> --gateway-url <Your_Akeyless_GW_URL> --root /kmip/default
  2. Create KMIP client:

    akeyless kmip-create-client --name myVCenter --gateway-url <Your_Akeyless_GW_URL>

    This returns the client ID, private key and certificate:

    $ New client successfully created.
    Client ID: Zvzw0...VM2u
    Client Key:
    -----BEGIN RSA PRIVATE KEY-----
    MIIEpA...yRCF8UQ==
    -----END RSA PRIVATE KEY-----
    
    Client Certificate:
    -----BEGIN CERTIFICATE-----
    MIIDSz...0otOEQQ==
    -----END CERTIFICATE-----
  3. Save the received certificate and key in a safe place, they will be used to set up the connection.

  4. By default, KMIP clients have no permissions. To grant your KMIP client minimal access permissions, execute the following command:

    akeyless kmip-client-set-rule --gateway-url <Your_Akeyless_GW_URL> --client-id <From step 2, kc-TmA3...VM2u> \
        --path "/*" \
        --capability CREATE \
        --capability GET \
        --capability GET_ATTRIBUTES \
        --capability ACTIVATE

vCenter Server Setup

  1. Log in to the vCenter Server system with the vSphere Web Client.

  2. Browse the inventory list and select the vCenter Server instance.

  3. Click Configure, then click Key Management Servers.

    Illustration for: 3. Click Configure, then click Key Management Servers.

  4. Click Add KMS. For Server address, supply your Akeyless Gateway address, for Server port, use 5696. Click Add.

    Illustration for: 4. Click Add KMS. For Server address, supply your Akeyless Gateway address. For Server port, use 5696. Click Add.

  5. Extend the new line and click Make KMS Trusted vCenter:

    Illustration for: 5. Extend the new line and click Make KMS Trusted vCenter.

  6. For a method, choose KMS certificate and private key:

    Illustration for: 6. For a method, choose KMS certificate and private key.

  7. For the KMS Certificate and KMS Private key set the certificate and the Private Key and click Establish Trust:

    Illustration for: 7. For the KMS Certificate and KMS Private key set the certificate and the Private Key and click Establish Trust.

  8. Extend the new line again and click Make vCenter Trust KMS:

    Illustration for: 8. Extend the new line again and click Make vCenter Trust KMS.

  9. In the dialog, click TRUST:

    Illustration for: 9. In the dialog, click TRUST.

  10. Verify all statuses are valid:

    Illustration for: 10. Verify all statuses are valid.

Read more about Enabling Host Encryption Mode in vSphere.


Footer Section