Set-TrustAuthorityKeyProvider Command | Vmware PowerCLI Reference

Set-TrustAuthorityKeyProvider

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

Syntax

Set-TrustAuthorityKeyProvider
-KeyProvider < TrustAuthorityKeyProvider >
[-ConnectionTimeoutSeconds < Int64 > ]
[-Description < String > ]
[-KmipServerUsername < String > ]
[-MasterKeyId < String > ]
[-PrimaryKeyId < String > ]
[-ProgressAction < ActionPreference > ]
[-ProxyAddress < String > ]
[-ProxyPort < Int32 > ]
[-Server < VIServer[] > ]
[-TrustAuthorityCluster < TrustAuthorityCluster > ]
[-Type < KmsType > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 KeyProvider TrustAuthorityKeyProvider named
  • pipeline
 Specifies the Trust Authority key provider that you want to modify.
optional ConnectionTimeoutSeconds Int64 named
Specifies the timeout in seconds of the connection between the Trust Authority key provider and the Trust Authority key provider server.
optional Description String named
Specifies the description you want to set to the Trust Authority key provider.
optional KmipServerUsername String named
Specifies the new user name that you can use to connect to the KMIP servers from the Trust Authority key provider.
optional MasterKeyId String named
This parameter is deprecated and scheduled for removal. Use the PrimaryKeyId parameter instead. Specifies the new primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.
optional PrimaryKeyId String named
Specifies the new primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.
optional ProgressAction ActionPreference named
optional ProxyAddress String named
Specifies the new proxy address of the Trust Authority key provider that you can use to connect to the KMIP servers.
optional ProxyPort Int32 named
Specifies 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.
optional Server VIServer[] named
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.
optional TrustAuthorityCluster TrustAuthorityCluster named
Specifies the Trust Authority cluster where the Trust Authority key provider resides.
optional Type KmsType named
Specifies the new type of the Trust Authority key provider servers.
Set-TrustAuthorityKeyProvider
-KeyProvider < TrustAuthorityKeyProvider >
-KmipServerPassword < SecureString >
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[-TrustAuthorityCluster < TrustAuthorityCluster > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 KeyProvider TrustAuthorityKeyProvider named
  • pipeline
 Specifies the Trust Authority key provider that you want to modify.
required
 KmipServerPassword SecureString named
Specifies the new password that you can use to connect to the KMIP servers from the Trust Authority key provider.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
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.
optional TrustAuthorityCluster TrustAuthorityCluster named
Specifies the Trust Authority cluster where the Trust Authority key provider resides.

Output

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

Examples

Example 1 

Set-TrustAuthorityKeyProvider -KeyProvider mykp -KmipServerUsername root

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

Example 2 

Set-TrustAuthorityKeyProvider -KeyProvider mykp -KmipServerPassword mypassword

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

Related Commands

TrustAuthorityAttestationService

This cmdlet retrieves the Trust Authority attestation services from the specified enabled Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityCluster

This cmdlet retrieves the Trust Authority clusters from the Trust Authority vCenter Server system.

This cmdlet modifies the configuration of the specified Trust Authority clusters in the Trust Authority vCenter Server system.

TrustAuthorityKeyProvider

This cmdlet retrieves the Trust Authority key providers from the specified Trust Authority cluster in the Trust Authority vCenter Server system.

This cmdlet creates a new Trust Authority key provider in the Trust Authority vCenter Server system.

This cmdlet removes the specified Trust Authority key providers from the Trust Authority vCenter Server system.

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

TrustAuthorityKeyProviderClientCertificate

This cmdlet exports the client certificate from the specified Trust Authority key provider to the specified file.

This cmdlet retrieves the client certificate from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.

This cmdlet creates a client certificate for the specified Trust Authority key provider in the Trust Authority vCenter Server system.

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

TrustAuthorityKeyProviderClientCertificateCSR

This cmdlet retrieves the client certificate Certificate Signing Request (CSR) from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.

This cmdlet creates the client certificate Certificate Signing Request (CSR) for the specified Trust Authority key providers in the Trust Authority vCenter Server system.

TrustAuthorityKeyProviderServer

This cmdlet adds a new Trust Authority key provider server to an existing Trust Authority key provider in the Trust Authority system.

This cmdlet retrieves the Trust Authority key provider servers from the specified Trust Authority key providers in the connected Trust Authority vCenter Server system.

This cmdlet removes the specified Trust Authority key provider servers from their location in the Trust Authority vCenter Server system.

TrustAuthorityKeyProviderServerCertificate

This cmdlet adds the certificate from the Trust Authority key provider server to be trusted by the Trust Authority key provider.

This cmdlet retrieves the certificate from the Trust Authority key provider server or the certificate trusted by the specified Trust Authority key provider in the Trust Authority vCenter Server system.

This cmdlet removes the specified Trust Authority key provider server certificates from their location. The certificate is no longer trusted by the Trust Authority key provider in the Trust Authority vCenter Server system.

This cmdlet updates the trusted server certificates of the specified Trust Authority key providers in the Trust Authority vCenter Server system.

TrustAuthorityKeyProviderService

This cmdlet retrieves the Trust Authority key provider services from the specified enabled Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityPrincipal

This cmdlet retrieves the Trust Authority principals from the specified Trust Authority clusters in the Trust Authority vCenter Server system.

This cmdlet creates a new Trust Authority principal in the specified Trust Authority cluster in the Trust Authority vCenter Server system.

This cmdlet removes the Trust Authority principals from their location in the Trust Authority vCenter Server system.

TrustAuthorityServicesInfo

This cmdlet exports the Trust Authority services information (the Trust Authority attestation service and Trust Authority key provider service) from the specified Trust Authority cluster to the specified file.

This cmdlet imports the Trust Authority services information (Trust Authority attestation service and Trust Authority key provider service) from the specified file to the workload vCenter Server system.

TrustAuthorityServicesStatus

This cmdlet retrieves the Trust Authority services status from the specified Trust Authority clusters in the connected Trust Authority vCenter Server system.

TrustAuthorityTpm2AttestationSettings

This cmdlet retrieves the Trust Authority TPM 2.0 attestation settings from the specified Trust Authority clusters in the connected Trust Auhtority vCenter Server system.

This cmdlet modifies the Trust Authority TPM 2.0 attestation settings of the Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityTpm2CACertificate

This cmdlet retrieves the Trust Authority TPM 2.0 Certificate Authority (CA) certificates from the specified Trust Authority clusters in the Trust Authority vCenter Server system.

This cmdlet creates a new Trust Authority TPM 2.0 Certificate Authority (CA) certificate in the specified Trust Authority Cluster in the Trust Authority vCenter Server system.

This cmdlet removes the Trust Authority TPM 2.0 certificate authority (CA) certificates from the Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityTpm2EndorsementKey

This cmdlet retrieves the Trust Authority TPM 2.0 endorsement keys from the specified Trust Authority clusters in the Trust Authority vCenter Server system.

This cmdlet creates a new Trust Authority TPM 2.0 endorsement key in the specified Trust Authority cluster in the Trust Authority vCenter Server system.

This cmdlet removes the Trust Authority TPM 2.0 endorsement keys from the Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityVMHostBaseImage

This cmdlet retrieves the Trust Authority virtual machine host base image from the specified Trust Authority clusters in the Trust Authority vCenter Server system.

This cmdlet creates a Trust Authority virtual machine host base image in the Trust Authority vCenter Server system.

This cmdlet removes the Trust Authority virtual machine host base images from the Trust Authority cluster in the Trust Authority vCenter Server system.