PowerCLI Reference

Add-KeyManagementServer

Synopsis

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

Syntax

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

Related Commands

Online Version
Get-KeyManagementServer
Remove-KeyManagementServer
Set-KeyManagementServer

Detailed Description

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

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecifies the name of the Key Management Interoperability Protocol server you want to add.trueFalse
KmsClusterStringSpecifies the key management server cluster to which you want to add the key management server. This parameter also accepts objects of type KmsCluster through an ArgumentTransformationAttribute object.trueFalse
AddressStringSpecifies the address of the Key Management Interoperability Protocol server.trueFalse
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
CredentialPSCredentialSpecifies a PSCredential object that contains credentials for authenticating with the key management server.falseFalse
PasswordSecureStringSpecifies the password you want to use for authenticating with the Key Management Interoperability Protocol server.falseFalse
PortInt32Specifies the port number of the Key Management Interoperability Protocol server.trueFalse
ProxyAddressStringSpecifies the address of the proxy server.falseFalse
ProxyPortInt32Specifies the port number of the proxy server.falseFalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falseFalse
TrustKeyManagementServerBooleanIndicates whether the vCenter Server system can trust the key management server certificate.trueFalse
UsernameStringSpecifies the user name you want to use for authenticating with the Key Management Interoperability Protocol server.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

The newly added KeyManagementServer object

Notes

Examples

-------------------------- Example 1 --------------------------

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

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


Copyright © VMware, Inc. All rights reserved.