Delivery Groups - Cloud Test

With the help of this test, you can determine the maintenance mode of each delivery group managed by the cloud delivery controller, and track the usage of desktops within each group. Unregistered desktops, CPU-intensive desktops, disconnected desktops, and desktops available to users, which are managed by this controller, can thus be quickly and accurately isolated.

Target of the test : Citrix Cloud Site

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each delivery group that is configured with the target 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. By default, this is 80.

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.

Report by Machine Type

By default, this flag is set to Yes indicating that the individual descriptors of this test - i.e., the delivery groups- are classified based on their machine type; in other words, the delivery groups will be listed either under Server OS Machines or Desktop OS Machines based on their machine type. If you do not want to group the delivery groups based on their machine types, set this flag to No.

Show Total Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Total machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of all machines that are part of a delivery group, as part of detailed diagnostics.

Show Available Machines DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Available machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of all machines that are currently available in each delivery group managed by the Cloud Delivery Controller.

Show High Latency Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the High latency machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the high latency machines in a delivery group.

Show High Profile Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Machines with high profile load time measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are taking too long to load profiles.

Show High CPU Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Machines with high profile load time measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details those machines in the group that are taking too long to load profiles.

Show Agent Error State Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Machines in agent error state measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are in the agent error state.

Show Disk Image Out Of Date DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Disk image out of date measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group for which the disk image is out-dated.

Show Used Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Used machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are in use presently.

Show Suspended Machines DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Machines with suspended power state measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are in a suspended power state.

Show PoweredOff Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Poweredoff machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are currently powered off.

Show Unknown Power State Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Machines with unknown power state measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that are in an unknown power state.

Show Pending Power Action DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Machines with pending power actions measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that have pending power actions.

Show Machines Under Maintenance DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for the Machines in maintenance mode measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the details of those machines in the group that have pending power actions.

Show Registered Machines DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Registered machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines (in each delivery group) that are currently registered with the broker being monitored.

Show Powered On Machines DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Powered on machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the powered on machines in each delivery group that is managed by the broker.

Show Connection Failed Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Machines with connection failed measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines with which connection has failed.

Show Deregistered Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Machines deregistered measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the deregistered machines in the group.

Show Unregistered Machines DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Unregistered machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines in the group that are not registered with the target controller.

Show Machines With Error DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Machines with errors measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines with which connection has failed.

Show Disconnected Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Disconnected machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines with which connection has failed.

Show Established Session DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Established session measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines with which connection has failed.

Show Pending Session DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Pending sessions measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the pending sessions.

Show Physical Machine DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Total physical machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the physical machines in the group.

Show Entitled Machines DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Entitled machines measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the entitled machines in the group.

Show Machines Not Entitled DD

By default, this flag is set to No. This implies that by default, detailed metrics will not be available for Machines not entitled measure of this test. To enable detailed diagnosis for this measure, you can set this flag to Yes. In this case, you will be able to view the complete details of the machines in the group that are not entitled.

Unused Machines In Days

In some environments, a few machines in the delivery groups may not be logged in by any user for long period of time. Even if users are not logged on, the machines continued to consume resources unnecessarily leading to resource wastage. The resources used by those machines cannot be released or allocated to other machines until the resources are properly released. Therefore, it is necessary for administrators to identify the machines that are not used for long period of time to avoid unnecessary resource wastage. To achieve this, administrators can use the Unused Machines In Days parameter. Administrators can specify the number of days against this parameter beyond which this test should count the machines as "unused". By default, this parameter is set to 30 days. However, administrators can override this default value depending upon their need.

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.

DD Frequency

Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD frequency.

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 delivery group available?

Indicates whether this delivery group is available or not.

This measure reports the value Yes if a delivery group is available, and reports No if it is not available.

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

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values while indicating the availability of the delivery group. However, in the graph of this measure, the same will be represented using the numeric equivalents – 1 and 0 only.

The detailed diagnosis of this measure if enabled, lists the name of the delivery group, the description, the zone to which the group belongs, the desktop kind, whether Secure ICA is required, the number of sessions supported, whether the machine needs to be shut down after use, Powered on status of the machine if user is assigned, Powered on status of the machine during peak period if user is assigned , the published name of the machine, the delivery type, and the AppDisk name.

Is delivery group in maintenance mode?

Indicates whether this delivery group is in a maintenance mode or not.

Delivery groups are typically put on maintenance mode, if the connections to the machines within the group are to be temporarily stopped so that maintenance tasks are carried out.

XenDesktop has no control over delivery groups that are in maintenance mode. No user can log on to a machine in this state.

This measure reports the value Yes if a delivery group is in the maintenance mode, and reports No if it is not. The numeric values that correspond to the above-mentioned Measure Values are as follows:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values while indicating the maintenance status of the desktop group. However, in the graph of this measure, the same will represent the maintenance modes using the numeric equivalents – 1 and 0 only.

Total machines

Indicates the total number of machines in this group.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines are part of the group.

Available machines

Indicates the number of machines in this delivery group that are available for a new user to connect to.

Number

Ideally, this value should be high. The detailed diagnosis of this measure if enabled, will reveal the complete details of the available desktops, such as, the desktop name, IP address, the desktop type, the catalog to which the desktop belongs, the hosting server on which the desktop operates, etc.

Used machines

Indicates the number of machines in this group that are currently used by users.

Number

The detailed diagnosis of this measure provides complete details of the machines in use such as the machine name, the IP address, the delivery group and catalog to which it belongs, the operating system it runs on and the version of the OS, the hypervisor to which the machine is connected, the user accessing the session, the name of the DNS server with which it communicates, and the machine type - whether Private or Shared, the name of the controller, the location of the changes made by the user, the provisioning type of the machine, the applications that are published on the machine etc.

Percentage of used machines

Indicates the percentage of machines in this group that are currently in use by users.

Percent

Ideally, the value of this measure should be low. A value close to 100% indicates that the delivery group is about to run out of free machines. Owing to the absence of unused machines, users who have been assigned to this delivery group will be denied access to the group upon login.

Moreover, high usage of a delivery group may also drain the corresponding hosting infrastructure of its physical and virtual resources.

Unused machines

Indicates the number of machines in this group that are not logged in by any user within the time period specified against the Unused Machines In Days parameter.

Number

The value of this measure should be zero. A non-zero value of this measure denotes that one or more machines are not logged in by any user for more than the days specified against the Unused Machines In Days parameter. This indicates that the resources allocated to the machines are being wasted, which may lead to resource contention if the administrators do not investigate the issue immediately.

Disconnected machines

Indicates the number of machines that are disconnected from this delivery group.

Number

The detailed diagnosis of this measure will reveal the complete details of the disconnected machines, such as, the machine name, IP address, OS type, OS version, the desktop type, the delivery group to which the machine belongs, the catalog to which the machine belongs, the hosting server on which the machine operates,the hypervisor connection, the name of the controller, location of the changes made by the user, provisioning type of this machine etc.

Machines in preparing state

Indicates the number of machines in this group that are currently preparing sessions for users.

Number

Disk image out of date

Indicates the number of machines managed by this delivery group to which updates are currently pending.

Number

Use the detailed diagnosis of this measure , if enabled, to know which machines are awaiting updates.

Machines in maintenance mode

Indicates the number of machines in this group that are currently under maintenance.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines are in maintenance mode.

Registered machines

Indicates the number of machines that are currently registered with this delivery group.

Number

Use the detailed diagnosis of this measure , if enabled, to know which machines are currently registered with the broker.

Unregistered machines

Indicates the number of machines that are configured in this delivery group but are in an unregistered state with this controller.

Number

If a machine is in an unregistered state, it means that registration has not successfully completed for that machine. The value 0 is hence desired for this measure. In case the measure reports a non-zero value, you may want to enable the detailed diagnosis for this measure, so that you can view which machines in the group are unregistered.

Machines in agent error state

Indicates the number of machines that are in an AgentError state in this delivery group.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines in the group are in the AgentError state.

Machines in initializing state

Indicates the number of machines that are not registered properly with the broker although they are configured in this delivery group.

Number

High CPU machines

Indicates the number of machines managed by this delivery group that are currently consuming CPU resources excessively.

Number

A low value is desired for this measure. Use the detailed diagnosis of this measure, if enabled, to know which machines are running CPU-intensive applications.

High latency machines

Indicates the number of machines managed by this delivery group that are currently experiencing high network latencies.

Number

A low value is desired for this measure. Use the detailed diagnosis of this measure, if enabled, to know which machines are experiencing high latencies.

Machines with high profile load time

Indicates the number of machines managed by this delivery group that are currently taking too long a time to load profiles.

Number

A low value is desired for this measure. Use the detailed diagnosis of this measure, if enabled, to know which machines are facing issues when loading profiles.

Powered on machines

Indicates the number of machines in this desktop group that are currently powered on.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines are currently powered on.

Machines with suspended power state

Indicates the number of machines in this delivery group that are currently in the Suspended state.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines are currently in the Suspended state.

Powered off machines

Indicates the number of machines in this delivery group that are currently powered off.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines are currently in the powered off.

Machines with unknown power state

Indicates the number of machines in the following power states:

  • Unavailable
  • Unmanaged
  • Unknown

Number

A low value is desired for this measure.

The detailed diagnosis of this measure, if enabled, will reveal the complete details of the unavailable machines, such as, the machine name, IP address, the machine type, the delivery group and catalog to which the machine belongs, the hosting server on which the machine operates, the name of the hypervisor and the controller on which the machine operates, the user who is active on the session, the location at which the changes made by the user is stored, the provision type of the machine, and the application published on the machine, if the machine is a XenAPP server.

Machines with pending power actions

Indicates the number of machines in this delivery group on which a power action is pending.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines have pending power actions.

Machines with connection failed

Indicates the number of machines in this group to which the last connection attempt failed.

Number

A low value is desired for this measure. Use the detailed diagnosis of this measure, if enabled, to know which machines could not be connected to.

Machines with connection failed recently

Indicates the number of machines in this group to which connection attempts failed during the last measurement period.

Number

Use the detailed diagnosis of this measure to know for which machines connection attempts failed recently.

Machines deregistered

Indicates the number of machines in this group that were the last to be deregistered from this controller.

Number

The detailed diagnosis of this measure if enabled, lists the name of the machine, IP address, OS type and version, the delivery group and catalog to which the machine belongs, the desktop kind, the hosting server on which the machine operates, the hypervisor connection, the user who is currently accessing the session, name of the controller, the location of the changes made by the user, provisioning type, the applications published on the machine if the machine is a XenAPP, the reason for deregistration of the machine and the actual time of deregistration etc.

Machines deregistered recently

Indicates the number of machines in this group that deregistered from this controller during the last measurement period.

Number

The detailed diagnosis of this measure lists the name of the machine, IP address, OS type and version, the delivery group and catalog to which the machine belongs, the desktop kind, the hosting server on which the machine operates, the hypervisor connection, the user who is currently accessing the session, name of the controller, the location of the changes made by the user, provisioning type, the applications published on the machine if the machine is a XenAPP, the reason for the machine to be deregistered from the broker, the time of deregistration etc.

Machines with errors

Indicates the number of machines on which errors were detected last.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines encountered errors.

Machines found recently with errors

Indicates the number of machines on which errors were detected during the last measurement period.

Number

Use the detailed diagnosis of this measure to know which machines encountered errors recently.

Machines available in idle state, outside peak hours

Indicates the percentage of machines in this group that should be available in idle state, outside peak hours.

Percent

The value of this measure is governed by the OffPeakBufferSizePercentand PeakHours variables. The OffPeakBufferSizePercent is set with the PowerShell cmdlet: Set-BrokerDesktopGroup ThePeakHours variable can be set using the Citrix Studio.

Depending upon when the machines in the group are used the least and how many machines are used on an average during that period, you can tweak the above-mentioned variables.

Machines available in idle state, in peak hours

Indicates the percentage of machines in this group that should be available in idle state, during peak hours.

Percent

The value of this measure is governed by the PeakBufferSizePercent and PeakHours variables. The PeakBufferSizePercent is set with the PowerShell cmdlet: Set-BrokerDesktopGroup. The PeakHours variable can be set using the Citrix Studio.

Depending upon when the machines in the group are used the maximum and how many machines are used on an average during that period, you can tweak the above-mentioned variables. The goal is to make sure that there is no loss of productivity during peak hours due to the lack of sufficient idle machines.

Total sessions

Indicates the total number of sessions currently active on this delivery group.

Number

Total applications

Indicates the total number of applications deployed on machines in this delivery group.

Number

Is added machine turned-on?

Indicates whether/not machines should be automatically powered-on when being added to this group.

The values that this measure reports and the numeric values that correspond to them are as follows:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the above-mentioned Measure Values while indicating whether/not the machines are to be powered-on when being added to this group. However, in the graph of this measure, the same will be represented using the numeric equivalents only.

Established sessions

Indicates the number of sessions that are currently established on the machines in this group.

Number

Use the detailed diagnosis of this measure, if enabled, to view the machines with established sessions.

Pending sessions

Indicates the number of user sessions that are pending or waiting to be established on the machines in this group.

Number

Use the detailed diagnosis of this measure, if enabled, to view the machines on which sessions are pending.

Entitled machines

Indicates the number of machines in this group that are currently assigned to users.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines in the group are assigned to users.

Machines not entitled

Indicates the number of machines in this group that are not assigned to users.

Number

Use the detailed diagnosis of this measure, if enabled, to know which machines in the group are not assigned to users.

Total physical machines

Indicates the number of physical machines in this group.

Number

Use the detailed diagnosis of this measure, if enabled, to know which are the physical machines in the group.

The detailed diagnosis of the Is delivery group available? measure lists the name of the delivery group, the description, the zone to which the group belongs, the desktop kind, whether Secure ICA is required, the number of sessions supported, whether the machine needs to be shut down after use, Powered on status of the machine if user is assigned, Powered on status of the machine during peak period if user is assigned , the published name of the machine, the delivery type, and the AppDisk name.

Figure 2 : The detailed diagnosis of the Is delivery group available? measure

The detailed diagnosis of the Entitled machines measure provides the complete details of machines in the group, which have been assigned to users.

Figure 3 : Detailed diagnosis of the Entitled machines measure