Install the Citrix PowerShell SDK

Avatar
Nerdio Product Support

The Nerdio Compass Citrix Export tool requires the Citrix Remote PowerShell SDK before it can export configuration data from Citrix DaaS or Citrix Virtual Apps and Desktops (CVAD). If the SDK isn't already installed, use the built-in installer in the tool's GUI mode to download and install it.

Note

You must have a copy of the Nerdio Compass Citrix Export tool (Invoke-CitrixCompassExport.ps1) downloaded locally. You can obtain this in Nerdio Compass from System > Support.

Installing the SDK requires administrator privileges. You only need to do this once per machine.

To install the SDK:

  1. In File Explorer, browse to the folder containing Invoke-CitrixCompassExport.ps1.

  2. Right-click Invoke-CitrixCompassExport.ps1 and select Run with PowerShell. If a User Account Control prompt appears, select Yes to allow the script to run with administrator privileges.

    Warning

    Do not use the Windows PowerShell Integrated Scripting Environment (ISE) to launch the Citrix Export tool. The script may fail if launched using the PowerShell ISE. 

  3. The Citrix Snapshot Export window opens on the General tab. The Progress pane reports the result of an automatic SDK check on startup.

  4. Select the Advanced tab.

  5. Under Citrix PowerShell SDK, confirm that SDK install status does not already show Installed, then select Download & install SDK.

    Note

    The panel always displays a message stating that installing the SDK requires elevation, even if you're already running as administrator. If the Progress pane instead reports an error mentioning Get-PSSnapin, this means the script launched under PowerShell 7 (Core) rather than Windows PowerShell 5.1 (Desktop). Close the window and relaunch it as described above — the SDK check requires Windows PowerShell 5.1.

  6. The Citrix DaaS Remote PowerShell SDK installer opens. Review the license agreement, select I accept the terms of this license agreement, then select Next.

  7. Continue through the remaining installer screens to complete the installation. When the installer finishes, close its window.

    Warning

    Do not install the Citrix PowerShell SDK on a Citrix Cloud Connector or Citrix Delivery Connector. See the Citrix guidance Install and use the Remote PowerShell SDK for details.

  8. The Progress pane instructs you to restart the app. Close Citrix Snapshot Export, then relaunch it as described above.

  9. On the Advanced tab, confirm that SDK install status now shows Installed. You're ready to export a snapshot.

Was this article helpful?

0 out of 0 found this helpful
Have more questions? Submit a request

Related articles

Comments (0 comments)

Article is closed for comments.