NOTE: The tool now includes a user manual with detailed usage instructions. Please see the CloudConnectivityCheckHelp.chm file.
About This Release
Removed the following reachability tests:
- https://dl.cacerts.digicert.com/DigiCertAssuredIDRootCA.crt
- https://dl.cacerts.digicert.com/DigiCertSHA2AssuredIDCodeSigningCA.crt
Added the following reachability test:
Added Checking for the presence of the following new Root and Intermediate certificates. This check should be the same as the existing “DigiCert Assured ID Root CA” and “DigiCert SHA2 Assured ID Code Signing CA”.
- DigiCert Trusted Root G4/ddfb16cd4931c973a2037d3fc83a4d7d775d05e4
- DigiCert Trusted G4 Code Signing RSA4096 SHA384 2021 CA1/7b0f360b775f76c94a12ca48445aa2d2a875701c
Description
The Cloud Connector Connectivity Check tests the reachability of the Citrix Cloud and its related services. It is meant to be run from the Cloud Connector machine to test its connectivity to the cloud.
It can also be used to configure proxy settings on the Cloud Connector.
If a proxy server is set, all the connectivity checks are tunneled through the proxy server – to also verify reachability via proxy.
Prerequisites
For full functionality the tool should be run on the Citrix Cloud Connector itself.
Installing
No installation is required. Simply copy the Cloud Connector Connectivity Check files to any desired location on the system and execute from there. There is one required executable file (Cloud Connector Connectivity Check.exe), one required DLL library and 3 optional DLL libraries. If the option to report anonymous usage statistics via Google Analytics was selected, then the 3 optional Google Analytics DLLs are also required – otherwise they are not needed. All binaries need to exist within the same directory (folder):
- Cloud Connector Connectivity Check.exe
- Psexecutor.dll
- If chosen to opt-in to CSEIP (customer service experience improvement program) anonymous usage statistics reporting, then the following DLLs are also required:
- GoogleAnalyticsAPI.dll
- GoogleAnalyticsTracker.Core.dll
- GoogleAnalyticsTracker.Simple.dll
How to Use
To run the tool, right-click on the Cloud Connector Connectivity Check.exe executable and click on ‘Run as Administrator’
- If this is the first time running the app, you will get asked to participate in the Citrix Customer Service Experience Improvement Program (CSEIP) – which is essentially just asking if it’s OK to collect anonymous usage statistics via Google Analytics to improve features of the app. If you disagree, simply choose ‘I do not agree’ and click ‘Save’ and/or close the dialog
- The main app Window will then appear. By default, the tool will show the current proxy configuration for Internet Explorer and the default system-wide settings
- Since the cloud connector services can only read the system-wide settings, we need to make sure the system-wide settings are set
- The tool will allow the administrator to either:
- Import the existing proxy settings from Internet Explorer, (via the Import IE Proxy Settings button)
- Or the system-wide settings can be set explicitly using the Set Proxy Config button (and corresponding fields)
- In addition to setting proxy settings, the tool can be used as a connectivity check utility
- To import the proxy settings from IE, simply click the Import IE Proxy Settings button and follow the prompts to confirm
- To explicitly set the system-wide proxy settings, manually enter the Proxy List and Bypass List details into the corresponding text fields, then click the Set Proxy Config button (*Follow the example recommendations above the text fields*)
The tool will display the updated proxy configuration automatically
- Click the Add Citrix Trusted Sites button to add any missing Citrix trusted sites to the trusted sites internet zone
- This enables the Security_Hklm_Only registry setting so that system settings (HKLM) are used instead of user settings (HKCU)
- This in turn creates a DWORD registry value called `Security_HKLM_only` under:
- HKEY_LOCAL_MACHINESoftwarePoliciesMicrosoftWindowsCurrentVersionInternet Settings
- It then sets the Security_HKLM_only DWORD value to 1 to enable it
- The trusted sites are then added under the following registry location:
- HKEY_LOCAL_MACHINESOFTWAREMicrosoftWindowsCurrentVersionInternet Settings
- Explicitly removing all of the trusted sites using the tool’s User-Interface will automatically disable the Security_Hklm_Only registry setting
- For Connectivity Checks, click the Run Tests button to execute a basic set of checks against the proxy configuration
- The tool will prompt to enable ADMisconfigCheck tests which will check for Active Directory related issues
- This feature requires the Cloud Connector and utilizes the Citrix Cloud APIs
- Your Citrix Cloud API client credentials will be used to execute the Citrix Cloud APIs against your cloud instance (tenant)
- Follow these steps to setup your Citrix Cloud API Client for your environment: https://developer.cloud.com/getting-started/docs/overview
- Once your API client has been established, you can use it to run the ADMisconfigCheck tests
- The tool will prompt to enable ADMisconfigCheck tests which will check for Active Directory related issues
- You can access the ADMisconfigCheck credential dialog by going to Tools à Options à ADMisconfigCheck
- The tool will then check connectivity against the following URLs:
- https://*.citrixdata.com
- https://*.sharefile.com
- https://browser-release-a.azureedge.net
- https://browser-release-b.azureedge.net
- https://agenthub.citrixworkspacesapi.net/*/ping
- https://trust.citrixworkspacesapi.net/*/ping
- https://registry.citrixworkspacesapi.net/*/ping
- https://cws.citrixworkspacesapi.net/*/ping
- https://cwsproduction.blob.core.windows.net/downloads/
- https://dl.cacerts.digicert.com/DigiCertAssuredIDRootCA.crt
- https://dl.cacerts.digicert.com/DigiCertSHA2AssuredIDCodeSigningCA.crt
- Additional Citrix cloud service sites can be enabled for testing
- Go to Tools Options à Cloud Service URLs to enable additional service URLs
- Optionally, export the existing proxy configuration to be imported in another Cloud Connector
Security Permissions Required by the tool
Admin permissions are required to set the proxy configuration (i.e., corresponding registry settings associated with the API calls made by the tool). Therefore, the tool has to be run as administrator.
Data Modified by the tool
The Cloud Connector Connectivity Check tool utilizes a registry subkey to store persistent application data, under:
HKEY_CURRENT_USERSoftwareCitrixCCProxyCheck
If Trusted Sites were added using the tool, then the registry settings described in the Add Citrix Trusted Sites section will be affected. Removing all trusted sites using the tool’s user interface will revert/remove the associated registry settings.
The tool uses the Microsoft Windows API to set the proxy configuration and trusted sites configuration – these APIs in turn may indirectly change the system registry, but the tool does not directly modify the registry outside of the locations listed above.
How to Undo the Changes Made by the tool
- Restore the intended proxy configuration with the tool before proceeding
- Use the tool’s Citrix Trusted Sites context menu (right-click on a trusted site) to remove all trusted sites
- Delete the files associated with the application
- Delete the following registry subkey:
- HKEY_CURRENT_USERSoftwareCitrixCCProxyCheck
Uninstalling
- Restore the intended proxy configuration with the tool before proceeding
- Use the tool’s Citrix Trusted Sites context menu (right-click on a trusted site) to remove all trusted sites
- Delete the files associated with the application
- Delete the following registry subkey:
- HKEY_CURRENT_USERSoftwareCitrixCCProxyCheck
Known Issues
-
This tool does not work properly for Citrix Cloud Japan
Contact Information
Questions? Concerns? Send any feedback for this tool to supporttools@citrix.com.