PowerCLI Reference

New-TrustAuthorityPrincipal

Synopsis

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

Syntax

New-TrustAuthorityPrincipal [-TrustAuthorityCluster] <TrustAuthorityCluster> [-Name] <String> -CertificateChain <X509Chain[]> [-Confirm] -Domain <String> -Issuer <String> [-Server <VIServer[]>] [-Type {STS_USER | STS_GROUP}] [-WhatIf] [<CommonParameters>]

New-TrustAuthorityPrincipal [-TrustAuthorityCluster] <TrustAuthorityCluster> [-Confirm] -FilePath <String> [-Server <VIServer[]>] [-WhatIf] [<CommonParameters>]

New-TrustAuthorityPrincipal [-TrustAuthorityCluster] <TrustAuthorityCluster> [-TrustedPrincipal] <TrustedPrincipal> [-Confirm] [-Server <VIServer[]>] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-TrustedPrincipal
Export-TrustedPrincipal
Get-TrustAuthorityPrincipal
Remove-TrustAuthorityPrincipal

Detailed Description

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

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
TrustAuthorityClusterTrustAuthorityClusterSpecifies the Trust Authority cluster in which you want to create the Trust Authority principal.trueTrue (ByValue)
NameStringSpecifies the name of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.trueFalse
TrustedPrincipalTrustedPrincipalSpecifies the trusted principal in the workload vCenter Server system to create a Trust Authority principal.trueTrue (ByValue)
CertificateChainX509Chain[]Specifies the certificate chain of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.trueFalse
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
DomainStringSpecifies the domain of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.trueFalse
FilePathStringSpecifies the file including the trusted principal in the workload vCenter Server system to create the Trust Authority principal.trueFalse
IssuerStringSpecifies the issuer of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.trueFalse
ServerVIServer[]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.falseFalse
TypePrincipalTypeSpecifies the type of the trusted principal in the workload vCenter Server system to create a Trust Authority principal.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.TrustAuthorityPrincipal

Notes

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.


Copyright © VMware, Inc. All rights reserved.