Syntax
Get-KmipClientCertificate [-KmsCluster] <KmsCluster> [-CertificateSigningRequest] [-FilePath <String>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet retrieves the latest generated self-signed certificate or certificate-signing request for the key management server cluster. The self-signed certificate or certificate-signing request is available until the key management server cluster is updated with the generated certificate by using the Set-KmsCluster cmdlet.Parameters
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
KmsCluster | KmsCluster | Specifies the key management server cluster for which you want to use the certificate as a client certificate. | true | true (ByValue) | |
CertificateSigningRequest | SwitchParameter | Indicates whether a certificate-signing request should be retrieved. This certificate-signing request should be signed by the key management server and uploaded to the vCenter Server system. | false | 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. | false | false | |
FilePath | String | Specifies the file path to which you want to export the self-signed certificate or certificate-signing request. | false | 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. | false | false | |
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false |
Return Type
The self-signed client certificate or the certificate-signing request to be signed by the key management serverNotes
Examples
-------------- Example 1 --------------
Get-KmipClientCertificate -KmsCluster $kmsCluster
Retrieves the latest generated self-signed client certificate for the $kmsCluster key management server cluster.
-------------- Example 2 --------------
Get-KmipClientCertificate -KmsCluster $kmsCluster -CertificateSigningRequest -FilePath $filePath
Retrieves the latest generated certificate-signing request for the $kmsCluster key management server cluster and exports it to the $filePath file path.