Get Started Knowledge Base FAQs Troubleshooting Latest Release
Submit a Ticket

Menu

    Configure Citrix DaaS (Cloud) Government

    Avatar
    Heather McLeod
    • Updated

    Requires Goliath Performance Monitor v12.1.3 or later.

    Prerequisites

    • Citrix Cloud Government supported
    • Citrix Customer ID required
    • Citrix Client ID required
    • Citrix Secret Key required
    • Citrix Profile Management service is required to be installed and running on the VDA in order to collect Logon Duration metrics.
      • Citrix Profile Manager needs to be installed on the VDA and the service needs to be started even if you are not using User profile Management for managing user profiles.
    • PowerShell 3.0 or newer required on the VDA
    • Full Microsoft SQL suggested for full implementations of Goliath Performance Monitor
    • Support for real-time process metrics can be resource intensive requiring us to determine viability that we would test in the implementation.
    • To use and display Active Directory details within Citrix views and reports, the Goliath Performance Monitor user must have access to the desired Active Directory. For full details, please reference How to View Active Directory details for Citrix Users.

    You can generate an obtain the required Citrix credentials and details from your Citrix Cloud instance in the Identity and Access Management area. The following article describes the required steps.

    Citrix Docs: Creating API Client

    It is important to note that mentioned in the above article, API clients are automatically restricted to the rights of that administrator that created it. For example, if an administrator is restricted to access only one delivery group, then the administrator's API clients have the same restrictions. If an administrator’s access is reduced at any point, then the access of all the API clients owned by that administrator is also reduced. If an administrator’s access is removed from the list of administrators within that customer, then all of the administrator's API clients are also removed.

     

    Enable Citrix Cloud Government Monitoring

    1. On the Goliath Server machine, open Windows File Explorer and navigate to the install directory
      1. default location is C:\Program Files\MonitorIT
    2. Edit the file GPMAgent.cfg in Notepad or Notepad++
    3. Upon opening, the file by default should only contain an open and close bracket as such {}
    4. Copy and paste the following configuration settings in between the brackets  
      1. "CitrixCloudServer": "xendesktop.us",
        "CitrixCloudIsGovernment": true,
        "CitrixCloudTrust":"trust.citrixworkspacesapi.us",
        "CitrixCloudTrustFolder": "root/tokens/clients"
    5. Save and close the GPMAgent.cfg file
    6. Open the web browser and connect to the Goliath console
    7. Navigate to the Configure > Inventory page.
    8. Locate your Goliath server in the inventory list, select it, and click Edit.
    9. In the dialog that opens, click Enable Citrix Cloud.
    10. Enter the Citrix Cloud credentials and click Save.
      1. mceclip0.pngAfter a few minutes, you will begin to see Citrix Cloud session data displayed in the Views - Citrix Virtual Apps and Desktops dialog.
    11. Next install Goliath agents to the VDA devices within your environment. See the post configuration section at the bottom of this article for additional details.
      Note: The Goliath agents are required to collect and display additional Citrix session metrics.

     

    Enable Citrix Cloud Connector Monitoring

    NOTE: This requires a Citrix Cloud module installed to GPM that allows you to import and install Citrix Cloud Connector rules. To obtain the Citrix Cloud module, contact your Goliath Implementation engineer.

    1. Go to the Configure - Inventory page.
    2. Next, add your Citrix Cloud Connector Devices:
      • Click New at the top of the page and fill in the appropriate information (server name, ip address, domain, etc) then click Save. Repeat for the additional Citrix Cloud Connector Devices.
        mceclip1.png
    3. To enable Citrix Cloud Connector monitoring, deploy an agent to the Citrix Cloud Connector devices. This can be done by clicking Manage Agents at the bottom of the page.
    4. When the Manage Agent dialog opens, select the Cloud Connector Device(s) that you would like to deploy an agent to.
    5. The first time an agent is deployed to a server, you must choose the Deployment Settings button and enter one-time local administrator credentials in order to copy over and run the install files. These credentials are not saved anywhere in the database. Once an agent connection has been establish this step is no longer needed.
      1. mceclip0.png
    6. Click the Install/Update Agents button at the bottom of the dialog to begin the agent installation. You will see a prompt warning you to enter credentials if this is the 1st agent deployment, click OK to bypass and begin the agent installation
    7. Depending on the number of Agents that are being installed, the process may take a few minutes to complete (do not refresh the page). You will see green checkboxes appear as the agent installation succeeds
    8. Once all agents have been installed, you will receive a prompt that the installation is complete. Click Close at the bottom of the dialog to return to the Inventory page.
    9. Once on the Inventory page, confirm the agents are connected by looking at the Agt column and identifying a green box. This could process could take a 1-3 minutes and you will need to refresh the page.
      1. mceclip1.png
      2. Note, if you do not see an icon in the Agt column after 5 minutes, confirm that the Goliath Server is accepting inbound TCP communication on all firewall levels (Domain, public, private) and that the server where the agent is installed is allowing outbound TCP communication for all firewall levels.
    10. Once the agent for the Cloud Connector Devices are connected you'll need to configure monitoring for them. Navigate to Configure - Monitoring Rules page
    11. Click the menu icon and chose the submenu option for Import/Export Rules.
    12. In the dialog that opens, select Import Monitoring Rules and click OK.
      mceclip2.png
    13. In the next dialog, select Citrix Cloud from the list and click OK.mceclip3.png
    14. The new rules are imported to the Monitoring Rules table. Refresh the page to view the new rules.
    15. Next, add your Citrix Cloud Connector devices to be monitored. Navigate to the Configure - Groups page, select the line item for Citrix Cloud and click Edit.
    16. In the dialog that opens, select the button in the middle of the pane for Servers/Devices.
    17. Scroll through the list of servers and select your Cloud Connector Device(s) then click Apply.
    18. Click Save.

     

    Post Configuration: What’s Next?

    Now that Citrix Cloud monitoring has been enabled in Goliath Performance Monitor, to start collecting user session data and alerting on faults taking place you’ll need to deploy an agent onto your session hosts and/or VDI’s. Please see additional documentation below. 

    Please note: If you are using PVS or MCS to deploy your Citrix environment, the agent will need to be installed into the Gold and or Master Image(s). 

    Related articles