Prerequisites

<< Click to Display Table of Contents >>

Raynet One Data Hub > 2025.4 > Connectors > Alphabetic Connector List > Citrix Session Monitoring 

Prerequisites

Before configuring the Citrix Session Monitoring connector, ensure the following requirements are met:

 

Citrix Cloud Account Requirements

An active Citrix Cloud account with administrative privileges.

Access to Citrix Virtual Apps and Desktops (CVAD) or Citrix DaaS (Desktop as a Service) environment.

Citrix Monitor Service enabled in your Citrix Cloud environment.

 

API Access Credentials

To connect to the Citrix Cloud Monitor Service API, you need to create API access credentials. Follow these steps:

 

1.Sign in to Citrix Cloud with an administrator account.

2.Navigate to Identity and Access Management > API Access.

3.Click Create Client to generate new API credentials.

4.Provide a descriptive name for the client (e.g., "Data Hub Citrix Connector").

5.Save the Client ID and Client Secret in a secure location. The Client Secret is only displayed once.

6.Note your Customer ID, which is visible in the Citrix Cloud console.

 

papercliper

Important:

The Client Secret is displayed only once during creation. Store it securely, as it cannot be retrieved later. If lost, you must create a new API client.

 

Network Requirements

Network connectivity from the Raynet One Data Hub Agent to Citrix Cloud API endpoints.

HTTPS (port 443) access to api.cloud.com (or api.citrixcloud.jp for Japan region).

Firewall rules configured to allow outbound connections to Citrix Cloud services.

 

Required Permissions

The API client must have the following permissions:

 

Monitor Service API Access: Read access to session and application instance data.

Virtual Apps and Desktops: Read access to machine catalogs, hypervisors, and infrastructure information.

 

papercliper

Note:

For detailed information about creating API clients and permissions, refer to the Citrix Cloud API Documentation.

 

Data Availability

The Citrix Monitor Service stores historical data for a limited period:

 

Session data is available for up to 180 days.

Application instance data is available for up to 180 days.

Configure the fetchStartDatePeriod parameter to specify the data collection timeframe (1-180 days).