Use the Nerdio Compass Citrix Export tool to connect to your Citrix environment and export a snapshot

Avatar
Nerdio Product Support

Use the Nerdio Compass Citrix Export tool in GUI mode to export configuration data from a Citrix environment for Nerdio Compass. The tool supports both Citrix Virtual Apps and Desktops (CVAD) and Citrix DaaS (Citrix Cloud); the procedure is the same for both, except that connecting to Citrix DaaS requires an additional Citrix Cloud sign-in.

Prerequisites

  • 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.

  • You must have installed the Citrix PowerShell SDK.

System Requirements

  • PowerShell Version: 5.1 or later (both Windows PowerShell 5.1 and PowerShell 7+)

    Important

    Export mode supports PowerShell 5.1 only.

  • Citrix SDK Required: Citrix Remote PowerShell SDK (https://download.apps.cloud.com/CitrixPoshSdk.exe) for Export mode

  • Platforms Supported:

    • Windows PowerShell 5.1 Desktop edition (GUI mode)

    • PowerShell 7+ (anonymise, reverse modes)

  • Network: Connectivity to Citrix Cloud (for DaaS) or network access to CVAD delivery controllers

  • Permissions: Read access to Citrix configuration; write access to output directories

To export a Citrix snapshot:

  1. In File Explorer, right-click Invoke-CitrixCompassExport.ps1 and select Run with PowerShell.

  2. In the Citrix Snapshot Export window, under Export settings, confirm the Output folder or select Browse to choose a different location.

  3. Under Citrix connection, set Connection type to match your environment:

    • For an on-premises CVAD environment, leave the toggle set to Citrix Virtual Apps and Desktops and enter the Delivery controller address (or leave the default of localhost if running the tool directly on a Delivery Controller).

    • For Citrix DaaS, turn the toggle on so it reads Citrix DaaS and enter your Customer ID (your Citrix Cloud ID, or CCID).

  4. If you set Connection type to Citrix DaaS, sign in to Citrix Cloud with your credentials and complete multi-factor authentication if prompted. Skip this step for CVAD — no Citrix Cloud sign-in is required.

  5. Ensure Anonymise sensitive data is checked if you want personally identifiable information (usernames, machine names, security identifiers, and similar values) replaced with synthetic values before packaging, and unchecked if you want the export to contain the original values.

  6. Ensure Package as .zip for Compass portal is checked if you plan to upload the export directly to the Compass portal.

  7. Select Create Compass package.

  8. The Progress pane logs each stage of the export as it runs. The tool exports the environment's delivery groups, access policies, machine catalogs, machines (including MCS-provisioned and personal desktops), applications, hypervisor connections, zones, users, images, and GPO policies, along with a snapshot metadata file.

  9. When the export finishes, the output folder opens automatically in File Explorer, showing the exported JSON files and, if packaging was enabled, the compressed .zip archive ready for upload to the Compass portal.

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.