Session Remote Start local testing

Open Session Remote Start Web Local Testing

Open https://<Session Remote Start FQDN>/SessionRemoteStart/index.html, if successful without warning. There are three tabs on the top left: Enumerate and Launch, Launch Desktops, and Logoff.

1. Enumerate and Launch: Enumerate resources for a given UPN. Then launch the specified resource for the given UPN.

2. Launch Desktops: Session Remote Start supports launching all desktops using three methods.

   • Launch All Desktops of a User Principal Name (UPN)
   • Launch All Desktops by Tags of a User Principal Name (UPN)
   • Launch All Desktops assigned to the UPNs in the specified AD groups

3. Logoff: Logs off all sessions for the given UPN and device name.

   

Enumerate and Launch Resource of a User Principal Name (UPN)

Input the User Principal Name (UPN), then click Enumerate Resources.

Then choose a resource, for example: Daily ms 1 and click Launch Daily ms 1. The API waits for a logon notification from the VDA before returning to the caller.

A prompt appears with a notification if the resource is launched successfully. Then, check the session in the studio.

Launch Desktops

Launch All Desktops of a User Principal Name (UPN)

Enter the User Principal Name (UPN), then click Launch All Desktops. A prompt appears with a notification if the resources are launched successfully. Then, check the sessions in the studio.

Launch All Desktops by Tags of a User Principal Name (UPN)

Enter the User Principal Name (UPN) and tags, then click Launch All Desktops By Tags. A prompt appears with a notification if the resources are launched successfully. Then, check the sessions in the studio.

Launch All Desktops of AD Groups

Input AD Groups then click Launch All Desktops of AD Groups. A prompt appears with a notification if the resources are launched successfully. Then, check the sessions in the studio.

Log off Sessions of a User Principal Name (UPN)

Input the User Principal Name (UPN), then click Logoff Sessions. A prompt appears with a notification if the sessions are logoff successfully. Then, check the sessions in the studio.

Verify Session Remote Start API Calls

Enumeration and Launch

A sample script is provided to verify the installation, configuration, and API calls.

enum_launch_example.ps1 (Use the one provided by Citrix)

We strongly recommend running the verification script on the 3rd-party Auth Service host.

The script enumerates and launches the resources by calling the Session Remote Start APIs.

Run the script in PowerShell with two mandatory parameters:

• Fqdn: FQDN of the Session Remote Start server
• Upns: An array of UPNs and Resource Names separated by a colon (“:”), resource name can be omitted, in which case the first resource in the list will be chosen.

Example:

.\enum_launch_example.ps1 -Fqdn "pmd-server.rl011.local" -Upns "pmd-user2@rl011.local:PMD-Server2019-2","pmd-user1@rl011.local"

In this example, the user "pmd-user2@rl011.local" is assigned to launch desktop "PMD-Server2019-2" (this is the name of the desktop as users see on their workspace). And no target resource is specified for user "pmd-user1@rl011.local". The script chooses the first one in the resource list.

Output:

Verify the job output to make sure the resources are pre-launched successfully.

Alternatively, the execution result can be verified in Citrix Studio. Before running the script, no sessions are shown for the target machines:

After running the script, the sessions are shown in a disconnected state, which means the resources are prepared and ready to accept an incoming reconnect.

Logoff

logoff_example.ps1 (Please use the one provided by Citrix)

The script logs off the resources by calling the Session Remote Start APIs.

Run the script in PowerShell with two mandatory parameters:

• Fqdn: FQDN of the Session Remote Start server
• Puns: An array of UPNs.

Example:

.\logoff_example.ps1 -Fqdn "pmd-server.rl011.local" -Upns "pmd-user2@rl011.local","pmd-user1@rl011.local"

In this example, the script log off all the resources for the users "pmd-user2@rl011.local" and "pmd-user1@rl011.local".

Output:

Note that this API simply issues the log off request and does not wait for the sessions to complete logging off.