Set-TrustAuthorityKeyProvider

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

Syntax

-KeyProvider  <TrustAuthorityKeyProvider>
[-ConnectionTimeoutSeconds  <Int64>]
[-Description  <String>]
[-KmipServerUsername  <String>]
[-MasterKeyId  <String>]
[-PrimaryKeyId  <String>]
[-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.
    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
    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.

    -KeyProvider  <TrustAuthorityKeyProvider>
    -KmipServerPassword  <SecureString>
    [-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
    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

    Feedback

    Was this page helpful?