Set-KeyProvider

This cmdlet modifies the settings of the specified key provider.

Syntax

-KeyProvider  <KmsCluster>
[-DefaultForSystem]
[-SelfSignedClientCertificate  <String>]
[-SelfSignedClientCertificateFilePath  <String>]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
KeyProvider
KmsCluster named
  • wildcards
  • pipeline
  • 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
    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.

    -KeyProvider  <KmsCluster>
    [-DefaultForSystem]
    [-KmsProvidedClientCertificate  <String>]
    [-KmsProvidedClientCertificateFilePath  <String>]
    [-KmsProvidedPrivateKey  <SecureString>]
    [-KmsProvidedPrivateKeyFilePath  <String>]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    KeyProvider
    KmsCluster named
  • wildcards
  • pipeline
  • 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
    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.

    -KeyProvider  <KmsCluster>
    [-DefaultForSystem]
    [-KmsSignedClientCertificate  <String>]
    [-KmsSignedClientCertificateFilePath  <String>]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    KeyProvider
    KmsCluster named
  • wildcards
  • pipeline
  • 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
    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

    Feedback

    Was this page helpful?