Add-KeyManagementServer Command | Vmware PowerCLI Reference

Add-KeyManagementServer

This cmdlet adds a key management server to a vCenter Server system.

Syntax

Add-KeyManagementServer
[ -KeyProvider ] < String >
-Address < String >
-Name < String >
-Port < Int32 >
-TrustKeyManagementServer < Boolean >
[-Credential < PSCredential > ]
[-Password < SecureString > ]
[-ProxyAddress < String > ]
[-ProxyPort < Int32 > ]
[-Server < VIServer[] > ]
[-Username < String > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 KeyProvider String 1
Specifies the key provider to which you want to add the key management server. This parameter also accepts objects of type KmsCluster through an ArgumentTransformationAttribute object.
required
 Address String named
Specifies the address of the Key Management Interoperability Protocol server.
required
 Name String named
Specifies the name of the Key Management Interoperability Protocol server you want to add.
required
 Port Int32 named
Specifies the port number of the Key Management Interoperability Protocol server.
required
 TrustKeyManagementServer Boolean named
Indicates whether the vCenter Server system can trust the key management server certificate.
optional Credential PSCredential named
Specifies a PSCredential object that contains credentials for authenticating with the key management server.
optional Password SecureString named
Specifies the password you want to use for authenticating with the Key Management Interoperability Protocol server.
optional ProxyAddress String named
Specifies the address of the proxy server.
optional ProxyPort Int32 named
Specifies the port number of the proxy server.
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
optional Username String named
Specifies the user name you want to use for authenticating with the Key Management Interoperability Protocol server.

Output

VMware.VimAutomation.Storage.Types.V1.Encryption.KeyManagementServer

Examples

Example 1 

Add-KeyManagementServer -Name 'KMS' -KeyProvider 'KeyProvider' -Address $kmsAddress -Port $kmsPort -ProxyAddress $proxyAddress -ProxyPort $proxyPort -TrustKeyManagementServer $true

Adds the key management server named 'KMS' to the 'KeyProvider' key provider that runs at the $kmsAddress address, $kmsPort port, and trusts the key management server certificate.

Related Commands

KeyManagementServer

This cmdlet adds a key management server to a vCenter Server system.

This cmdlet retrieves the key management servers registered on the vCenter Server system.

This cmdlet removes the specified key management servers from the vCenter Server systems.

This cmdlet configures the settings of the key management server.

KeyProvider

This cmdlet exports a specified key provider configuration to a specified file. You can use only the NativeKeyProvider type for the KeyProvider parameter.

This cmdlet imports a key provider from a specified configuration file.

This cmdlet registers a trusted key provider in the workload vCenter Server system which you can use for encryption operations.

This cmdlet unregisters the specified key provider from the workload vCenter Server system. For a trusted key provider, you cannot use it in encryption operations. For a standard key provider, you can remove it from the workload vCenter Server system.

This cmdlet retrieves all key providers from the vCenter Server system.

This cmdlet modifies the settings of the specified key provider.

KeyProviderServiceInfo

This cmdlet adds key provider service information, which comes from the Trust Authority key provider service running in the Trust Authority system or its detailed information in the workload vCenter Server system.

This cmdlet retrieves the key provider services information configured in the workload vCenter Server system.

This cmdlet removes the specified key provider services information from the workload vCenter Server system.