Configuration of CtxCdBrSvcTest

This test auto-discovers the critical services executing on the Citrix Cloud Delivery Controller, and reports the status of each service. With the help of this test, you can promptly detect which services have failed currently.

The default parameters associated with this test are:

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

• Specify the host for which the test is to be configured in the HOST text box.

• Indicate the port at which the host listens to in the PORT text box.

• 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.

• 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.

• If multiple components of the same component type are awaiting configuration, then an APPLY TO OTHER COMPONENTS check box will appear in this page. Clicking on this check box will allow you to apply the configuration to all/selected components of that type.

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

When changing the configuration for specific servers, a “*” beside the text box corresponding to the parameter signifies that these values have to be manually configured by the user. The parameter values that require to be configured will typically be prefixed with a “$” or contain a series of “*”. A value of "none" in the parameter value indicates that the corresponding parameter value can be changed if required.