New-TrustAuthorityPrincipal
This cmdlet creates a new Trust Authority principal in the specified Trust Authority cluster in the Trust Authority vCenter Server system.
Syntax
[-TrustedPrincipal]
<TrustedPrincipal>
-TrustAuthorityCluster <TrustAuthorityCluster>
[-Server <VIServer[]>]
[CommonParameters]
-TrustAuthorityCluster <TrustAuthorityCluster>
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
TrustedPrincipal | 1 |
|
Specifies the trusted principal in the workload vCenter Server system to create a Trust Authority principal. | required |
|
TrustAuthorityCluster | named |
|
Specifies the Trust Authority cluster in which you want to create the Trust Authority principal. | optional |
|
VIServer[] | named |
|
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. |
[-Name]
<String>
-CertificateChain <X509Chain[]>
-Domain <String>
-Issuer <String>
-TrustAuthorityCluster <TrustAuthorityCluster>
[-Server <VIServer[]>]
[-Type <PrincipalType>]
[CommonParameters]
-CertificateChain <X509Chain[]>
-Domain <String>
-Issuer <String>
-TrustAuthorityCluster <TrustAuthorityCluster>
[-Server <VIServer[]>]
[-Type <PrincipalType>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String | 1 |
|
Specifies the name of the trusted principal in the workload vCenter Server system to create a Trust Authority principal. | required |
|
X509Chain[] | named |
|
Specifies the certificate chain of the trusted principal in the workload vCenter Server system to create a Trust Authority principal. | required |
|
String | named |
|
Specifies the domain of the trusted principal in the workload vCenter Server system to create a Trust Authority principal. | required |
|
String | named |
|
Specifies the issuer of the trusted principal in the workload vCenter Server system to create a Trust Authority principal. | required |
|
TrustAuthorityCluster | named |
|
Specifies the Trust Authority cluster in which you want to create the Trust Authority principal. | optional |
|
VIServer[] | named |
|
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. | optional |
|
PrincipalType | named |
|
Specifies the type of the trusted principal in the workload vCenter Server system to create a Trust Authority principal. |
-FilePath
<String>
-TrustAuthorityCluster <TrustAuthorityCluster>
[-Server <VIServer[]>]
[CommonParameters]
-TrustAuthorityCluster <TrustAuthorityCluster>
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String | named |
|
Specifies the file including the trusted principal in the workload vCenter Server system to create the Trust Authority principal. | required |
|
TrustAuthorityCluster | named |
|
Specifies the Trust Authority cluster in which you want to create the Trust Authority principal. | optional |
|
VIServer[] | named |
|
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.Security.Types.V1.TrustedInfrastructure.TrustAuthorityPrincipal
Examples
Example 1
$trustedPrincipal = Get-TrustedPrincipal -Server workloadSystem
New-TrustAuthorityPrincipal -TrustAuthorityCluster mycluster -TrustedPrincipal $trustedPrincipal -Server trustAuthoritySystem
Creates the Trust Authority principal in the Trust Authority cluster mycluster from the trusted principal object $trustedPrincipal. You can retrieve the trusted principal object from the connected workload vCenter Server system workloadSystem.
Example 2
Export-TrustedPrincipal -Server workloadSystem -FilePath c:\mypath
New-TrustAuthorityPrincipal -TrustAuthorityCluster mycluster -FilePath c:\mypath -Server trustAuthoritySystem
Exports the trusted principal object from the connected workload vCenter Server system workloadSystem to the c:\mypath file. Creates the Trust Authority principal in the Trust Authority cluster mycluster from the c:\mypath file.
Example 3
$trustedPrincipal = Get-TrustedPrincipal -Server workloadSystem
New-TrustAuthorityPrincipal -TrustAuthorityCluster mycluster -Name $trustedPrincipal.Name
-Domain $trustedPrincipal.Domain -Issuer $trustedPrincipal.Issuer -CertificateChain $trustedPrincipal.CertificateChain -Type $trustedPrincipal.Type -Server trustAuthoritySystem
Creates a Trust Authority principal in the Trust Authority cluster mycluster from each property of the trusted principal object. You can retrieve the Trusted principal object from the connected workload vCenter Server system workloadSystem.
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 modifies the Trust Authority key providers with the specified properties 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 creates a new Trust Authority key provider in the Trust Authority vCenter Server system.
TrustAuthorityKeyProviderClientCertificate
This cmdlet retrieves the client certificate from the specified Trust Authority key provider in the connected Trust Authority vCenter Server system.
This cmdlet exports the client certificate from the specified Trust Authority key provider to the specified file.
This cmdlet updates the client certificate of the specified Trust Authority key providers in the 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.
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 retrieves the Trust Authority key provider servers from the specified Trust Authority key providers in the connected Trust Authority vCenter Server system.
This cmdlet adds a new Trust Authority key provider server to an existing Trust Authority key provider in the Trust Authority system.
This cmdlet removes the specified Trust Authority key provider servers from their location in the Trust Authority vCenter Server system.
TrustAuthorityKeyProviderServerCertificate
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 adds the certificate from the Trust Authority key provider server to be trusted by the Trust Authority key provider.
This cmdlet updates the trusted server certificates of the specified Trust Authority key providers 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.
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 removes the Trust Authority principals from their location 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.
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 removes the Trust Authority TPM 2.0 certificate authority (CA) certificates from the Trust Authority cluster 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.
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 removes the Trust Authority TPM 2.0 endorsement keys from the Trust Authority cluster 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.
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 removes the Trust Authority virtual machine host base images from the Trust Authority cluster 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.
