Failed Machines - Cloud Test

Using this test, administrator can figure out how many machines of which type are currently in a state of failure. The names of these machines and the precise failure state they are in presently can also be ascertained.

Target of the test : Citrix Cloud Control Plane

Agent deploying the test : A remote agent

Outputs of the test : One set of results for each delivery group configured for the Citrix Cloud Control Plane

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 determine the customer ID that is mapped to the API client you created, refer to Determining the Customer ID Mapped to an 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 the Citrix Cloud Connectivity test with the full path to the secureclient.csv. Note: Before specifying the path of the secureclient.csv file, make sure that the API client is created and this file downloaded by a valid Citrix cloud user with Read-only administrator rights to virtual apps/desktops. To know how to create this user on the cloud, refer to theCreating a New Citrix Cloud User for Monitoring PurposestopicTo know how this user can create an API client on the cloud, refer to Creating API Client on the Citrix Cloud.
Proxy Host and Proxy Port	If the Citrix Cloud Connector communicates with the Citrix Cloud via a proxy, then, you also need to configure the eG agent on the connector with the proxy server details. This will enable the eG agent to connect to the Citrix cloud without a glitch, and pull metrics. To facilitate this communication. do the following: Specify the IP address/fully-qualified host name of the proxy server, against PROXY HOST. Specify the port at which the Proxy server listens for requests from the eG agent, against PROXY PORT. By default, both these parameters are set to none, indicating that the eG agent does not communicate with the Citrix Cloud via a proxy. Note: Before configuring these test parameters, make sure that the proxy server settings are imported to the eG agent side from the connector. To know how to achieve this, refer to Configuring the eG Agent with Proxy Server Settings. To know what values you should configure these parameters with, do the following: Login to the system hosting the Citrix Cloud Connector being monitored. Open the Internet Explorer browser on that system, and click on the icon provided at the right corner of that browser. Clicking the icon will invoke a menu. Choose Internet Optionsfrom the menu. Then, select the Connections tab in the Internet Options window that appears. Now, click the LAN Settings button. This will open the Local Area Network (LAN) Settings window. In the Proxy Server section of this window, you will find that the Use a proxy server for your LAN check box is enabled. Configure the PROXY HOST and PROXY PORT parameters with the IP address and port numbers displayed in the Address and Port text boxes (respectively) under that check box. If the Use a proxy server for your LAN check box is not enabled, then it means that the connector is not communicating with the cloud via a proxy. In this case, you need not change the default configuration for these parameters.
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.
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.
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

Machines that failed to start

Indicates the number of machines in this delivery group that failed to start.

Number

A high value for these measures is a cause for concern. Use the detailed diagnosis of each of these measures to know which machines failed to start and which ones are stuck on boot.

A machine may fail to start or get stuck on boot owing to any of the following reasons:

Cause	Description
Hypervisor Reported Failure	The hypervisor reported an error
Agent Shutdown	The VDA experienced a graceful shutdown
Agent Suspended	The VDA is in hibernation or sleep mode.
Power Off	The VDA did not shut down gracefully.

To know what action to take against each of the reasons discussed above, use the table below:

Cause	Action
Hypervisor Reported Failure	Escalate to hypervisor support team to review hypervisor settings
Agent Shutdown	Power on the VDA if it should not be off based on existing power management policies. Review any errors in the event logs.
Agent Suspended	Take the VDA out of hibernation mode if it should be active. Consider disabling hibernation for XenApp/XenDesktop VDA’s via power settings.
Power Off	If the VDA is supposed to be powered on, attempt to start the VDA within Studio and validate it boots up and registers correctly. Troubleshoot any boot or registration issues. Review the event logs on the VDA once it is back up to help determine the root cause of the shutdown. Review the hypervisor activity logs for information related to the VDA machine.

Machines stuck on boot

Indicates the number of machines that are stuck on boot.

Number

Unregistered machines

Indicates the number of machines in this delivery group that are not registered with the controller.

Number

A high value for this measure is a cause for concern. In such situations, refer to Troubleshooting Unregistered Machines to know the probable causes for this anomaly and tips for troubleshooting it.

Use the detailed diagnosis of this measure to identify the unregistered machines.

Machines with maximum load

Indicates the number of machines in this delivery group that have violated their maximum load limit.

Number

This measure applies only to Server OS Machines.

Ideally, the value of this measure should be low. If this measure reports a high value, then use the detailed diagnosis of this measure to identify the loaded machines.

To know what could have caused this problem condition, use the table below:

Cause	Description
Hypervisor Reported Failure	The hypervisor reported an error
Send settings failure	The Broker failed to send settings and configuration data to the VDA. As part of the hard registration process, the Broker gathers and sends settings and configurations to the VDA. If the Broker is able to gather the data, but is unable to send it, hard registration fails and this failure reason results.
Session Prepare Failure	The Broker failed to notify the VDA to prepare to host a session. When a user requests a connection to a VDA and the VDA is hard registered, the broker notifies the VDA to prepare to be contacted by a receiver instance. If the call fails, the VDA is forcibly deregistered, resulting in this failure.
Session Audit Failure	The broker failed to complete an audit of the sessions that are running on the VDA.

Machines that failed to start recently

Indicates the number of machines that failed to start during the last measurement period.

Number

Use the detailed diagnosis of this measure to identify the machines that failed to start in the recent past. For the reasons for this failure and how to fix it, refer to the Interpretation for the Machines that failed to start measure.

Machines stuck on boot recently

Indicates the number of machines that stuck on boot during the last measurement period.

Number

Use the detailed diagnosis of this measure to identify the machines that stuck on boot in the recent past. For the reasons for this failure and how to fix it, refer to the Interpretation for the Machines stuck on boot measure.

Recently unregistered machines

Indicates the number of machines that were not registered with the controller during the last measurement period.

Number

Use the detailed diagnosis of this measure to identify the machines that were not registered with the controller in the recent past. For the reasons for this failure and how to fix it, refer to Troubleshooting Unregistered Machines.

Machines that reached maximum load recently

Indicates the number of machines that violated their maximum load limit during the last measurement period.

Number

Use the detailed diagnosis of this measure to identify the loaded machines in the recent past.