Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
1.0.4Metric labels.
1.0.3Full discovery Support.
1.0.2Alert custom Macros support to the Metric and Component level.
Click here to view the earlier version updates
Application VersionBug fixes / Enhancements
1.0.1Notification Alert support in case of ODataClient Error Exception.


Citrix VDI are virtualization solutions that give IT control of virtual machines, applications, licensing, and security while providing access for any device.

Citrix Virtual Applications and Desktops allow:

  • End users to run applications and desktops independently of the device’s operating system and interface.
  • Administrators to manage the network and control access from selected devices or all devices.
  • Administrators to manage an entire network from a single data center.

Citrix Virtual Applications and Desktops share a unified architecture called FlexCast Management Architecture (FMA). FMA’s key feature is to run multiple versions of Citrix Virtual Applications or Citrix Virtual Desktops from a single site and integrated provisioning.

Citrix OnPrem VDI

Discovery Use cases

Discovery Citrix VDI elements delivery groups and machines.

Monitoring Use cases

Using the REST APIs of the Citrix Monitor Service to collect, analyze, and categorize data from Citrix Virtual Applications and Desktops.

Hierarchy of Citrix VDI

Hypervisor (Xen server)
     - Delivery Groups
      - Machines(desktops)


  • OpsRamp Classic Gateway 14.0.0 and above.
  • OpsRamp NextGen Gateway 14.0.0 and above.
    Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitsApplication VersionDescription
Hypervisorcitrix_onprem_hypervisor_stateCitrix Onprem Hypervisor State1.0.0Hypervisor Availability. Possible values 0,1,2,3 Active, Deleted, RequiresResolution, Stub.
Delivery Groupcitrix_onprem_desktops_in_maintenancemodeCitrix Onprem Desktops In Maintenance Mode1.0.0Citrix Onprem Desktops In Maintenance Mode.
citrix_onprem_desktops_in_maintenancemode_percentCitrix Onprem Desktops In Maintenance Mode Percent%1.0.0Citrix Onprem Desktops In Maintenance Mode Percent.
citrix_onprem_desktops_total_countCitrix Onprem Desktop Total Count1.0.0Citrix Onprem Desktop Total Count.
citrix_onprem_desktops_preparingCitrix Onprem Desktop Preparing1.0.0Citrix Onprem Desktop Preparing
citrix_onprem_desktops_preparing_percentCitrix Onprem Desktop Preparing Percent%1.0.0Citrix Onprem Desktop Preparing Percent
citrix_onprem_desktops_failure_countCitrix Onprem Desktops Failure Count1.0.0Citrix Onprem Desktops Failure Count
Desktopcitrix_onprem_desktop_power_stateCitrix Onprem Desktop Power State1.0.0Citrix Onprem Desktop Power State. Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10. Unknown, Unavailable, Off, On, Suspended, TurningOn, TurningOff, Suspending, Resuming, Unmanaged, NotSupported.
citrix_onprem_desktop_registration_stateCitrix Onprem Desktop Registration State1.0.0Citrix Onprem Desktop Registration State.Possible values: 0, 1, 2. Unknown, Registered, Unregistered.
citrix_onprem_desktop_unregisteredpoweronstateCitrix Onprem Desktop UnRegistered PowerOn State1.0.0Citrix Onprem Desktop UnRegistered PowerOn State.
citrix_onprem_desktop_cpu_usage_percentCitrix Onprem Desktop CPU Usage Percent%1.0.0Citrix Onprem Desktop CPU Usage Percent.
citrix_onprem_desktop_memory_usageCitrix Onprem Desktop Memory UsageMB1.0.0Citrix Onprem Desktop Memory Usage.
citrix_onprem_desktop_memory_available_in_mbCitrix Onprem Desktop Memory Available In MBMB1.0.0Citrix Onprem Desktop Memory Available In MB.

Default Monitoring Configurations

Citrix VDI has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business use cases by cloning respective Global Templates and Global Device Management Policies. OpsRamp recommends doing this activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for each Native Type of Citrix Onprem VDI. You can find those Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names in global scope. Each Device Management Policy follows below naming convention:

    {appName nativeType - version}

    Ex: citrix-onprem-vdi Citrix Hypervisors - 1 (i.e, appName = citrix-onprem-vdi, nativeType = Citrix Hypervisors, version = 1)

  2. Default Global Templates

    OpsRamp has a Global Template for each Native Type of Citrix VDI. You can find those templates at Setup > Monitoring > Templates, search with suggested names in global scope. Each template follows below naming convention:

    {appName nativeType 'Template' - version}

    Ex: citrix-onprem-vdi Citrix Hypervisors Template - 1 (i.e, appName = citrix-onprem-vdi, nativeType = Citrix Hypervisors Template, version = 1)

  3. Default Global Monitors

    OpsRamp has a Global Monitors for each Native Type which has monitoring support. You can find those monitors at Setup > Monitoring > Monitors, search with suggested names in global scope. Each Monitors follows below naming convention:

    {monitorKey appName nativeType - version}

    Ex: Citrix Hypervisors Monitor citrix-onprem-vdi Citrix Hypervisors 1(i.e, monitorKey = Citrix Hypervisors Monitor, appName = citrix-onprem-vdi, nativeType = Citrix Hypervisors, version = 1)

Configure and Install the Citrix OnPrem VDI Integration

  1. From All Clients, select a client.
  2. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed. If there are no installed applications, it will navigate to the Available Integrations and Apps page.
  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
  6. Search for the application using the search option available. Alternatively, use the All Categories option to search.
Cisco FirePower
  1. Click Add in the Citrix OnPrem VDI tile.
  2. In the Configurations page, click + ADD. The Add Configuration page appears.
  3. Enter the below mentioned BASIC INFORMATION:
NameEnter the name for the configuration.
Host Name / IP AddressHost name / IP address of the target

Note: By default 80 is added.
CredentialsSelect the credentials from the drop-down list.

Note: Click + Add to create a credential.


  • Select the isSecure checkbox.
  • Host Name/Ip Address and Port should be accessible from Gateway.
  • Select App Failure Notifications; if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
  1. Select the below mentioned Custom Attribute:
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect the value from the drop down list box.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.
Cisco FirePower

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.

  1. Click NEXT.
  2. Below are the optional steps you can perform on the Installation page.
  • Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

    Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

Cisco FirePower
  • Click +ADD to create a new collector by providing a name or use the pre-populated name.
Aruba Airwave Integrations
  1. Select an existing registered profile.
Aruba Airwave Integrations
  1. Click FINISH.

The integration is now installed and displayed on the Installed Integration page. Use the search field to find the installed integration.

Modify the Configuration

View the Citrix OnPrem VDI Details

The Citrix OnPrem VDI integration is displayed in the Infrastructure > Resources > Xen Server. You can navigate to the Attributes tab to view the discovery details, and the Metrics tab to view the metric details for Citrix OnPrem VDI.

Citrix OnPrem VDI
Citrix OnPrem VDI

Supported Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alert based on customisation.
Supported macros keys:

Click here to view the alert subject and description with macros













                                ${Custome Attributes in the resource}


Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration:

    • Connectivity Exception (ConnectTimeoutException, HttpHostConnectException, UnknownHostException)
    • Authentication Exception(UnauthorizedException)
  • Application will send any duplicate/repeat failure alert notification for every 6 hours.

  • Latest snapshot metric is available from Gateway version 14.0.0.

  • Application cannot control monitoring pause/resume actions based on above alerts.

  • Metrics can be used to monitor Citrix resources and can generate alerts based on the threshold values.

  • We are not providing these following requested metrics as we are not getting any response in the API’s:

        DesktopConditions_ICALatency,ICASessionLatency,DatabaseConnected,DesktopsAvailable, DesktopsAvailablePercent, BrokerServiceStatus, PercentProcessorTime, PhysicalDiskCurrentQueueLength, PhysicalDiskTotalDiskBytesPerSec, DesktopsNeverRegistered, DesktopsNeverRegisteredPercent.

  • Application is not compatible with Cluster Gateway.

  • Support for Macro replacement for threshold breach alerts (i.e, customisation for threshold breach alert’s subject, description).

  • No support of showing activity log and applied time.

  • This application supports both Classic Gateway and NextGen Gateway