< Back
Set-KmsCluster
Post
NAME 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>]
DESCRIPTION
This cmdlet configures the settings of the specified key management server clusters.
PARAMETERS
-KmsCluster <KmsCluster[]>
Specifies the key management server clusters you want to configure.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-KmsProvidedClientCertificate <String>
Specifies the certificate provided by the key management server and its private key. Either this parameter or
the KmsProvidedClientCertificateFilePath parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsProvidedClientCertificateFilePath <String>
Specifies the file path to the certificate file provided by the key management server. Either this parameter
or the KmsProvidedClientCertificate parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsProvidedPrivateKey <SecureString>
Specifies 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsProvidedPrivateKeyFilePath <String>
Specifies the private key file path provided by the key management server. Either this parameter or the
KmsProvidedPrivateKey parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsSignedClientCertificate <String>
Uploads 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsSignedClientCertificateFilePath <String>
Specifies the file path to the certificate file signed by the key management server. Either this parameter or
the KmsSignedClientCertificate parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SelfSignedClientCertificate <String>
Specifies 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SelfSignedClientCertificateFilePath <String>
Specifies the file path to the self-signed certificate. Either this parameter or the
SelfSignedClientCertificate parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-UseAsDefaultKeyProvider [<SwitchParameter>]
Specifies the key management server cluster you want to use as the default key provider.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The list of modified KmsCluster objects
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... uster.html
Get-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>]
DESCRIPTION
This cmdlet configures the settings of the specified key management server clusters.
PARAMETERS
-KmsCluster <KmsCluster[]>
Specifies the key management server clusters you want to configure.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-KmsProvidedClientCertificate <String>
Specifies the certificate provided by the key management server and its private key. Either this parameter or
the KmsProvidedClientCertificateFilePath parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsProvidedClientCertificateFilePath <String>
Specifies the file path to the certificate file provided by the key management server. Either this parameter
or the KmsProvidedClientCertificate parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsProvidedPrivateKey <SecureString>
Specifies 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsProvidedPrivateKeyFilePath <String>
Specifies the private key file path provided by the key management server. Either this parameter or the
KmsProvidedPrivateKey parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsSignedClientCertificate <String>
Uploads 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsSignedClientCertificateFilePath <String>
Specifies the file path to the certificate file signed by the key management server. Either this parameter or
the KmsSignedClientCertificate parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SelfSignedClientCertificate <String>
Specifies 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SelfSignedClientCertificateFilePath <String>
Specifies the file path to the self-signed certificate. Either this parameter or the
SelfSignedClientCertificate parameter should be specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-UseAsDefaultKeyProvider [<SwitchParameter>]
Specifies the key management server cluster you want to use as the default key provider.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The list of modified KmsCluster objects
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... uster.html
Get-KmsCluster