Add-KeyManagementServer

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

Syntax

[-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.