PowerCLI Reference

Set-KmsCluster

Synopsis

This cmdlet configures the settings of the specified key management server clusters.

Syntax

Set-KmsCluster [-KmsCluster] <KmsCluster[]> [-KmsProvidedClientCertificate <String>] [-KmsProvidedClientCertificateFilePath <String>] [-KmsProvidedPrivateKey <SecureString>] [-KmsProvidedPrivateKeyFilePath <String>] [-Server <VIServer[]>] [-UseAsDefaultKeyProvider] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-KmsCluster [-KmsCluster] <KmsCluster[]> [-KmsSignedClientCertificate <String>] [-KmsSignedClientCertificateFilePath <String>] [-Server <VIServer[]>] [-UseAsDefaultKeyProvider] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-KmsCluster [-KmsCluster] <KmsCluster[]> [-SelfSignedClientCertificate <String>] [-SelfSignedClientCertificateFilePath <String>] [-Server <VIServer[]>] [-UseAsDefaultKeyProvider] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-KmsCluster

Detailed Description

This cmdlet configures the settings of the specified key management server clusters.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
KmsClusterKmsCluster[]Specifies the key management server clusters you want to configure.trueTrue (ByValue)
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
KmsProvidedClientCertificateStringSpecifies the certificate provided by the key management server and its private key. Either this parameter or the KmsProvidedClientCertificateFilePath parameter should be specified.falseFalse
KmsProvidedClientCertificateFilePathStringSpecifies the file path to the certificate file provided by the key management server. Either this parameter or the KmsProvidedClientCertificate parameter should be specified.falseFalse
KmsProvidedPrivateKeySecureStringSpecifies the private key for the key management IP client, if it is provided by the key management server. Either this parameter or the KmsProvidedPrivateKeyFilePath parameter should be specified.falseFalse
KmsProvidedPrivateKeyFilePathStringSpecifies the private key file path provided by the key management server. Either this parameter or the KmsProvidedPrivateKey parameter should be specified.falseFalse
KmsSignedClientCertificateStringUploads the key management server-signed client certificate for the key management IP cluster. The server uses the certificate for authentication with the key management server in the cluster. Either this parameter or the KmsSignedClientCertificateFilePath parameter should be specified.falseFalse
KmsSignedClientCertificateFilePathStringSpecifies the file path to the certificate file signed by the key management server. Either this parameter or the KmsSignedClientCertificate parameter should be specified.falseFalse
SelfSignedClientCertificateStringSpecifies the self-signed certificate for the key management server IP cluster. The server uses the certificate for authentication with the key management server in the cluster. Either this parameter or the SelfSignedClientCertificateFilePath parameter should be specified.falseFalse
SelfSignedClientCertificateFilePathStringSpecifies the file path to the self-signed certificate. Either this parameter or the SelfSignedClientCertificate parameter should be specified.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
UseAsDefaultKeyProviderSwitchParameterSpecifies the key management server cluster you want to use as the default key provider.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 list of modified KmsCluster objects

Notes

Examples

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

Set-KmsCluster -KmsCluster $kmsCluster -SelfSignedClientCertificate $certificate -UseAsDefaultKeyProvider

Updates the client certificate with the $certificate self-signed certificate and marks the $kmsCluster key management server cluster as the default key provider.

-------------------------- Example 2 --------------------------

Set-KmsCluster -KmsCluster $kmsCluster -KmsProvidedClientCertificate $certificate -KmsProvidedPrivateKey $privateKey

Updates the client certificate and its private key with $certificate and $privateKey for the $kmsCluster key management server cluster.


Copyright © VMware, Inc. All rights reserved.