Site Details Test

A broker site is a top-level, logical representation of the XenDesktop site, from the perspective of the brokering services running within the site. It defines various site-wide default attributes used by the brokering services. A XenDesktop installation has only a single broker site instance.

This test promptly alerts administrators to the following anomalies related to the monitored site:

  • The sudden non-availability of the license server in the site;
  • Poor responsiveness of the license server;
  • Failure of the Citrix Broker service, Citrix Machine Creation service, and other critical services executing on the controller

Target of the test : A Citrix Delivery Controller 5.x

Agent deploying the test : An internal agent

Outputs of the test : One set of results for each catalog managed by the target XenDesktop site.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed.

Host

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

Port

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

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

License server availability

Indicates the availability of the license server in this site.

Percent

If the license server is available, a value of 100 is shown and if the license server is not available, a value of 0 is shown.

Since the license server is responsible for managing the licenses for all the components of XenDesktop, the non-availability of the license server, should have serious repercussions on the performance of the XenDesktop site. However, such adversities are averted by the 90-day grace period that XenDesktop embeds; this allows the system to function normally for 90 days if the license server becomes unavailable.

Moreover, if this measure reports that the license server is unavailable, then you may instantly want to know which license server the XenDesktop is communicating with. At this juncture, you can use the detailed diagnosis of this measure (if enabled) to ascertain the name of the license server and the port at which it listens.

Response time

Indicates the time taken by the broker to establish a connection with the license server.

Secs

Ideally, the response time should be low.

Status of Broker service on controller

Indicates the current state of the Citrix Broker service on the monitored controller.

 

 

The Citrix Broker Service brokers connections from endpoint devices to desktops and applications. This service is critical to the continuous functioning of the Delivery Controller. If this service fails or reports errors, then users may not be able to access their desktops.

This measure reports the following states while indicating the broker connection to the configured database.

  • Ok
  • DBUnconfigured
  • DBRejectedConnection
  • InvalidDBConfigured
  • DBNewerVersionThanService
  • DBOlderVersionThanService
  • DBVersionChangeInProgress
  • PendingFailure
  • Failed
  • Unknown

The table below briefly describes each of the states listed above:

State Description
Ok Indicates that the broker is connected to a valid database and the service is running.
DBUnconfigured Indicates that the broker does not possess a configured database connection.
DBRejectedConnection Indicates that the database has rejected the login credentials from the Broker Service. This may be caused by bad login credentials, or due to the database not being installed.
InvalidDBConfigured Indicates that the database schema is missing i.e., the stored procedures are missing from the database.
DBNewerVersionThanService Indicates that the version of the broker is older than the database versioSn. To access the database, upgrade the version of the broker.
DBOlderVersionThanService Indicates that the version of the database is older than the broker version. To access the database, upgrade the version of the database.
DBVersionChangeinProgress Indicates that the database schema upgrade is in progress.
PendingFailure Indicates that the connectivity between the Broker Service and the database has been lost. This may be due to a transitory network error, but may indicate a loss of connectivity that requires administrator intervention.
Failed Indicates that the connectivity between the broker and the database has been lost for an extended period of time, or the connectivity has failed due to a configuration problem. The broker service cannot operate while its connection to the database is unavailable.
Unknown Indicates that the status of the service cannot be determined.

The table below lists the numeric values that correspond to the states reported by this measure:

State Numeric Value
Ok 1
DBUnconfigured 2
DBRejectedConnection 3
InvalidDBConfigured 4
DBNewerVersionThanService 5
DBOlderVersionThanService 6
DBVersionChangeinProgress 7
Pending Failure 8
Failed 9
Unknown 10

Note:

By default, this measure reports the States listed in the table above to indicate the status of the broker’s connection with the database. However, the graph of this measure will represent States using the corresponding numeric equivalents – i.e., 1 to 10 only.

Status of Host service on controller

Indicates the current state of the Host service on the controller.

 

The Citrix Host Service creates and manages hypervisor connections via specific plugins for XenServer, ESX, and Hyper-V. If this service is unavailable, then, the broker service will not be able to access, clone, start, or stop VMs on hypervisors.

The table below lists the States reported by this measure and the numeric values that correspond to each of these states:

State Numeric Value
Ok 1
DBUnconfigured 2
DBRejectedConnection 3
InvalidDBConfigured 4
DBNewerVersionThanService 5
DBOlderVersionThanService 6
DBVersionChangeinProgress 7
Pending Failure 8
Failed 9
Unknown 10

Note:

By default, this measure reports the States listed in the table above to indicate the status of the Citrix Host service. However, the graph of this measure will represent States using the corresponding numeric equivalents – i.e., 1 to 10 only.

Status of AD Identity service on controller

Indicates the current state of the AD Identity service on the controller.

 

The AD Identity server manages Active Directory computer accounts.

The table below lists the States reported by this measure and the numeric values that correspond to each of these states:

State Numeric Value
Ok 1
DBUnconfigured 2
DBRejectedConnection 3
InvalidDBConfigured 4
DBNewerVersionThanService 5
DBOlderVersionThanService 6
DBVersionChangeinProgress 7
Pending Failure 8
Failed 9
Unknown 10

Note:

By default, this measure reports the States listed in the table above to indicate the status of the Citrix AD Identity service. However, the graph of this measure will represent States using the corresponding numeric equivalents – i.e., 1 to 10 only.

Status of Configuration service on controller

Indicates the current status of the Configuration service on the controller.

 

The Citrix Configuration Service stores global meta-data about all the other services so there is no SCP record needed in AD anymore.

The table below lists the States reported by this measure and the numeric values that correspond to each of these states:

State Numeric Value
Ok 1
DBUnconfigured 2
DBRejectedConnection 3
InvalidDBConfigured 4
DBNewerVersionThanService 5
DBOlderVersionThanService 6
DBVersionChangeinProgress 7
Pending Failure 8
Failed 9
Unknown 10

Note:

By default, this measure reports the States listed in the table above to indicate the status of the Citrix Configuration service. However, the graph of this measure will represent States using the corresponding numeric equivalents – i.e., 1 to 10 only.

Status of Machine Creation service on controller

Indicates the current state of the Machine Creation server on the controller.

 

The Citrix Machine Creation Service creates new virtual machines.

The table below lists the States reported by this measure and the numeric values that correspond to each of these states:

State Numeric Value
Ok 1
DBUnconfigured 2
DBRejectedConnection 3
InvalidDBConfigured 4
DBNewerVersionThanService 5
DBOlderVersionThanService 6
DBVersionChangeinProgress 7
Pending Failure 8
Failed 9
Unknown 10

Note:

By default, this measure reports the States listed in the table above to indicate the status of the Citrix Machine Creation service. However, the graph of this measure will represent States using the corresponding numeric equivalents – i.e., 1 to 10 only.

Status of Machine Identity service on controller

Indicates the current status of the Machine Identity service on the controller.

 

The Citrix Machine Identity Service manages the storage of virtual machines.

The table below lists the States reported by this measure and the numeric values that correspond to each of these states:

State Numeric Value
Ok 1
DBUnconfigured 2
DBRejectedConnection 3
InvalidDBConfigured 4
DBNewerVersionThanService 5
DBOlderVersionThanService 6
DBVersionChangeinProgress 7
Pending Failure 8
Failed 9
Unknown 10

Note:

By default, this measure reports the States listed in the table above to indicate the status of the Citrix Machine Identity service. However, the graph of this measure will represent States using the corresponding numeric equivalents – i.e., 1 to 10 only.

The detailed diagnosis of the License server availability measure displays the name of the License server in the site and the port at which it listens. This information enables administrators to effectively troubleshoot issues with the availability of the License server.

Figure 1 : The detailed diagnosis of the License server availability measure