Set-KeyProvider Command | Vmware PowerCLI Reference

Set-KeyProvider

This cmdlet modifies the settings of the specified key provider.

Syntax

Set-KeyProvider
-KeyProvider < KeyProvider >
[-DefaultForSystem ]
[-ProgressAction < ActionPreference > ]
[-SelfSignedClientCertificate < String > ]
[-SelfSignedClientCertificateFilePath < String > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 KeyProvider KeyProvider named
  • pipeline
  • wildcards
 Specifies the key provider you want to modify.
optional DefaultForSystem SwitchParameter named
Specifies the key provider you want to use as the vCenter Server system default key provider.
optional ProgressAction ActionPreference named
optional SelfSignedClientCertificate String named
Specifies the self-signed certificate for the key provider. The server uses the certificate for authentication with the key management server in the key provider. Either this parameter or the SelfSignedClientCertificateFilePath parameter should be specified.
optional SelfSignedClientCertificateFilePath String named
Specifies the file path to the self-signed certificate. Either this parameter or the SelfSignedClientCertificate parameter should be specified.
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
Set-KeyProvider
-KeyProvider < KeyProvider >
[-DefaultForSystem ]
[-KmsProvidedClientCertificate < String > ]
[-KmsProvidedClientCertificateFilePath < String > ]
[-KmsProvidedPrivateKey < SecureString > ]
[-KmsProvidedPrivateKeyFilePath < String > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 KeyProvider KeyProvider named
  • pipeline
  • wildcards
 Specifies the key provider you want to modify.
optional DefaultForSystem SwitchParameter named
Specifies the key provider you want to use as the vCenter Server system default key provider.
optional KmsProvidedClientCertificate String named
Specifies the certificate provided by the key management server and its private key. Either this parameter or the KmsProvidedClientCertificateFilePath parameter should be specified.
optional KmsProvidedClientCertificateFilePath String named
Specifies the file path to the certificate file provided by the key management server. Either this parameter or the KmsProvidedClientCertificate parameter should be specified.
optional KmsProvidedPrivateKey SecureString named
Specifies the private key for the key provider, if it is provided by the key management server. Either this parameter or the KmsProvidedPrivateKeyFilePath parameter should be specified.
optional KmsProvidedPrivateKeyFilePath String named
Specifies the private key file path provided by the key management server. Either this parameter or the KmsProvidedPrivateKey parameter should be specified.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
Set-KeyProvider
-KeyProvider < KeyProvider >
[-DefaultForSystem ]
[-KmsSignedClientCertificate < String > ]
[-KmsSignedClientCertificateFilePath < String > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 KeyProvider KeyProvider named
  • pipeline
  • wildcards
 Specifies the key provider you want to modify.
optional DefaultForSystem SwitchParameter named
Specifies the key provider you want to use as the vCenter Server system default key provider.
optional KmsSignedClientCertificate String named
Uploads the key management server-signed client certificate for the key provider. The server uses the certificate for authentication with the key management server in the key provider. Either this parameter or the KmsSignedClientCertificateFilePath parameter should be specified.
optional KmsSignedClientCertificateFilePath String named
Specifies the file path to the certificate file signed by the key management server. Either this parameter or the KmsSignedClientCertificate parameter should be specified.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
Set-KeyProvider
-KeyId < Guid >
-KeyProvider < KeyProvider >
[-DefaultForSystem ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 KeyId Guid named
Specifies the key ID of the key provider you want to set. You can use this parameter only with key providers of the NativeKeyProvider type.
required
 KeyProvider KeyProvider named
  • pipeline
  • wildcards
 Specifies the key provider you want to modify.
optional DefaultForSystem SwitchParameter named
Specifies the key provider you want to use as the vCenter Server system default key provider.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.

Output

VMware.VimAutomation.ViCore.Types.V1.Security.KeyProvider

Examples

Example 1 

Set-KeyProvider -KeyProvider $keyProvider -SelfSignedClientCertificate $certificate -DefaultForSystem

Updates the client certificate with the $certificate self-signed certificate and marks the $keyProvider key provider as the system default key provider.

Example 2 

Set-KeyProvider -KeyProvider $keyProvider -KmsProvidedClientCertificate $certificate -KmsProvidedPrivateKey $privateKey

Updates the client certificate and its private key with $certificate and $privateKey for the $keyProvider key provider.

Related Commands

KeyManagementServer

This cmdlet adds a key management server to a vCenter Server system.

This cmdlet retrieves the key management servers registered on the vCenter Server system.

This cmdlet removes the specified key management servers from the vCenter Server systems.

This cmdlet configures the settings of the key management server.

KeyProvider

This cmdlet exports a specified key provider configuration to a specified file. You can use only the NativeKeyProvider type for the KeyProvider parameter.

This cmdlet imports a key provider from a specified configuration file.

This cmdlet registers a trusted key provider in the workload vCenter Server system which you can use for encryption operations.

This cmdlet unregisters the specified key provider from the workload vCenter Server system. For a trusted key provider, you cannot use it in encryption operations. For a standard key provider, you can remove it from the workload vCenter Server system.

This cmdlet retrieves all key providers from the vCenter Server system.

This cmdlet modifies the settings of the specified key provider.

KeyProviderServiceInfo

This cmdlet adds key provider service information, which comes from the Trust Authority key provider service running in the Trust Authority system or its detailed information in the workload vCenter Server system.

This cmdlet retrieves the key provider services information configured in the workload vCenter Server system.

This cmdlet removes the specified key provider services information from the workload vCenter Server system.