< Back
Get-KmipClientCertificate
Post
NAME Get-KmipClientCertificate
SYNOPSIS
This cmdlet retrieves the latest generated self-signed certificate or certificate-signing request for the key
management server cluster.
SYNTAX
Get-KmipClientCertificate [-KmsCluster] <KmsCluster> [-CertificateSigningRequest] [-FilePath <String>] [-Server
<VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
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
-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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-FilePath <String>
Specifies the file path to which you want to export the self-signed certificate or certificate-signing request.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsCluster <KmsCluster>
Specifies the key management server cluster for which you want to use the certificate as a client certificate.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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
-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 self-signed client certificate or the certificate-signing request to be signed by the key management server
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... icate.html
New-KmipClientCertificate
SYNOPSIS
This cmdlet retrieves the latest generated self-signed certificate or certificate-signing request for the key
management server cluster.
SYNTAX
Get-KmipClientCertificate [-KmsCluster] <KmsCluster> [-CertificateSigningRequest] [-FilePath <String>] [-Server
<VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
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
-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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-FilePath <String>
Specifies the file path to which you want to export the self-signed certificate or certificate-signing request.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KmsCluster <KmsCluster>
Specifies the key management server cluster for which you want to use the certificate as a client certificate.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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
-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 self-signed client certificate or the certificate-signing request to be signed by the key management server
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... icate.html
New-KmipClientCertificate