The following documentation content might not be fully up to date since content here refers to an older version or is currently being reviewed. Come back later to check status.
Description
The Citrix listener plugin collects data from Citrix and sends it to 1Gateway as messages. The messages sent will then be processed in the core and sent on to the senders configured.
Prerequisites
Citrix XenDesktop v7 or later
Installation
Make sure you have the 1gateway zip file that includes the plugin files and valid licences information ready. This file has been provided to you with the installation files.
1 - Login
Login to 1gateway, and make sure you are in "Advanced mode". If this is the first time you log in, the default user and password are both 'admin' (without the quotes).
2 - System Maintenance
Click on the menu icon and choose the option "System maintenance"
3 - Upload file
In the System maintenance view you can either drag and drop the downloaded zip file or select it by clicking the "choose file" button.
4 - Restart
After the upload installation will be confirmed. Restart 1Gateway to ensure any locked files are updated.
Configuration
Open the main menu and click on "New plugin"
Select the plugin you want to configure. Use the Filter field if needed.
The Citrix configuration consists of the generic fields that every plugin needs as well as the specific Citrix fields:
Field name
Supported values
Description
server
Valid ip address or hostname
Citrix server.
user
Any string
Username for the ntlm authentication.
password
Any string
Password for the ntlm authentication.
domain
Any string
Domain for the ntlm authentication.
Sessions per host interval
Any integer
Poll interval (default is 300) in seconds of sessions per host data (only if item is selected).
Number of connected sessions interval
Any integer
Poll interval (default is 300) in seconds of number of connected sessions data (only if item is selected).
The type of information that needs to come out of Citrix also needs to be configured (by selecting item and setting polling interval):
Number of connected sessions.
Sessions per host: get session information for each host.
Advanced configuration
The advanced configuration of the Citrix listener plugin includes more fields that allow further configuration. The fields in the advanced configuration are:
Field name
Supported values
Description
Suffix of the Citrix endpoint
Valid Odata query
Odata query that defines the information to get from Citrix.
Message type
Any string
Message type of incoming messsages from Citrix. Used in mappers used to convert messages to normalized metrics and events.
