Install Remote PowerShell SDK for Managing Citrix Cloud Virtual Apps and Desktops

How to download and install Citrix Virtual Apps and Desktops Remote PowerShell SDK, add Citrix PowerShell Snapins and connect to Citrix Cloud

Citrix Virtual Apps and Desktops Remote PowerShell SDK Requirements

• Can be installed on any domain joined machine
• Requires PowerShell 3.0, 4.0, or 5.0
• Requires .NET Framework 4.8 or later (.NET Framework will be automatically downloaded and installed during setup)
• Citrix Virtual Apps and Desktops SDK must be removed before installing the Remote PowerShell SDK

Download Citrix Virtual Apps and Desktops Remote PowerShell SDK

Citrix Virtual Apps and Desktops Downloads
https://www.citrix.com/downloads/citrix-cloud/product-software/xenapp-and-xendesktop-service.html

Get Citrix Cloud Customer ID

Sign into Citrix Cloud
https://citrix.cloud.com

Menu - Identity and Access Management

API Access - copy the customer ID

Install Virtual Apps and Desktops Remote PowerShell SDK

Run CitrixPoshSdk.exe

Click Accept and Install

Setup in progress

Click OK

You may need to restart your computer after the installation

Accept the license agreement, click Next

Remote PowerShell SDK installation in progress

Installation finished, click Close

Add Citrix PowerShell Snapins

Open PowerShell

asnp citrix*.

Citrix Cloud remote PowerShell authentication methods

You can connect to Citrix remote PowerShell using:

Get-XDAuthentication

Get-XDAuthentication will prompt you to authenticate to Citrix Cloud using your Citrix Cloud identity or Azure AD credentials. Get-XDAuthentication will generate an interactive prompt to sign in to Citrix Cloud and complete MFA.

Set-XdCredentials

You can use Set-XdCredentials to create an authentication profile to connect to Citrix Cloud API using a client ID and secret created in the Citrix Cloud portal.

Connect to Citrix Cloud using PowerShell Get-XDAuthentication

Get-XDAuthentication -CustomerId CUSTOMERID

Get-XDAuthentication -verbose -CustomerId CUSTOMERID

Example: Sign in with Citrix Cloud identity

Example: Sign in with Azure AD credentials

If you are signing in using Azure AD, click "Sign in with my company credentials" and enter your company's sign in URL

References:

Citrix DaaS Remote PowerShell SDK - Install and use the Remote PowerShell SDK
https://docs.citrix.com/en-us/citrix-daas/sdk-api.html#citrix-virtual-apps-and-desktops-remote-powershell-sdk

Getting started with PowerShell automation for Citrix Cloud
https://www.citrix.com/blogs/2022/02/03/getting-started-with-powershell-automation-for-citrix-cloud

by Author