Export-RdsRegistrationInfo
Exports registration information for a host pool.
Syntax
Export-RdsRegistrationInfo
[-TenantName] <String>
[-HostPoolName] <String>
[<CommonParameters>]
Description
The Export-RdsRegistrationInfo cmdlet exports the registration information for the specified host pool. The token from the registration information can then be used by new or existing session hosts to properly register to a host pool. The registration info is only valid for the specified amount of hours defined when running New-RdsRegistrationInfo.
This command will fail if the host pool does not have registration information.
Examples
Example 1: Export the registration information for a host pool
PS C:\> Export-RdsRegistration -TenantName "contoso" -HostPoolName "contosoHostPool"
Token : xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx111111111111111111111111111111111111111111111111111111111
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY222222222222222222222222222222222222222222222222222222222
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz333333333333333333333333333333333333333333333333333333333
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa444444444444444444444444444444444444444444444444444444444
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb555555555555555555555555555555555555555555555555555555555
cccccccccccccccccccccccccccccccccccccccccccc666666666666666666666666666666666666666666666666666666666
dddddddddddddddddddddddddddddddddddddddddddd777777777777777777777777777777777777777777777777777777777
eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee88888888888888888888888888
ExpirationTime : 1/3/2018 12:00:00 PM
TenantGroupName : Default Tenant Group
TenantName : contoso
HostPoolName : contosoHostPool
This command exports the registration information for the specified host pool.
Example 2: Export the registration information for a host pool and save the token to a text file.
PS C:\> Export-RdsRegistrationInfo -TenantName "contoso" -HostPoolName "contosoHostPool" | Select-Object -ExpandProperty Token > .\registrationtoken.txt
This command exports the registration information for the host pool and saves the value of the token into the registrationtoken.txt file in the local directory.
Parameters
-HostPoolName
The name of the host pool.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TenantName
The name of the tenant.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
System.String
Outputs
Microsoft.RDInfra.RDManagementData.RdMgmtRegistrationInfo