PowerCLI Reference

Set-TrustAuthorityKeyProviderClientCertificate

Synopsis

This cmdlet updates the client certificate of the specified Trust Authority key providers in the Trust Authority vCenter Server system.

Syntax

Set-TrustAuthorityKeyProviderClientCertificate [-KeyProvider] <TrustAuthorityKeyProvider[]> [-Certificate] <X509Certificate2> [-Confirm] [-PrivateKey <SecureString>] [-PrivateKeyFilePath <String>] [-Server <VIServer[]>] [-TrustAuthorityCluster <TrustAuthorityCluster>] [-WhatIf] [<CommonParameters>]

Set-TrustAuthorityKeyProviderClientCertificate [-KeyProvider] <TrustAuthorityKeyProvider[]> [-CertificateFilePath] <String> [-Confirm] [-PrivateKey <SecureString>] [-PrivateKeyFilePath <String>] [-Server <VIServer[]>] [-TrustAuthorityCluster <TrustAuthorityCluster>] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-TrustAuthorityKeyProviderClientCertificate
New-TrustAuthorityKeyProviderClientCertificate

Detailed Description

This cmdlet updates the client certificate of the specified Trust Authority key providers in the Trust Authority vCenter Server system.

Parameters

Name	Type	Description	Required?	Pipeline Input
KeyProvider	TrustAuthorityKeyProvider[]	Specifies the Trust Authority key providers that you want to modify.	true	True (ByValue)
Certificate	X509Certificate2	Specifies the certificate that you want to update to the Trust Authority key provider.	true	False
CertificateFilePath	String	Specifies the file with the certificate that you want to update to the Trust Authority key provider.	true	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
PrivateKey	SecureString	Specifies the private key part of the certificate that you want to update to the Trust Authority key provider.	false	False
PrivateKeyFilePath	String	Specifies the file with the private key part of the certificate that you want to update to the Trust Authority key provider.	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 the Connect-VIServer cmdlet.	false	False
TrustAuthorityCluster	TrustAuthorityCluster	Specifies the Trust Authority cluster where the Trust Authority key provider resides.	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

System.Security.Cryptography.X509Certificates.X509Certificate2

Notes

Examples

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

Set-TrustAuthorityKeyProviderClientCertificate -KeyProvider mykp -Certificate $mycert -Privatekey $mycertKey

Updates the client certificate of the Trust Authority key provider mykp with the given certificate $mycert and its private key $mycertKey.