Verify Session Remote Start API Calls
Enumeration and Launch
A sample script shall be provided to verify the installation, configuration, and API calls.
enum_launch_example.ps1 (Only use the Citrix provided)
We strongly recommend executing the verification script on the 3rd-party Auth Service host.
The script enumerates and launches the resources by calling 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 is 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 will choose 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 now shown to be in a disconnected state, which means the resources are prepared and ready to accept an incoming reconnect.
Logoff
logoff_example.ps1 (Only use the Citrix provided)
The script logoffs the resources by calling 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.
Example:
.\logoff_example.ps1 -Fqdn "pmd-server.rl011.local" -Upns "pmd-user2@rl011.local","pmd-user1@rl011.local"
In this example, the script will logoff all the resources for the users pmd-user2@rl011.local and pmd-user1@rl011.local.
Output:
Note:
This API simply issues the log off request and does not wait for the sessions to complete logging off.
The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.
DIESER DIENST KANN ÜBERSETZUNGEN ENTHALTEN, DIE VON GOOGLE BEREITGESTELLT WERDEN. GOOGLE LEHNT JEDE AUSDRÜCKLICHE ODER STILLSCHWEIGENDE GEWÄHRLEISTUNG IN BEZUG AUF DIE ÜBERSETZUNGEN AB, EINSCHLIESSLICH JEGLICHER GEWÄHRLEISTUNG DER GENAUIGKEIT, ZUVERLÄSSIGKEIT UND JEGLICHER STILLSCHWEIGENDEN GEWÄHRLEISTUNG DER MARKTGÄNGIGKEIT, DER EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND DER NICHTVERLETZUNG VON RECHTEN DRITTER.
CE SERVICE PEUT CONTENIR DES TRADUCTIONS FOURNIES PAR GOOGLE. GOOGLE EXCLUT TOUTE GARANTIE RELATIVE AUX TRADUCTIONS, EXPRESSE OU IMPLICITE, Y COMPRIS TOUTE GARANTIE D'EXACTITUDE, DE FIABILITÉ ET TOUTE GARANTIE IMPLICITE DE QUALITÉ MARCHANDE, D'ADÉQUATION À UN USAGE PARTICULIER ET D'ABSENCE DE CONTREFAÇON.
ESTE SERVICIO PUEDE CONTENER TRADUCCIONES CON TECNOLOGÍA DE GOOGLE. GOOGLE RENUNCIA A TODAS LAS GARANTÍAS RELACIONADAS CON LAS TRADUCCIONES, TANTO IMPLÍCITAS COMO EXPLÍCITAS, INCLUIDAS LAS GARANTÍAS DE EXACTITUD, FIABILIDAD Y OTRAS GARANTÍAS IMPLÍCITAS DE COMERCIABILIDAD, IDONEIDAD PARA UN FIN EN PARTICULAR Y AUSENCIA DE INFRACCIÓN DE DERECHOS.
本服务可能包含由 Google 提供技术支持的翻译。Google 对这些翻译内容不做任何明示或暗示的保证，包括对准确性、可靠性的任何保证以及对适销性、特定用途的适用性和非侵权性的任何暗示保证。
このサービスには、Google が提供する翻訳が含まれている可能性があります。Google は翻訳について、明示的か黙示的かを問わず、精度と信頼性に関するあらゆる保証、および商品性、特定目的への適合性、第三者の権利を侵害しないことに関するあらゆる黙示的保証を含め、一切保証しません。
ESTE SERVIÇO PODE CONTER TRADUÇÕES FORNECIDAS PELO GOOGLE. O GOOGLE SE EXIME DE TODAS AS GARANTIAS RELACIONADAS COM AS TRADUÇÕES, EXPRESSAS OU IMPLÍCITAS, INCLUINDO QUALQUER GARANTIA DE PRECISÃO, CONFIABILIDADE E QUALQUER GARANTIA IMPLÍCITA DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM PROPÓSITO ESPECÍFICO E NÃO INFRAÇÃO.