New-TrustAuthorityKeyProvider Command | Vmware PowerCLI Reference

New-TrustAuthorityKeyProvider

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

Syntax

New-TrustAuthorityKeyProvider
[ -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. 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.
New-TrustAuthorityKeyProvider
[ -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

TrustAuthorityAttestationService

This cmdlet retrieves the Trust Authority attestation services from the specified enabled Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityCluster

This cmdlet retrieves the Trust Authority clusters from the Trust Authority vCenter Server system.

This cmdlet modifies the configuration of the specified Trust Authority clusters in the Trust Authority vCenter Server system.

TrustAuthorityKeyProvider

This cmdlet retrieves the Trust Authority key providers from the specified Trust Authority cluster in the Trust Authority vCenter Server system.

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

This cmdlet removes the specified Trust Authority key providers from the Trust Authority vCenter Server system.

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

TrustAuthorityKeyProviderClientCertificate

This cmdlet exports the client certificate from the specified Trust Authority key provider to the specified file.

This cmdlet retrieves the client certificate from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.

This cmdlet creates a client certificate for the specified Trust Authority key provider in the Trust Authority vCenter Server system.

This cmdlet updates the client certificate of the specified Trust Authority key providers in the Trust Authority vCenter Server system.

TrustAuthorityKeyProviderClientCertificateCSR

This cmdlet retrieves the client certificate Certificate Signing Request (CSR) from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.

This cmdlet creates the client certificate Certificate Signing Request (CSR) for the specified Trust Authority key providers in the Trust Authority vCenter Server system.

TrustAuthorityKeyProviderServer

This cmdlet adds a new Trust Authority key provider server to an existing Trust Authority key provider in the Trust Authority system.

This cmdlet retrieves the Trust Authority key provider servers from the specified Trust Authority key providers in the connected Trust Authority vCenter Server system.

This cmdlet removes the specified Trust Authority key provider servers from their location in the Trust Authority vCenter Server system.

TrustAuthorityKeyProviderServerCertificate

This cmdlet adds the certificate from the Trust Authority key provider server to be trusted by the Trust Authority key provider.

This cmdlet retrieves the certificate from the Trust Authority key provider server or the certificate trusted by the specified Trust Authority key provider in the Trust Authority vCenter Server system.

This cmdlet removes the specified Trust Authority key provider server certificates from their location. The certificate is no longer trusted by the Trust Authority key provider in the Trust Authority vCenter Server system.

This cmdlet updates the trusted server certificates of the specified Trust Authority key providers in the Trust Authority vCenter Server system.

TrustAuthorityKeyProviderService

This cmdlet retrieves the Trust Authority key provider services from the specified enabled Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityPrincipal

This cmdlet retrieves the Trust Authority principals from the specified Trust Authority clusters in the Trust Authority vCenter Server system.

This cmdlet creates a new Trust Authority principal in the specified Trust Authority cluster in the Trust Authority vCenter Server system.

This cmdlet removes the Trust Authority principals from their location in the Trust Authority vCenter Server system.

TrustAuthorityServicesInfo

This cmdlet exports the Trust Authority services information (the Trust Authority attestation service and Trust Authority key provider service) from the specified Trust Authority cluster to the specified file.

This cmdlet imports the Trust Authority services information (Trust Authority attestation service and Trust Authority key provider service) from the specified file to the workload vCenter Server system.

TrustAuthorityServicesStatus

This cmdlet retrieves the Trust Authority services status from the specified Trust Authority clusters in the connected Trust Authority vCenter Server system.

TrustAuthorityTpm2AttestationSettings

This cmdlet retrieves the Trust Authority TPM 2.0 attestation settings from the specified Trust Authority clusters in the connected Trust Auhtority vCenter Server system.

This cmdlet modifies the Trust Authority TPM 2.0 attestation settings of the Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityTpm2CACertificate

This cmdlet retrieves the Trust Authority TPM 2.0 Certificate Authority (CA) certificates from the specified Trust Authority clusters in the Trust Authority vCenter Server system.

This cmdlet creates a new Trust Authority TPM 2.0 Certificate Authority (CA) certificate in the specified Trust Authority Cluster in the Trust Authority vCenter Server system.

This cmdlet removes the Trust Authority TPM 2.0 certificate authority (CA) certificates from the Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityTpm2EndorsementKey

This cmdlet retrieves the Trust Authority TPM 2.0 endorsement keys from the specified Trust Authority clusters in the Trust Authority vCenter Server system.

This cmdlet creates a new Trust Authority TPM 2.0 endorsement key in the specified Trust Authority cluster in the Trust Authority vCenter Server system.

This cmdlet removes the Trust Authority TPM 2.0 endorsement keys from the Trust Authority cluster in the Trust Authority vCenter Server system.

TrustAuthorityVMHostBaseImage

This cmdlet retrieves the Trust Authority virtual machine host base image from the specified Trust Authority clusters in the Trust Authority vCenter Server system.

This cmdlet creates a Trust Authority virtual machine host base image in the Trust Authority vCenter Server system.

This cmdlet removes the Trust Authority virtual machine host base images from the Trust Authority cluster in the Trust Authority vCenter Server system.