Name | Type | Description | Required? | Pipeline Input | Default Value |
---|
KeyProvider | KmsCluster | Specifies the key provider you want to modify. | true | True (ByValue) |
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 |
DefaultForSystem | SwitchParameter | Specifies the key provider you want to use as the vCenter Server system default key provider. | false | False |
KmsProvidedClientCertificate | String | Specifies the certificate provided by the key management server and its private key. Either this parameter or the KmsProvidedClientCertificateFilePath parameter should be specified. | false | False |
KmsProvidedClientCertificateFilePath | String | Specifies the file path to the certificate file provided by the key management server. Either this parameter or the KmsProvidedClientCertificate parameter should be specified. | false | False |
KmsProvidedPrivateKey | SecureString | 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. | false | False |
KmsProvidedPrivateKeyFilePath | String | Specifies the private key file path provided by the key management server. Either this parameter or the KmsProvidedPrivateKey parameter should be specified. | false | False |
KmsSignedClientCertificate | String | 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. | false | False |
KmsSignedClientCertificateFilePath | String | Specifies the file path to the certificate file signed by the key management server. Either this parameter or the KmsSignedClientCertificate parameter should be specified. | false | False |
SelfSignedClientCertificate | String | 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. | false | False |
SelfSignedClientCertificateFilePath | String | Specifies the file path to the self-signed certificate. Either this parameter or the SelfSignedClientCertificate parameter should be specified. | 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 |
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 |
-------------------------- 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.