Zones Details - Cloud Test

Deployments that span widely-dispersed locations connected by a WAN can face challenges due to network latency and reliability. One of the means by which these challenges can be mitigated is by configuring zones. Zones can help users in remote regions connect to resources without necessarily forcing their connections to traverse large segments of the WAN. In other words, zones connect users to resources that are closest to them, keeping traffic ‘local’. Using zones allows effective Site management from a single Citrix Studio console, Citrix Director, and the Site database.

A Site always has one primary zone, which should include the central Site database and at least two Delivery Controllers. It can also optionally have one or more satellite zones, which should include one or more Controllers, StoreFront servers, and NetScaler Gateway servers.

When a Delivery Controller in a zone (primary/satellite) fails, another one in the same zone will take over. But how does an administrator determine that a failover has occurred in a primary zone? By executing this test at regular intervals, administrators can be promptly alerted if a controller in primary zone fails over to another controller in the same zone. Additionally, this test also scans each zone configured in a site and reports the number of controllers, delivery groups, and machine catalogs in that zone.

Target of the test : Citrix Cloud Site

Agent deploying the test : A remote agent

Outputs of the test : One set of results for the zone to which the managed site belongs

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.

Proxy Host, Proxy Port, Proxy User Name, Proxy Password, and Proxy SSL

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

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise suite 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 primary zone?

Indicates whether/not this is the primary zone.

The values that this measure reports and their corresponding numeric values are listed in the table below:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values to indicate whether a zone is a primary or a satellite zone. However, in the graph of this measure, the same will be represented using the numeric equivalents.

Has primary zone recently changed?

Indicates whether/not the state of the primary zone changed during the last measurement period.

This measure will report a value only if the 'Is primary zone?' measure reports the value 'Yes'.

Typically, when a controller in a primary zone fails over to another controller in the same zone in the last measure period, then this measure will report the value Yes. If no failover has occurred in the primary zone between two measure periods, then the value of this measure will be No.

The numeric values that correspond to the measure values discussed above are listed in the table below:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values to indicate whethe/not a failover has occurred in the primary zone. However, in the graph of this measure, the same will be represented using the numeric equivalents.

Total controllers

Indicates the number of controllers in this zone.

Number

Use the detailed diagnosis to know which controllers are in this zone and when each controller was last started.

Total delivery groups

Indicates the number of delivery groups in this zone.

Number

Use the detailed diagnosis of this measure to know which delivery groups are operating in this zone.

Total machine catalogs

Indicates the number of machine catalogs in this zone.

Number

Use the detailed diagnosis of this measure to identify the machine catalogs in this zone.

Total connectors

Indicates the number of Cloud connectors in this zone.

Number

Use the detailed diagnosis of this measure to identify the Cloud connectors in this zone.

The detailed diagnosis of the Total controllers measure lists the controllers in this zone, their version, their OS details, and the last start and activity time of each controller. A quick look at these details will also indicate if a failover occurred within the zone recently, and if so, which controller failed and which one took over.

Figure 2 : The detailed diagnosis of the Total controllers measure

The detailed diagnosis of the Total delivery groups measure provides the current state and configuration of every delivery group in the zone.

Figure 3 : The detailed diagnosis of the Number of delivery groups measure

The detailed diagnosis of the Total machine catalogs measure reveals the catalogs present in the zone and their complete details.

Figure 4 : The detailed diagnosis of the Total machine catalogs measure