New-TrustAuthorityKeyProvider

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

Syntax

[-Name]  <String>
-KmipServerAddress  <String>
-MasterKeyId  <String>
-TrustAuthorityCluster  <TrustAuthorityCluster>
[-ConnectionTimeOutSeconds  <Int64>]
[-Description  <String>]
[-KmipServerName  <String>]
[-KmipServerPassword  <SecureString>]
[-KmipServerPort  <Int32>]
[-KmipServerUsername  <String>]
[-ProxyAddress  <String>]
[-ProxyPort  <Int32>]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Name
String 1 Specifies the name of the Trust Authority key provider.
required
KmipServerAddress
String named Specifies the first KMIP server address in the Trust Authority key provider.
required
MasterKeyId
String named This parameter is deprecated and scheduled for removal. Use the PrimaryKeyId parameter instead.
required
TrustAuthorityCluster
TrustAuthorityCluster named
  • pipeline
  • Specifies the Trust Authority cluster in which you want to create the Trust Authority key provider.
    optional
    ConnectionTimeOutSeconds
    Int64 named Specifies the timeout in seconds for the connection between the Trust Authority key provider and the KMIP servers.
    optional
    Description
    String named Specifies the description of the Trust Authority key provider.
    optional
    KmipServerName
    String named Specifies the name of the first KMIP server in the Trust Authority key provider.
    optional
    KmipServerPassword
    SecureString named Specifies the password of the first KMIP server in the Trust Authority key provider.
    optional
    KmipServerPort
    Int32 named Specifies the port number of the first KMIP server in the Trust Authority key provider.
    optional
    KmipServerUsername
    String named Specifies the user name of the first KMIP server in the Trust Authority key provider.
    optional
    ProxyAddress
    String named Specifies the proxy address of the Trust Authority key provider that you want to use to connect to the KMIP servers.
    optional
    ProxyPort
    Int32 named Specifies the proxy port number of the Trust Authority key provider that you use to connect to the KMIP servers. It 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.

    [-Name]  <String>
    -KmipServerAddress  <String>
    -PrimaryKeyId  <String>
    -TrustAuthorityCluster  <TrustAuthorityCluster>
    [-ConnectionTimeOutSeconds  <Int64>]
    [-Description  <String>]
    [-KmipServerName  <String>]
    [-KmipServerPassword  <SecureString>]
    [-KmipServerPort  <Int32>]
    [-KmipServerUsername  <String>]
    [-ProxyAddress  <String>]
    [-ProxyPort  <Int32>]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Name
    String 1 Specifies the name of the Trust Authority key provider.
    required
    KmipServerAddress
    String named Specifies the first KMIP server address in the Trust Authority key provider.
    required
    PrimaryKeyId
    String named Specifies the primary key ID of the Trust Authority key provider that you want to use from the KMIP servers.
    required
    TrustAuthorityCluster
    TrustAuthorityCluster named
  • pipeline
  • Specifies the Trust Authority cluster in which you want to create the Trust Authority key provider.
    optional
    ConnectionTimeOutSeconds
    Int64 named Specifies the timeout in seconds for the connection between the Trust Authority key provider and the KMIP servers.
    optional
    Description
    String named Specifies the description of the Trust Authority key provider.
    optional
    KmipServerName
    String named Specifies the name of the first KMIP server in the Trust Authority key provider.
    optional
    KmipServerPassword
    SecureString named Specifies the password of the first KMIP server in the Trust Authority key provider.
    optional
    KmipServerPort
    Int32 named Specifies the port number of the first KMIP server in the Trust Authority key provider.
    optional
    KmipServerUsername
    String named Specifies the user name of the first KMIP server in the Trust Authority key provider.
    optional
    ProxyAddress
    String named Specifies the proxy address of the Trust Authority key provider that you want to use to connect to the KMIP servers.
    optional
    ProxyPort
    Int32 named Specifies the proxy port number of the Trust Authority key provider that you use to connect to the KMIP servers. It 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.

    Output

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

    Examples


    Example 1

    New-TrustAuthorityKeyProvider -TrustAuthorityCluster mycluster -Name mykp -PrimaryKeyId 1 -KmipServerAddress 1.1.1.1

    Creates a new Trust Authority key provider in the Trust Authority cluster mycluster with the mykp and primarykeyId 1 names for all the Key Management Interoperability Protocol (KMIP) servers in this key provider. Adds KMIP server with the 1.1.1.1 address to the key provider.

    Related Commands

    Feedback

    Was this page helpful?