How Does eG Enterprise Monitor the Citrix Cloud Connector?

eG Enterprise monitors the Citrix Cloud Connector in an agent-based manner. The Cloud Connector is typically installed on a machine running Windows Server 2012 R2 or Windows Server 2016. The eG agent should be installed on this box for monitoring the Cloud Connector.

The eG agent makes Cloud API calls to connect to the Citrix Cloud and pull metrics related to the availability and responsiveness of the cloud. For this purpose, you need to configure the eG agent with the following details:

  • A valid customer ID: When configuring the Citrix Cloud service, you should have created an API client on the cloud, so that any external program can communicate with the cloud. This API client is tied to a customer ID. The Citrix Cloud API requires this customer ID, when calling REST APIs. To get the customer ID for the API client that you have created in your environment, do the following:

    • Sign in to the Citrix Cloud administrator console.
    • Click the “hamburger menu” in the upper left corner of the console.
    • Select “Identity and Access Management” from the drop-down menu. An API Access page (see Figure 1 ) will open in the right panel. Look for the phrase , "use <customerID> as the customer parameter" in the right panel. The <customerID> displayed within that phrase (as highlighted in Figure 1) is the customer ID you need to configure the eG tests with.

      Figure 1 : Customer ID mapped to the API client

  • The path to the secure client file: When creating the API client on the cloud, you will be provided with an ID and a Secret for your client. Downloading this information saves a file named secureclient.csv. The eG agent uses the ID and Secret stored in this file to connect to the Citrix Cloud API. This is why, you will have to configure the Citrix Cloud Connectivity test with the full path to the secureclient.csv.

  • A valid Citrix cloud user with rights to access the cloud and pull metrics on critical cloud components: The secureclient.csv file mentioned above should be downloaded by a Citrix cloud user, with permissions to connect to the cloud and gather performance metrics on critical parts of the cloud (e.g., domains, secure clients, virtual apps/desktops etc.). The API client automatically inherits the 'access rights' defined for the user who downloads the secureclient.csv file. Since the eG agent communicates with the Citrix cloud via this API client, the agent naturally, will be allowed the same level of access as the client. This enables the eG agent to access and monitor the cloud seamlessly.

    To create such a user on the Citrix cloud, follow the steps below:

    • Sign in to the Citrix Cloud administrator console.
    • Click the “hamburger menu” in the upper left corner of the console.
    • Select “Identity and Access Management” from the drop-down menu. Click on the Administrators tab page in the page that appears (see Figure 2). Then, in the text box that is highlighted in Figure 2, specify the email ID of the new user who needs to be allowed cloud access. To invite that user, click on the Invite button next to the text box.

      Figure 2 : Inviting a new user to access the Citrix cloud

    • Figure 3 will then appear. Using Figure 3, you can define the access rights of the new user. For this, first select the Custom access option from Figure 3. Then, click on the General check box in Figure 3, so that the user is granted access to all the basic configurations on the cloud such as domains, libraries, licenses, secure clients etc. These General settings are displayed in Figure 4.

      Figure 3 : Choosing to customize the access rights of the new user

      Figure 4 : The General configurations on the cloud

    • Next, allow the user Read-only Administrator access to all virtual apps and desktops. For that, scroll down Figure 4, so that the Virtual Apps and Desktops group becomes visible. Expand the group and select the check box alongside Read Only Administrator, All (see Figure 5).

      Figure 5 : Granting Read-only Administrator access to all Virtual Apps and Desktops

    • Finally, click the Send Invite button in Figure 3, so that the invite is emailed to the new user. Once the invite is received, the user should follow the link in the invite to setup their login credentials. Then, using those credentials, the user should login to the cloud, and download the secureclient.csv file.

  • If a user who is currently logged on uses proxy for communicating with the Citrix Cloud Connector, then eG agent requires to be configured with proxy settings assigned for that user in Internet Explorer settings to report metrics related to user logon performance. To configure the proxy settings to the eG agent, do the following:

    • First, specify the proxy details that the user uses in the Internet Explorer settings. To achieve this, click on the icon provided at the right corner of the Internet Explorer window.

    • Clicking the icon will invoke a menu in which choose Internet Options. Then, select the Connections tab in the Internet Options window that appears (see Figure 2).

      Figure 6 : The Connections tab in the Internet Options window

    • Now, click the LAN Settings button in Figure 2. This will open the Local Area Network (LAN) Settings window (see Figure 3). In the Proxy Server section of this window, enable the Use a proxy server for your LAN check box and specify the IP address and port of the proxy server that the current user uses to communicate with the cloud connector in the Address and Port text boxes. Finally, click the OK button to register the changes.

      Figure 7 : Specifying proxy server details

    • Next, run the following command from the command prompt to import the assigned settings to the eG agent.

      C:\Windows\System32\bitsadmin.exe /util /setieproxy LOCALSYSTEM MANUAL_PROXY <PROXY_IPADDRESS/PROXY_HOSTNAME:PROXY_PORT> "<local>"

      For instance:

      C:\Windows\System32\bitsadmin.exe /util /setieproxy LOCALSYSTEM MANUAL_PROXY " <local>"

      C:\Windows\System32\bitsadmin.exe /util /setieproxy LOCALSYSTEM MANUAL_PROXY " <local>"


    You can remove the proxy settings that you provided in the Internet Explorer settings after the proxy settings are imported to the eG agent.