• Citrix Cloud Configuration

    Citrix Cloud integration is available for ControlUp 8.2 and up, allowing users to monitor Citrix resources over the cloud, from the cloud connector to your apps and desktops.


    This article describes how to add your Citrix Cloud infrastructure to your ControlUp organization.

    Monitoring Cloud Connectors

    From the ControlUp Console, you can view all of your cloud connectors, from any resource location. 

    Along with the common ControlUp metrics for any machine, you can get other useful information, specific to Citrix Cloud connectors, including:

    • Cloud Connector Status notifies you if your Citrix cloud connector is connected to the Citrix Cloud back-end successfully, and/or if there are any network, firewall, or credentials issues.
    • Cloud Connector Version checks if your Cloud Connector version matches the latest cloud connector version from the Citrix API and will let you know if it’s updated or not.
    • Cloud Connector Maintenance Mode notifies you if your cloud connector is in maintenance mode.
    • Cloud Connector Type indicates whether your cloud connector is a Windows machine or appliance.
    • Cloud Connector Version and Expected Version will show you the current version of your cloud connector, and the latest version available from Citrix.

      Note: Each of the displayed columns also works as a counter and can have triggers applied to them to enable you to immediately notify you of any changes. 

    It is recommended to Install a ControlUp agent onto your cloud connectors to get the most detailed monitoring information.

    Citrix Cloud Credentials

    Your Citrix Cloud credentials must be added to the Credentials Store in the ControlUp Console.
    You need your Citrix Cloud credentials before you begin to add them to ControlUp. You can learn how to create an API client and get your Citrix Cloud credentials here.

    It is best practice to have a monitor and leverage the credentials store on the monitor for the credentials used in the integration. This way those credentials are shared and you don't have to create separate credentials for each connection.

    To add your Citrix Cloud credentials:

    1. From the Settings screen, click Monitors, and the Manage ControlUp Monitors screen appears.
    2. Click Monitor Settings and the Sights and Monitors - Configuration Wizard screen appears.mceclip8.png
    3. Click Add Cloud Credentials, and the Add New Cloud Credentials popup appears.mceclip9.png
    4. In the displayed fields, enter the following:
      • Access Key -  Enter the Citrix Cloud API ID you created.
      • Secret Key - Enter the Secret Key for the ID you created in Citrix Cloud.
      • Friendly Name - Enter a useful name that the credential will be referred to.mceclip1.png
    5. Click OK, and the new credential is added to the credential store.

    Integration to ControlUp

    Add EUC Connection

    1. Click Add EUC Environment from the Home ribbon in the ControlUp Console, and the Add EUC Environment Connection popup appears.
    2. In the Add EUC Environment Connection popup, the displayed fields should be filled as follows:
      • Solution / Platform: Select Citrix Cloud from the drop-down menu.
      • Site Name: As stated in the text box, no action is needed and will be automatically populated.
      • Customer ID: Your customer ID as listed in citrix.cloud.com
      • Port: 443 (The default communication port.)
      • Credentials: Your Citrix Cloud credentials created on the monitor (see above) or create them here as a temporary solution. If created here, they may not be shared credentials.
      • Proxy: Configure a proxy connection to access the cloud, if necessary.
      • Data Collector: ControlUp data collector is mandatory for Citrix Cloud integration.
    3. Add a data collector by clicking the Data Collectors tab, and the Add Data Collection Agent popup appears.
    4. Click the data collector you want to add and click OK, and you are returned to the EUC Environment Connection popup with the chosen data collector(s) appearing in the Data Collectors section.
      Note: You can select multiple data collectors by pressing shift and clicking the data collectors.
    5. Optional: You can test the data collector's connection by clicking Test Connection.
    6. Once all the information has been entered, click OK, and the Citrix Cloud connection is added and appears in the EUC Environment folder of the organizational tree.

    Whitelist URLs

    Prior to version 8.5.1, the agent, which is configured as the Data Collector for the Citrix Cloud connection, will access the following URLs via 443/HTTPS:

    • https://[CustomerID].xendesktop.net/citrix/orchestration/api/v1
    • https://[CustomerID].xendesktop.net/citrix/monitor/odata/v4
    • https://registry.citrixworkspacesapi.net/[CustomerID]/ResourceLocations
    • https://agenthub.citrixworkspacesapi.net/[CustomerID]/EdgeServers
    • https://trust.citrixworkspaceapi.net 

    If you use a whitelist for controlling the connections to the ControlUp Agent, you should add these URLs to that list. For details on securing your agents generally, see ControlUp Agent Security Best Practices.


    The Data Collector agent is running as a system account (instead of a user account), which some proxy solutions may have an issue with.

    Around July 2021, Citrix is going to change the Citrix Monitor Service OData API (CTX312284 KB) and this will require a code change in the ControlUp product. That change will be part of ControlUp version 8.5.1. and above.


     For more information, contact support@controlup.com 


  • Connecting to Your XenDesktop Infrastructure

    Version 7.1 of ControlUp significantly improves XenDesktop monitoring functionality by adding a data collector component that gathers operational metadata directly from the XenDesktop API. This allows ControlUp to display real-time XenDesktop-specific information, such as VDA registration status, brokering performance in the console, and send it to ControlUp Insights for historical analysis and reporting.

    By adding a XenDesktop connection to ControlUp, you can benefit from the following features:

    • ControlUp automatically discovers VDAs, delivery groups, and brokers associated with your XenDesktop deployment. VDAs and brokers appear on the Computers view and XenDesktop sessions appear on the Sessions view. Note that with XenDesktop integration, ControlUp Agent deployment is not required for this discovery process.
      • Note: ControlUp Agent is required to monitor the performance of your VDAs and brokers and to display processes running on your VDAs and brokers
      • Note: each session discovered by the XenDesktop connection is counted as 1 ControlUp license
    • The XenDesktop site appears in the organization tree under “XenDesktop Sites”. The site itself, its delivery groups, and the “Brokers” container is displayed as folders as long as the XenDesktop connection is active. You can use the Focus action on these folders to filter the information grid to display VDAs or sessions in a specific delivery group or to examine the health of your XenDesktop brokers.
      • Note: the child folders of the XenDesktop connection in the organization tree (delivery groups and the Brokers container) are ephemeral objects which are not stored in ControlUp’s configuration. As such, they cannot be used to configure custom stress settings, incident triggers or column presets. To save custom settings for delivery groups or brokers, add the corresponding computers to the organizational tree using the Add Computers button.
    • Resources displayed in ControlUp are enriched with dozens of XenDesktop-related metrics and operational metadata. For example, the Computers view shows the “XD Computer Availability” column which shows “Available” for any VDAs which should be accessible by users, and the Sessions view shows the “XD Launched via HostName” column which contains the name of the StoreFront server used to launch each session.
      • Note: for the full list of metrics and metadata retrieved from the XenDesktop infrastructure, refer to the Computers and Sessions column reference. For your convenience, all XenDesktop column names are prefixed with “XD


    Adding a XenDesktop connection

    To connect ControlUp to your XenDesktop deployment, you need to create a XenDesktop site connection in ControlUp Console. The connection defines the address/es of the broker/s from which data is gathered and the credentials used for data collection and management actions. The following are mandatory prerequisites for adding a XenDesktop connection:

    • XenDesktop 7.5 or later
    • XenDesktop PowerShell SDK installed on all computers running ControlUp Console and Monitor, as well as any computers configured as dedicated data collectors

    Note: It is recommended to designate at least one computer on your network as a designated collector for XenDesktop data, especially in environments in which multiple instances of ControlUp are being used concurrently. For more information on configuring dedicated data collectors for XenDesktop, see below.

    To add a XenDesktop site connection, click on the Add XenDesktop button on the Home ribbon or right-click the root folder of your organization tree and select Add > XenDesktop Site. The Add XenDesktop Site Connection dialog box is shown.




    The following details are required:

    • Broker name / IP - enter the full name (FQDN), hostname, or IP address of a broker in your XenDesktop site
    • Credentials - use the drop-down to select or add a set of credentials that are used for data collection from your XenDesktop infrastructure.
    • In version 7.1 we've introduced the Shared Credentials Store used via the Monitor.
      • Note: For more information on configuring ControlUp Monitor for XenDesktop monitoring see below

    Once ControlUp establishes a connection with your XenDesktop site, it automatically populates the Site Name field with the site’s name and the Brokers Failover List tab with the names of all the broker servers assigned to the XenDesktop site.

      • Note: For more information on optimizing the performance of XenDesktop data collection, see below.


    Configuring ControlUp Monitor for XenDesktop

    After creating a XenDesktop connection, all ControlUp Monitor instances in your organization start connecting to the site and retrieving data. To avoid conflicts between data collected from different sources, all ControlUp instances in your network are required to use the same credentials for XenDesktop data collection. It is therefore recommended that you create a service account with adequate permissions for your XenDesktop site and save its credentials with all ControlUp instances on your network.

    To ensure that the monitor is able to collect data from the XenDesktop site, you need to ensure all monitor instances have the credentials you selected when creating the connection.

    To ensure that, perform the following steps for each installed monitor instance:

    1. Open the XenDesktop connection settings dialog by right-clicking the site connection in the folder tree and clicking Connection Settings.
    2. Note the username configured for XenDesktop data collection.
    3. Double-click a ControlUp monitor instance in the area below the organization tree.
    4. Click the Monitored Resources tab and locate the Name of your XenDesktop site. If its status is Connected, your monitor is communicating with the XenDesktop site. Otherwise, proceed to the next step.
    5. Click Settings… to open ControlUp Monitor configuration wizard
    6. Click Add Credentials Set… and provide the username, password, and domain for the user account recorded in step 2 above.


    Optimizing XenDesktop Data Collector Performance

    The following step is optional but strongly recommended to ensure optimal performance of the XenDesktop connection.

    By default, when you create a XenDesktop connection in ControlUp, all consoles and monitor instances in your organization start connecting to it automatically to collect information. This may create unnecessary performance overhead, especially if multiple instances of ControlUp Console and Monitor are used in your network. It is a best practice to designate one or more computers in your ControlUp organization to act as dedicated collectors for XenDesktop data.

    To configure dedicated data collectors, open the XenDesktop site connection settings dialog, expand the Data collectors panel and click the Add.. button to select a computer in your ControlUp organization to add as a dedicated data collector for XenDesktop. The following guidelines help you select an optimal data collector:

    • 1GB of available RAM
    • Uninterrupted connectivity to the XenDesktop site
    • Always on (except for planned maintenance/reboot windows)

    We added the option to view new entities in the console - XenDesktop Site, Brokers, and Delivery Groups.

    Focusing on each of the new entities shows the relevant new metrics pooled from the XD connection in the regular folder, computer, and sessions views.

    This enabled us to also add a drilldown from unmanaged XD VDAs to their sessions.

    In case one of the brokers or VDA machines have an agent deployed - the console shows all available metrics both from the XD site connection and the agent.


    We added the ability to calculate the health of each broker in the XenDesktop site.

    The health column calculation is based on a list of services, databases, and hypervisors, and in case all services are available and running, all databases can be reached and all hypervisors are available, the broker’s health is 100%. In case one of the parameters is not ok, it affects the broker’s health by a few percent.

    Each of the parameters that the calculation is based on can be excluded from the registry (by default the % hypervisors available is excluded).

    The Site itself shows an aggregated calculation of what % of brokers are 100% healthy.