Citrix Virtual Apps and Desktops SDK

New-TrustVdaEnrollmentToken

Introduced in: Citrix Virtual Apps and Desktop 7 2308

This cmdlet creates a new VDA enrollment token from the provided metadata.

Syntax

New-TrustVdaEnrollmentToken
   -CatalogId <Guid>
   [-ExpirationDate <DateTime>]
   [-HostConnectionId <Guid>]
   [-IssuedToUser <String>]
   [-NotValidBeforeDate <DateTime>]
   -NumMachinesAllowed <Int32>
   [-TokenName] <String>
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

VDA enrollment tokens are JWT tokens issued for limited use to add VDA machines to a machine catalog.

Examples

EXAMPLE 1

Creates a VDA enrollment token that allows the bearer to add up to 3 machines to machine catalog ID 30e1a941-cc17-4cc9-a4d7-2a49c7350430 that will expire on 4/1/2023.

New-TrustVdaEnrollmentToken -TokenName MyNewVdaToken -ExpirationDate 4/1/2023 -NotValidBeforeDate 3/20/2023 -NumMachinesAllowed 3 - CatalogId 30e1a941-cc17-4cc9-a4d7-2a49c7350430
<!--NeedCopy-->

EXAMPLE 2

Creates a VDA registration token that allows the bearer to add up to 3 machines to machine catalog ID 30e1a941-cc17-4cc9-a4d7-2a49c7350430. Since no expiration date or not valid before date were provided this token will expire 14 days after the date it was created.

New-TrustVdaEnrollmentToken -TokenName MyNewVdaToken -NumMachinesAllowed 3 - CatalogId 30e1a941-cc17-4cc9-a4d7-2a49c7350430
<!--NeedCopy-->

EXAMPLE 3

Creates a VDA registration token that allows the bearer to add up to 3 machines to machine catalog ID 30e1a941-cc17-4cc9-a4d7-2a49c7350430 that is not valid before 7/4/2023 and will expire on 7/18/2023.

New-TrustVdaEnrollmentToken -TokenName MyNewVdaToken -NumMachinesAllowed 3 - CatalogId 30e1a941-cc17-4cc9-a4d7-2a49c7350430 -NotValidBeforeDate 7/4/2023
<!--NeedCopy-->

Parameters

-CatalogId

The machine catalog Id that this VDA enrollment token allows machines to be added to.

Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NumMachinesAllowed

The number of machines this VDA enrollment token allows to be added to the machine catalog.

Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TokenName

The name used to more easily identify this VDA enrollment token.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-ExpirationDate

Optional - The UTC date this VDA enrollment token expires. This will default to creation date or NotValidBeforeDate plus the threshold of 14 days.

Type: DateTime
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-HostConnectionId

The HostConnectionId that orchestration service can use to determine how to handle power management.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2311

-IssuedToUser

Optional - The user to which this new VDA enrollment token has been issued.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-NotValidBeforeDate

Optional - The UTC date before which this VDA enrollment token will not be valid. This will default to the creation date.

Type: DateTime
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.Trust.Sdk.VdaEnrollmentToken

This token result object contains the VDA enrollment token and some additional metadata.

New-TrustVdaEnrollmentToken