Default Parameters for CtxCdBrokerTest

This test auto-discovers the Citrix Cloud Delivery Controllers configured within a site, and reports the current status of each controller and the count of machines registered with every controller.

This page depicts the default parameters that need to be configured for the CtxCdBrokerTest.

• The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

• 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 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 is the customer ID you need to configure the eG tests with.

  Specify the determined customer ID in the CUSTOMER ID text box.

• Proxy-related parameters are applicable only if the Citrix Cloud Connector communicates with the Citrix Cloud via a Proxy server.

  If the Proxy server requires authentication, then specify the credentials of a valid Proxy user against the PROXY USER NAME and PROXY PASSWORD text boxes. Confirm that password by retyping it in the CONFIRM PASSWORD text box. If the Proxy server does not require authentication, then specify none against the PROXY USER NAME, PROXY PASSWORD, and CONFIRM PASSWORD text boxes.

By default, the PROXY SSL flag is set to No. If the specified proxy server is SSL-enabled, then set the PROXY SSL flag to Yes.

On the other hand, if the Citrix Cloud Connector is not using a Proxy server to communicate with the Citrix Cloud, then you need not disturb the default setting of any of the Proxy-related parameters. By default, these parameters are set to none.

• 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 this test with the full path to the secureclient.csv in the SECURE CLIENT FILE PATH text box.

• Once the necessary values have been provided, clicking on the UPDATE button will register the changes made.

When changing default configurations of tests, the values with “$” indicate variables that will be replaced by the eG system according to the specific server being managed - for instance, $hostName is the host/nickname of the target host, $port is the port number of the server being monitored. E.g., for a server xyz:80, $hostName will be changed automatically by the eG manager to “xyz*” and $port will be changed to “80” when configuring a test.