Citrix Integration ZenPack

ZenPacks.zenoss.PS.Citrix

"Citrix" is not a specific product or technology but more a "suite" of services or products. To make things more complex, some of these can be hosted on-prem or in Citrix Cloud.

The intent of this ZenPack is to provide a foundation to be able to monitor Citrix products and services. The ZenPack's current fucntionality is:

• Base library to poll Citrix Cloud hosted services.
• Poll events from Citrix Cloud WorkSpace (events will not clear).
• Poll Cloud Metrics
  • License usage
  • Connection/Machines failures
• Poll Citrix Workspace Events
• Model/Monitor XenApp device and its components.
  • Utilizes access to Citrix Cloud API to collect modeling data and metrics for XenApp devices.
  • Supports modeling the following components:
    • Machines
    • Catalogs
    • Desktop Groups
    • StoreFrontServices
    • BrokerSites
  • Includes custom monitoring templates for modeled components.
  • For more information, see About Citrix DaaS REST APIs

It should be noted that there are other ZenPacks that have been written to monitor specific Citrix technologies:

Citrix XenApp (ZenPacks.zenoss.PS.XenApp)

Monitor onPrem XenApp via Windows PowerShell

Citrix ADC (ZenPacks.zenoss.NetScaler)

Monitor onPrem ADC/Netscaler via SNMP

Subscription

This integration is a subscription-based Professional Services engagement. Our Integration Services are offered as subscriptions in order to provide initial setup and ongoing compatibility and maintenance. All standard packages are renewable every 12 months from the date of purchase. Contact Zenoss to request more information regarding this or any other ZenPacks.

Prerequisites

The table lists the Zenpack dependencies.

Prerequisite	Restriction
Product	Zenoss 6.2.1 or higher
Required ZenPacks	ZenPacks.zenoss.ZenPackLib >= 2.1.2 ZenPacks.zenoss.PythonCollector >= 1.11.0 ZenPacks.zenoss.PS.Util >= 1.11.2
Other dependencies	None

Usage

CitrixCloud REST API Datasource

To use this Datasource to query Citrix Cloud, set the zProperties with the appropriate values for your Citrix Cloud instance. The current templates provides bare-minimum monitoring, but they do provide a good example for creating custom templates to poll metrics from Citrix Cloud.

1. Create Device and set zProps
2. Create Template and a "CitrixCloud REST API" DataSource

3. Edit/Configure the new DataSource. Citrix Cloud contains many Services and API EndPoints, set the appropriate:

   1. API EndPoint containing the desired metric
   2. API Headers needed to make the HTTP request. Request Header values can differ between Citrix API EnPoints

4. Add a DataPoint to the new DataSource

   1. If simple, DataPoint to match name of metric in API response
   2. If complex/nested, set the Datapoint name to anything and use the DataPoint's "API Metric" field to the actual name in the API response. An example of a complex metric name is if it contains underscores. An example of a nested metric would be "expire/total".
   3. If a calculation of multiple polled metrics, use the "expr" field with an RPN expression to calculate a value from other DataPoint values.

Citrix Workspace Events Datasource

The only configuration this Datasource requires is workspace API endpoint of your instance.

Configuration Properties Citrix XenApp

• zCitrixCloudCustomerId
• zCitrixCloudOauthClientId
• zCitrixCloudOauthClientSecret
• zCitrixCloudOauthEndpoint
• zCitrixServiceApiEndpointBase
• zCitrixServiceApiValidateSSLCert
• zCitrixCloudInstanceId
• zCitrixIgnoreMachineAllocationType

Changelog

1.2.2

• SVC-3871: Fix XenApp Machine incorrect metrics, same values across multiple machines

1.2.1

• SVC-3726: cvad continuation token fix, add or update existing url query parameters

1.2.0

• SVC-3567: support cvad continuation token

1.1.1

• SVC-3566 Update to use new CitrixCloud API URLs

1.1.0

• SVC-3326: XenApp device modeling and monitoring via citrix rest api

1.0.2

• SVC-3342 Hotfix License datasource updates, percentages

1.0.0

• Initial release, Citrix Cloud framework