My Services - Cloud Test

Citrix Cloud can connect to resources through connectors on on-premises or public/ private/hybrid cloud infrastructure and can provision multiple Citrix Services to the Citrix Cloud Site. These Citrix Services allow administrators to create, manage, secure, and deploy workspaces with applications and data to end users. Moreover, analytics provided by these services bring the factors that impact user experience and performance, including session logon duration, responsiveness, availability and resiliency to light. All Citrix Services are licensed and can be utilized within a subscription period mentioned in the licenses. If any service suddenly expires or is not updated before the subscription period ends, then the users will be deprived of access to the applications/data offered by that particular service. Furthermore, administrators will not be able to quantify the user experience and determine which factors are impacting the user experince and application performance. To avoid such inconveniences, administrators are required to continuously monitor the Citrix Services on the target cloud site and constantly keep a vigil on the validity of service licenses. This is where the My Services - Cloud test helps!

For each Citrix Service on the target Citrix Cloud Site, the test reports whether/not the service is expired and the count of days within which the service is likely to expire. Based on these insights, you can determine which service's license is to be replenished quickly to ensure continuous service delivery. In addition, this test also reveals the count of instances of each service running on the target cloud.

Target of the test : A Citrix Cloud Site

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each service on the target Citrix Cloud Site.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed.

Host

The IP address of the host for which this test is to be configured.

Port

Refers to the port at which the specified host listens to.

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

Secure Client File Path

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

Note:

Before specifying the path of the secureclient.csv file, make sure that the file is downloaded by a valid Citrix cloud user with rights to access the cloud and pull metrics on critical cloud components. To know why such a user is needed and how to create this user on the cloud, refer to theHow Does eG Enterprise Monitor the Citrix Cloud Site?topic

Proxy Host

If the eG agent communicates with the Citrix Cloud via a proxy, then specify the IP address/fully-qualified host name of the proxy server here. By default, this is set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy.

Proxy Port

If the eG agent communicates with the Citrix Cloud via a proxy, then specify the port at which the proxy server listens for requests from the eG agent. By default, this is set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy.

Region Endpoint

By default, US is chosen from this list indicating that this test will report metrics for those organizations whose users and resources are located in the United States region. Sometimes, the eG agent may collect the required metrics with a minor time delay due to the users and resources being monitored are in a different region. To avoid such time delays and to ensure end-user proximity and offer the best user experience, administrators are allowed to change the region based on where most of the users and resources are located. For instance, if the users and resources are located in the Asia-Pacific South region or approximately nearer to the Asia-Pacific South region, then, administrators need to choose 'AP-S' from this list. However, from this list, administrators are required to choose only the region that they had chosen when they signed in for the first time after onboarding their organization to the target Citrix Cloud.

Max Expiry Days

Specify the maximum time period in days during which this test should report the expiry details of the Citrix Services offered by the target cloud site. By default, this is set to 10000 days.

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.

The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

  • The eG manager license should allow the detailed diagnosis capability
  • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

Is service expired?

Indicates whether/not this service's license is expired.

 

The numeric values that correspond to the above-mentioned measure values are as follows:

Measure Value Numeric Value
No 0
Yes 1

Note:

By default, this measure reports the above-mentioned Measure Values while indicating whether the license is expired or not. However, in the graph of this measure, the same will be represented using the numeric equivalents.

Use the detailed diagnosis of this measure to know the name, state and type of each service, the number of instances of each service and the count of days within which each service will expire.

Days to expire

Indicates the number of days within which this service's licenses will expire.

Days

Lower the value of this measure, sooner a service's licenses will expire.

If this value is very low, it implies that license will expire very soon. To continue using the service, you will have to renew the license.

Use the detailed diagnosis of this measure to know the name, state and type of each service, the number of instances of each service and the count of days within which each service will expire.

Quantity

Indicates the number of instances of this service on the target cloud site.

Number