PowerCLI Reference

Set-TrustAuthorityKeyProvider

Synopsis

This cmdlet modifies the Trust Authority key providers with the specified properties in the Trust Authority vCenter Server system.

Syntax

Set-TrustAuthorityKeyProvider [-KeyProvider] <TrustAuthorityKeyProvider> [-Confirm] [-ConnectionTimeoutSeconds <Int64>] [-Description <String>] [-KmipServerUsername <String>] [-MasterKeyId <String>] [-ProxyAddress <String>] [-ProxyPort <Int32>] [-Server <VIServer[]>] [-TrustAuthorityCluster <TrustAuthorityCluster>] [-Type {KMIP}] [-WhatIf] [<CommonParameters>]

Set-TrustAuthorityKeyProvider [-KeyProvider] <TrustAuthorityKeyProvider> [-Confirm] -KmipServerPassword <SecureString> [-Server <VIServer[]>] [-TrustAuthorityCluster <TrustAuthorityCluster>] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-TrustAuthorityKeyProvider
New-TrustAuthorityKeyPrivider
Remove-TrustAuthorityKeyProvider

Detailed Description

This cmdlet modifies the Trust Authority key providers with the specified properties in the Trust Authority vCenter Server system.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
KeyProviderTrustAuthorityKeyProviderSpecifies the Trust Authority key provider that you want to modify.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
ConnectionTimeoutSecondsInt64Specifies the timeout in seconds of the connection between the Trust Authority key provider and Trust Authority key provider server.falseFalse
DescriptionStringSpecifies the description you want to set to the Trust Authority key provider.falseFalse
KmipServerPasswordSecureStringSpecifies the new password that you can use to connect to the KMIP servers from the Trust Authority key provider.trueFalse
KmipServerUsernameStringSpecifies the new user name that you can use to connect to the KMIP servers from the Trust Authority key provider.falseFalse
MasterKeyIdStringSpecifies the new master key ID of the Trust Authority key provider which you can generate from the KMIP servers.falseFalse
ProxyAddressStringSpecifies the new proxy address of the Trust Authority key provider that you can use to connect to the KMIP servers.falseFalse
ProxyPortInt32Specifies the new porxy port number of the Trust Authority key provider that you can use to connect to the KMIP servers. This parameter works with the ProxyAddress parameter.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 the Connect-VIServer cmdlet.falseFalse
TrustAuthorityClusterTrustAuthorityClusterSpecifies the Trust Authority cluster where the Trust Authority key provider resides.falseFalse
TypeKmsTypeSpecifies the new type of the Trust Authority key provider servers.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

VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityKeyProvider

Notes

Examples

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

Set-TrustAuthorityKeyProvider -KeyProvider mykp -KmipServerUsername root

Sets the user name of the Key Management Interoperability Protocol (KMIP) servers in the Trust Authority key provider mykp.

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

Set-TrustAuthorityKeyProvider -KeyProvider mykp -KmipServerPassword mypassword

Sets the password of the KMIP servers in the Trust Authority key provider mykp.


Copyright © VMware, Inc. All rights reserved.