Management Pack Reference Guide

Citrix SCOM Management Pack for Web Interface Reference Guide

About

Citrix Management Pack Library

Display Name Citrix Management Pack Library
Version 1.0.8.0
Description Common definitions for Citrix Management Packs.

Top

Citrix Management Pack for Web Interface

Display Name Citrix Management Pack for Web Interface
Version 1.25.20638.0
Description Provides the complete management of Citrix Web Interface servers.

Top

Citrix Management Pack for Web Interface Reports

Display Name Citrix Management Pack for Web Interface Reports
Version 1.25.20638.0
Description Provides reports for Citrix Web Interface environment.

Top


Discoveries

Target Display Name Description Enabled by default Discovery interval
Web Interface Computer Role Citrix MPWI Agent Service Discovery
Discovers Citrix Management Pack Agent for Web Interface used for monitoring Web Interface infrastructure.
Yes 3600 sec
Windows Computer Citrix Computer Discovery
Discovers managed nodes with Citrix software installed on it.
Yes 3600 sec
Windows Computer WebInterface Computer Role Discovery
Discovers managed nodes with Citrix Web Interface Server installed on it. Discovered nodes can be seen in the "Web Interface Computers" view within the "Citrix Library" folder.
Yes 14400 sec
Web Interface Computer Role Web Interface Server Discovery
Discovers Web Interface servers, sites, farms and brokers. By default all sites all discovered, but also specific sites can be included/excluded in/from discovery.

Parameters:
- Filter: filter expression must start with either INCLUDE or EXCLUDE followed by the space and list of sites separated by ';'. For example to discovery only http://somehost/Citrix/XenApp, filter must be "INCLUDE Citrix/XenApp". To include also http://somehost/Citrix/PNAgent2, filter must be "INCLUDE Citrix/XenApp;Citrix/PNAgent2". 
- FilterOnAgent: must be false if WI server is managed by multiple management groups (multihomed SCOM agent), otherwise true. 
Yes 14400 sec
Web Interface Servers Populate Web Interface Servers
Makes containment relationships between a server and the "Web Interface Servers" object.
Yes ---
Citrix Management Populate Citrix WebInterface RootObject
Makes containment relationships between the "Web Interface Servers" and the "Citrix Management" object.
Yes ---

Monitors

Citrix MPWI Agent

Citrix MPWI Agent Service State

Display Name Citrix MPWI Agent Service State
Description
Monitors the Citrix Management Pack Agent for Web Interface mandatory service.
Alert Name Citrix MPWI Agent service stopped
Alert Message
The "{0}" service on computer {1} has stopped running.
Target Citrix MPWI Agent
Enabled by default Yes

Health States
Monitor State Health State
Service is running Healthy
Service is not running Critical

Overridable parameters
Parameter Default Value
CheckStartupType true

Top

Web Interface Broker

Broker Availability - Phases Completed

Display Name Broker Availability - Phases Completed
Description
Monitors whether all phases of broker availability have completed successfully. 
Knowledge Article
Summary

This monitor checks whether broker is accessible from WebInterface perspective. Availability test is done by enumerating probing user published applications/desktops in the farm/site.

Resources on Farm/Site can be used as long as there is at least one operational broker . From a user perspective, farm/site is operational up until the point when last broker becomes unoperational. This monitor, however, gives early warning that broker should be fixed before end users would be impacted by unavailable brokers.

Alert is triggered only when Broker server is not available for specified number of consecutive samples (NumberOfSamples parameter).

Configuration

The following configuration parameters are customizable:

IntervalSeconds

The recurring interval of time in seconds in which the monitor is started (the default value is set to 300 seconds).

NumberOfSamples

Number of consecutive sample values considered before generating an alert. For example, set this parameter to 3 if alert should be generated only when Broker server is unavailable for 3 consecutive monitoring intervals.

SyncTime

The synchronization time specified by using a 24-hour format. No default value specified.

Alert Name Broker Availability - Phases Completed
Alert Message
Broker availability probing FAILED for broker "{0}".
Probing did not reach end phase.

Site URL: "{1}"
Farm: "{2}"
Broker: "{3}"

Phases:
(1) Enumeration duration: {4} ms

Status all together: "{5}"
Target Web Interface Broker
Enabled by default Yes

Health States
Monitor State Health State
StateFailed Critical
StateSuccessful Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
NumberOfSamples 2

Top

Broker Availability - Phases Completed (OBSOLETE)

Display Name Broker Availability - Phases Completed (OBSOLETE)
Description
Monitors whether all phases of broker availability have completed successfully. 
Knowledge Article
Summary

NOTE: This monitor has been made obsolete and "Broker Availability – Phases Completed" monitor should be used instead.

Alert Name Broker Availability - Phases Completed
Alert Message
Broker availability probing FAILED for broker "{0}".
Probing did not reach end phase.

Site URL: "{1}"
Farm: "{2}"
Broker: "{3}"

Phases:
(1) Enumeration duration: {4} ms

Status all together: "{5}"
Target Web Interface Broker
Enabled by default No

Health States
Monitor State Health State
StateFailed Critical
StateSuccessful Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Broker Availability Duration

Display Name Broker Availability Duration
Description
Monitors the duration of broker availability. 
Knowledge Article
Summary

This monitor checks the time needed to enumerate resources on a specific broker.

Alert is triggered only when resource enumeration takes more time than configured with the threshold for specified number of consecutive samples (NumberOfSamples parameter).

Configuration

The following configuration parameters are customizable:

IntervalSeconds

The recurring interval of time in seconds in which the monitor is started (the default value is set to 300 seconds).

NumberOfSamples

Number of consecutive sample values considered before generating an alert. For example, set this parameter to 3 if alert should be generated only when Broker server is unavailable for 3 consecutive monitoring intervals.

WarningThreshold

Warning alert threshold (the default value is set to 60000 seconds).

CriticalThreshold

Warning alert threshold (the default value is set to 300000 seconds).

SyncTime

The synchronization time specified by using a 24-hour format. No default value specified.

Alert Name Broker Availability Duration
Alert Message
Broker availability probing exceeded threshold limit with value {0} ms.

Site URL: "{1}"
Farm: "{2}"
Broker: "{3}"

Phases:
(1) Enumeration duration: {4} ms

Status all together: "{5}"
Target Web Interface Broker
Enabled by default Yes

Health States
Monitor State Health State
GreaterThanEqualCriticalThreshold Critical
GreaterThanEqualWarningThreshold Warning
LessThanWarningThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
WarningThreshold 60000
CriticalThreshold 300000
NumberOfSamples 3

Top

Broker Availability Duration (OBSOLETE)

Display Name Broker Availability Duration (OBSOLETE)
Description
Monitors the duration of broker availability. 
Knowledge Article
Summary

NOTE: This monitor has been made obsolete and "Broker Availability Duration” monitor should be used instead.

Alert Name Broker Availability Duration
Alert Message
Broker availability probing exceeded threshold limit with value {0} ms.

Site URL: "{1}"
Farm: "{2}"
Broker: "{3}"

Phases:
(1) Enumeration duration: {4} ms

Status all together: "{5}"
Target Web Interface Broker
Enabled by default No

Health States
Monitor State Health State
CriticalThreshold Critical
WarningThreshold Warning
NormalThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
ThresholdWarning 60000
ThresholdCritical 300000

Top

Web Interface Computer Role

Citrix MPWI Agent Installation

Display Name Citrix MPWI Agent Installation
Description
Monitors whether the Citrix Management Pack Agent for Web Interface is installed on a server
Knowledge Article
Summary

Alerts if the Citrix Management Pack Agent for Web Interface has not been deployed to the Web Interface server. This is very useful in situations when you are not sure whether a specific Web Interface server has been put under control of the Web Interface MP or not.

Alert Name Citrix MPWI Agent Installation
Alert Message
Citrix Management Pack Agent for Web Interface on node '{0}' is not installed!
Target Web Interface Computer Role
Enabled by default Yes

Health States
Monitor State Health State
MPWIAgentInstalled Healthy
MPWIAgentNotInstalled Warning

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Web Interface Farm

Farm Availability - Phases Completed

Display Name Farm Availability - Phases Completed
Description
Monitors whether all phases of farm availability have completed successfully. 
Knowledge Article
Summary

This monitor checks whether all phases of farm availability probing have completed successfully.

Farm availability represents end-user's experience in a context of a single farm and is divided into two phases for XenApp farms:

  • Enumeration of probing user published applications/desktops in the farm/site

  • Requesting a published application and receiving the ICA file. This is further divided into:

- Host address request (farm load balancing)

- Ticket request

For XenDesktop sites only first phase is tested.

Alert is triggered only when Farm is not available for specified number of consecutive samples (NumberOfSamples parameter).

Configuration

The following configuration parameters are customizable:

IntervalSeconds

The recurring interval of time in seconds in which the monitor is started (the default value is set to 300 seconds).

NumberOfSamples

Number of consecutive sample values considered before generating an alert. For example, set this parameter to 3 if alert should be generated only when Farm is unavailable for 3 consecutive monitoring intervals.

SyncTime

The synchronization time specified by using a 24-hour format. No default value specified.

Alert Name Farm Availability - Phases Completed
Alert Message
Farm availability probing FAILED for farm "{0}".
Probing reached phase {1} out of 2 phases.

Site URL: "{2}"
Farm: "{3}"

Server hosting {4}

Phases:
(1) Application/Desktop enumeration duration: {5} ms
(2) Application/Desktop request handling duration:
- Address Request: {6} ms
- Ticket Request: {7} ms

Status all together: "{8}"
Target Web Interface Farm
Enabled by default Yes

Health States
Monitor State Health State
StateFailed Critical
StateSuccessful Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
NumberOfSamples 2

Top

Farm Availability - Phases Completed (OBSOLETE)

Display Name Farm Availability - Phases Completed (OBSOLETE)
Description
Monitors whether all phases of farm availability have completed successfully. 
Knowledge Article
Summary

NOTE: This monitor has been made obsolete and "Farm Availability – Phases Completed" monitor should be used instead.

Alert Name Farm Availability - Phases Completed
Alert Message
Farm availability probing FAILED for farm "{0}".
Probing reached phase {1} out of 2 phases.

Site URL: "{2}"
Farm: "{3}"

Server hosting {4}

Phases:
(1) Application/Desktop enumeration duration: {5} ms
(2) Application/Desktop request handling duration:
- Address Request: {6} ms
- Ticket Request: {7} ms

Status all together: "{8}"
Target Web Interface Farm
Enabled by default No

Health States
Monitor State Health State
StateFailed Critical
StateSuccessful Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Farm Availability Duration

Display Name Farm Availability Duration
Description
Monitors the duration of farm availability.
Knowledge Article
Summary

This monitor checks the time needed to complete all farm availability probing phases.

Farm availability represents end-user's experience in a context of a single farm and is divided into two phases for XenApp farms:

  • Enumeration of probing user published applications/desktops in the farm/site

  • Requesting a published application and receiving the ICA file. This is further divided into:

- Host address request (farm load balancing)

- Ticket request

For XenDesktop sites only first phase is tested.

Alert is triggered only when farm availability probing takes more time than configured with the threshold for specified number of consecutive samples (NumberOfSamples parameter).

Configuration

The following configuration parameters are customizable:

IntervalSeconds

The recurring interval of time in seconds in which the monitor is started (the default value is set to 300 seconds).

NumberOfSamples

Number of consecutive sample values considered before generating an alert. For example, set this parameter to 3 if alert should be generated only when Farm is unavailable for 3 consecutive monitoring intervals.

WarningThreshold

Warning alert threshold (the default value is set to 90000 seconds).

CriticalThreshold

Warning alert threshold (the default value is set to 480000 seconds).

SyncTime

The synchronization time specified by using a 24-hour format. No default value specified.

Alert Name Farm Availability Duration
Alert Message
Farm availability probing exceeded threshold limit with value {0} ms.

Site URL: "{1}"
Farm: "{2}"

Server hosting {3}

Phases:
(1) Application/Desktop enumeration duration: {4} ms
(2) Application/Desktop request handling duration:
 - Address Request: {5} ms
 - Ticket Request: {6} ms

Status all together: "{7}"
Target Web Interface Farm
Enabled by default Yes

Health States
Monitor State Health State
GreaterThanEqualCriticalThreshold Critical
GreaterThanEqualWarningThreshold Warning
LessThanWarningThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
WarningThreshold 90000
CriticalThreshold 480000
NumberOfSamples 3

Top

Farm Availability Duration (OBSOLETE)

Display Name Farm Availability Duration (OBSOLETE)
Description
Monitors the duration of farm availability.
Knowledge Article
Summary

NOTE: This monitor has been made obsolete and "Farm Availability Duration” monitor should be used instead.

Alert Name Farm Availability Duration
Alert Message
Farm availability probing exceeded threshold limit with value {0} ms.

Site URL: "{1}"
Farm: "{2}"

Server hosting {3}

Phases:
(1) Application/Desktop enumeration duration: {4} ms
(2) Application/Desktop request handling duration:
 - Address Request: {5} ms
 - Ticket Request: {6} ms

Status all together: "{7}"
Target Web Interface Farm
Enabled by default No

Health States
Monitor State Health State
CriticalThreshold Critical
WarningThreshold Warning
NormalThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
ThresholdWarning 90000
ThresholdCritical 480000

Top

Web Interface Server

ASP.NET Requests Queued

Display Name ASP.NET Requests Queued
Description
Monitors the number of ASP.NET queued requests for a Web Interface Server.
Knowledge Article
Summary

This monitor checks the number of ASP.NET queued requests. In case the queue length exceeds the critical limit, requests may be rejected.

When requests waiting to be processed by ASP.NET start to increment linearly with increased client load, the WebInterface server has reached the limit of concurrent requests it can process.

To effectively monitor number of requests waiting to be processed by ASP.NET, a baseline needs to be established in the environment in order to accurately establish threshold values. In case the queue length exceeds the critical limit, requests may be rejected.

Alert is triggered only when number of ASP.NET queued requests is above threshold for specified number of consecutive samples (NumberOfSamples parameter).

Configuration

The following configuration parameters are customizable:

  • CriticalThreshold - Critical threshold value in percent. Default value is 3000.

  • IntervalSeconds - The recurring interval of time in seconds in which the monitor is started (the default value is set to 300 seconds).

  • NumberOfSamples - Number of consecutive sample values considered before generating an alert. For example set this parameter to 3 if alert should be generated only when number of ASP.NET queued requests is above threshold for 3 consecutive monitoring intervals.

  • WarningThreshold - Warning threshold value in percent. Default value is 2800.

Resolutions

Consider adding additional Web Interface servers to the load balancing in order to distribute the load across more nodes.

To see the number of queued requests, check the "Requests Queued" counter in Server Performance view.

Alert Name ASP.NET Requests Queued Too High
Alert Message
Number of ASP.NET queued requests on {0} server is above threshold.
Target Web Interface Server
Enabled by default Yes

Health States
Monitor State Health State
GreaterThanEqualCriticalThreshold Critical
GreaterThanEqualWarningThreshold Warning
LessThanWarningThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
CriticalThreshold 3000
WarningThreshold 2800
NumberOfSamples 3

Top

ASP.NET Requests Queued (OBSOLETE)

Display Name ASP.NET Requests Queued (OBSOLETE)
Description
Monitors the number of ASP.NET queued requests for a Web Interface Server.
Knowledge Article
Summary

This monitor checks the number of ASP.NET queued requests. In case the queue length exceeds the critical limit, requests may be rejected.

When requests waiting to be processed by ASP.NET start to increment linearly with increased client load, the Web Interface server has reached the limit of concurrent requests it can process.

To effectively monitor number of requests waiting to be processed by ASP.NET, a baseline needs to be established in the environment in order to accurately establish threshold values.

NOTE: This monitor has been made obsolete and "ASP.NET Requests Queued" monitor should be used instead.

Resolutions

Consider adding additional Web Interface servers to the load balancing in order to distribute the load across more nodes.

To see the number of queued requests, check the "Requests Queued" counter in Server Performance view.

Alert Name ASP.NET Requests Queued Too High
Alert Message
Number of ASP.NET queued requests on {0} server is above threshold.
Target Web Interface Server
Enabled by default No

Health States
Monitor State Health State
GreaterThanEqualCriticalThreshold Critical
GreaterThanEqualWarningThreshold Warning
LessThanWarningThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
CriticalThreshold 3000
WarningThreshold 2800

Top

ASP.NET Requests Rejected

Display Name ASP.NET Requests Rejected
Description
Monitors the number of ASP.NET rejected requests for a Web Interface Server.
Knowledge Article
Summary

The number of rejected requests (performance counter: ASP.NET\Requests Rejected) is the total number of requests not executed because because there were no sufficient server resources to process them, i.e. request queue is full. It represents the number of requests that return a 503 HTTP status code, indicating that the server is too busy. And that effectively means users could not connect to Web Interface server.

Number of rejected requests should be always 0. Alert is triggered when number of rejected requests in monitor interval is greater than or equal to the configured threshold (by default 1).

By default, alert needs to be closed manually when the issue has been addressed. By overriding “Auto-Resolve Alert” parameter, alert can be closed automatically, but the issue with requests being rejected might be overlooked.

Configuration

Examples of monitor configurations and related alerts:

Threshold

IntervalSeconds

Alert

1

300

Alert is triggered if there was at least one reject request in the last 5 min.

2

300

Alert is triggered if at least two requests were rejected in a 5 min interval.

2

600

Alert is triggered if at least two requests were rejected in a 10 min interval.

Resolutions

Requests can be rejected for many reasons. In general consider adding additional Web Interface servers to the load balancing in order to distribute the load across more nodes.

To see the number of rejected requests, check the "Requests Rejected" in Server Performance view.

Alert Name ASP.NET Requests Rejected
Alert Message
Number of ASP.NET rejected requests on {0} server is above threshold.
Target Web Interface Server
Enabled by default Yes

Health States
Monitor State Health State
LessThanCriticalThreshold Healthy
GreaterThanEqualCriticalThreshold Critical

Overridable parameters
Parameter Default Value
IntervalSeconds 300
Threshold 1
NumSamples 1

Top

IIS Worker Process Thread Count

Display Name IIS Worker Process Thread Count
Description
Monitors thread count for IIS Worker Processes on Web Interface Servers
Knowledge Article
Summary

An Internet Information Services (IIS) worker process is a windows process (w3wp.exe) which runs Web applications, and is responsible for handling requests sent to a Web Server for a specific application pool. Typically, there is more than one instance of w3wp.exe process on a Web server. Monitor checks the number of threads for w3wp process that has a maximum number of threads at the time of probe.

Alert is triggered only when number of thread count for worker process is above threshold for specified number of consecutive samples (NumberOfSamples parameter).

Configuration

The following configuration parameters are customizable

  • CriticalThreshold - Critical threshold value in percent. Default value is 55.

  • IntervalSeconds - The recurring interval of time in seconds in which the monitor is started (the default value is set to 300 seconds).

  • NumberOfSamples - Number of consecutive sample values considered before generating an alert. For example set this parameter to 3 if alert should be generated only when number of thread count for worker process is above threshold for 3 consecutive monitoring intervals.

  • SyncTime - The synchronization time specified by using a 24-hour format. No default value specified.

  • WarningThreshold - Warning threshold value in percent. Default value is 45.

Causes

The number of threads in worker process often increases when the load is too high.

Resolutions

To reduce the load, consider adding additional Web Interface servers to the load balancing in order to distribute the load across more nodes.

To see the number of threads for an IIS Worker Process, check the "Thread Count" in Server Performance view.

Alert Name IIS Worker Process Thread Count Too High
Alert Message
Number of threads for IIS Worker Process on {0} server is above threshold.
Target Web Interface Server
Enabled by default Yes

Health States
Monitor State Health State
GreaterThanEqualCriticalThreshold Critical
GreaterThanEqualWarningThreshold Warning
LessThanWarningThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
WarningThreshold 45
CriticalThreshold 55
NumberOfSamples 3

Top

IIS Worker Process Thread Count (OBSOLETE)

Display Name IIS Worker Process Thread Count (OBSOLETE)
Description
Monitors thread count for IIS Worker Processes on Web Interface Servers
Knowledge Article
Summary

An Internet Information Services (IIS) worker process is a windows process (w3wp.exe) which runs Web applications, and is responsible for handling requests sent to a Web Server for a specific application pool. Typically, there is more than one instance of w3wp.exe process on a Web server. Monitor checks the number of threads for w3wp process that has a maximum number of threads at the time of probe.

NOTE: This monitor has been made obsolete and "IIS Worker Process Thread Count" monitor should be used instead.

Causes

The number of threads in worker process often increases when the load is too high.

Resolutions

To reduce the load, consider adding additional Web Interface servers to the load balancing in order to distribute the load across more nodes.

To see the number of threads for an IIS Worker Process, check the "Thread Count" in Server Performance view.

Alert Name IIS Worker Process Thread Count Too High
Alert Message
Number of threads for IIS Worker Process on {0} server is above threshold.
Target Web Interface Server
Enabled by default No

Health States
Monitor State Health State
GreaterThanEqualCriticalThreshold Critical
GreaterThanEqualWarningThreshold Warning
LessThanWarningThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
WarningThreshold 40
CriticalThreshold 55

Top

Web Interface Site

Site Availability - Phases Completed

Display Name Site Availability - Phases Completed
Description
Monitors whether all phases of site availability have completed.
Knowledge Article
Summary

This monitor checks whether all phases of site availability have completed successfully.

Web Interface site availability represents end‐user's experience and is divided into three phases:

  • Accessing the Web Interface logon page

  • User authentication and authorization (enumeration of user's published applications/desktops across all configured farms/sites)

  • Requesting a published application and receiving the ICA file.

For XenDesktop sites only first two phases are tested.

Alert is triggered only when WebInterface site is not available for specified number of consecutive samples (NumberOfSamples parameter).

Configuration

The following configuration parameters are customizable:

IntervalSeconds

The recurring interval of time in seconds in which the monitor is started (the default value is set to 300 seconds).

NumberOfSamples

Number of consecutive sample values considered before generating an alert. For example, set this parameter to 3 if alert should be generated only when Site is unavailable for 3 consecutive monitoring intervals.

SyncTime

The synchronization time specified by using a 24-hour format. No default value specified.

Alert Name Site Availability - Phases Completed
Alert Message
Site availability probing FAILED for site "{0}". 
Probing reached phase {1} out of 3 phases.

Site Name: "{2}"
Site URL: "{3}"

Phases:
(1) Connection to the logon page: {4} ms
(2) Application/Desktop enumeration duration: {5} ms
(3) Application/Desktop load-balancing duration: {6} ms

Status all together: "{7}"
Target Web Interface Site
Enabled by default Yes

Health States
Monitor State Health State
StateFailed Critical
StateSuccessful Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
NumberOfSamples 2

Top

Site Availability - Phases Completed (OBSOLETE)

Display Name Site Availability - Phases Completed (OBSOLETE)
Description
Monitors whether all phases of site availability have completed.
Knowledge Article
Summary

NOTE: This monitor has been made obsolete and "Site Availability – Phases Completed" monitor should be used instead.

Alert Name Site Availability - Phases Completed
Alert Message
Site availability probing FAILED for site "{0}". 
Probing reached phase {1} out of 3 phases.

Site Name: "{2}"
Site URL: "{3}"

Phases:
(1) Connection to the logon page: {4} ms
(2) Application/Desktop enumeration duration: {5} ms
(3) Application/Desktop load-balancing duration: {6} ms

Status all together: "{7}"

Target Web Interface Site
Enabled by default No

Health States
Monitor State Health State
StateFailed Critical
StateSuccessful Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Site Availability Duration

Display Name Site Availability Duration
Description
Monitors the duration of Web Interface site availability. 
Knowledge Article
Summary

This monitor checks the time needed to complete all site availability probing phases.

Web Interface site availability represents end‐user's experience and is divided into three phases:

  • Accessing the Web Interface logon page

  • User authentication and authorization (enumeration of user's published applications/desktops across all configured farms/sites)

  • Requesting a published application and receiving the ICA file.

For XenDesktop sites only first two phases are tested.

Alert is triggered only when site availability probing takes more time than configured with threshold for specified number of consecutive samples (NumberOfSamples parameter).

Configuration

The following configuration parameters are customizable:

IntervalSeconds

The recurring interval of time in seconds in which the monitor is started (the default value is set to 300 seconds).

NumberOfSamples

Number of consecutive sample values considered before generating an alert. For example set this parameter to 3 if alert should be generated only when Site is unavailable for 3 consecutive monitoring intervals.

WarningThreshold

Warning alert threshold (the default value is set to 120000 seconds).

CriticalThreshold

Warning alert threshold (the default value is set to 600000 seconds).

SyncTime

The synchronization time specified by using a 24-hour format. No default value specified.

Alert Name Site Availability Duration
Alert Message
Site availability probing exceeded threshold limit with value {0} ms.

Site Name: "{1}"
Site URL: "{2}"

Phases:
(1) Connection to the logon page: {3} ms
(2) Application/Desktop enumeration duration: {4} ms
(3) Application/Desktop load-balancing duration: {5} ms

Status all together: "{6}"
Target Web Interface Site
Enabled by default Yes

Health States
Monitor State Health State
GreaterThanEqualCriticalThreshold Critical
GreaterThanEqualWarningThreshold Warning
LessThanWarningThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
WarningThreshold 120000
CriticalThreshold 600000
NumberOfSamples 3

Top

Site Availability Duration (OBSOLETE)

Display Name Site Availability Duration (OBSOLETE)
Description
Monitors the duration of Web Interface site availability. 
Knowledge Article
Summary

NOTE: This monitor has been made obsolete and "Site Availability Duration" monitor should be used instead.

Alert Name Site Availability Duration
Alert Message
Site availability probing exceeded threshold limit with value {0} ms.

Site Name: "{1}"
Site URL: "{2}"

Phases:
(1) Connection to the logon page: {3} ms
(2) Application/Desktop enumeration duration: {4} ms
(3) Application/Desktop load-balancing duration: {5} ms

Status all together: "{6}"
Target Web Interface Site
Enabled by default No

Health States
Monitor State Health State
CriticalThreshold Critical
WarningThreshold Warning
NormalThreshold Healthy

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime
ThresholdWarning 120000
ThresholdCritical 600000

Top


Rules

Web Interface Broker

Broker Availability (Performance DB DW)

Display Name Broker Availability (Performance DB DW)
Description
Collects performance data for Web Interface broker availability.
Target Web Interface Broker
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Broker Availability
Counter Name Availability

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Broker Availability Duration (Performance DB DW)

Display Name Broker Availability Duration (Performance DB DW)
Description
Collects performance data for Web Interface broker availability duration.
Target Web Interface Broker
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Broker Availability
Counter Name Duration

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Broker Availability Enumeration Time (Performance DB DW)

Display Name Broker Availability Enumeration Time (Performance DB DW)
Description
Collects performance data for Web Interface broker availability enumeration time.
Target Web Interface Broker
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Broker Availability
Counter Name Enumeration

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Broker Availability Status (Performance DB DW)

Display Name Broker Availability Status (Performance DB DW)
Description
Collects performance data for Web Interface broker availability status.
Target Web Interface Broker
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Broker Availability
Counter Name StatusID

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Web Interface Farm

Farm Availability (Performance DB DW)

Display Name Farm Availability (Performance DB DW)
Description
Collects performance data for Web Interface farm availability.
Target Web Interface Farm
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Farm Availability
Counter Name Availability

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Farm Availability Address Request (Performance DB DW)

Display Name Farm Availability Address Request (Performance DB DW)
Description
Collects performance data for Web Interface farm availability address request.
Target Web Interface Farm
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Farm Availability
Counter Name AddrRequest

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Farm Availability Duration (Performance DB DW)

Display Name Farm Availability Duration (Performance DB DW)
Description
Collects performance data for Web Interface farm availability duration.
Target Web Interface Farm
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Farm Availability
Counter Name Duration

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Farm Availability Enumeration Time (Performance DB DW)

Display Name Farm Availability Enumeration Time (Performance DB DW)
Description
Collects performance data for Web Interface farm availability enumeration time.
Target Web Interface Farm
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Farm Availability
Counter Name Enumeration

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Farm Availability Request Time (Performance DB DW)

Display Name Farm Availability Request Time (Performance DB DW)
Description
Collects performance data for Web Interface farm availability request time.
Target Web Interface Farm
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Farm Availability
Counter Name Request

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Farm Availability Status (Performance DB DW)

Display Name Farm Availability Status (Performance DB DW)
Description
Collects performance data for Web Interface farm availability status.
Target Web Interface Farm
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Farm Availability
Counter Name StatusID

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Farm Availability Ticket Request Time (Performance DB DW)

Display Name Farm Availability Ticket Request Time (Performance DB DW)
Description
Collects performance data for Web Interface farm availability ticket request.
Target Web Interface Farm
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Farm Availability
Counter Name TicketRequest

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Web Interface Server

Web Interface Application Event Log Collect - Information (Event)

Display Name Web Interface Application Event Log Collect - Information (Event)
Description
Monitors the Application event log for Web Interface specific information events.

To exclude events with specific Event IDs or Event Sources, override the "ExcludeEventIDs" or "ExcludeEventSources" parameters.
Parameters must be formatted as regex patterns. 

ExcludeEventIDs parameter override example: ^(1001)$|^(1002)$|^(1045)$
Target Web Interface Server
Enabled by default No
Category EventCollection
Generate Alert False

Overridable parameters
Parameter Default Value
ExcludeEventIDs ^.{0,0}$
ExcludeEventSources ^.{0,0}$

Top

Web Interface Application Event Log Collect - Warnings and Errors (Event)

Display Name Web Interface Application Event Log Collect - Warnings and Errors (Event)
Description
Monitors the Application event log for Web Interface specific warning and error events.

To exclude events with specific Event IDs or Event Sources, override the "ExcludeEventIDs" or "ExcludeEventSources" parameters.
Parameters must be formatted as regex patterns. 

ExcludeEventIDs parameter override example: ^(1001)$|^(1002)$|^(1045)$
Target Web Interface Server
Enabled by default Yes
Category EventCollection
Generate Alert False

Overridable parameters
Parameter Default Value
ExcludeEventIDs ^.{0,0}$
ExcludeEventSources ^.{0,0}$

Top

ASP.NET Requests Queued (Performance DB)

Display Name ASP.NET Requests Queued (Performance DB)
Description
Collects the number of ASP.NET queued requests for a Web Interface Server and stores data to OpsMgr database.
Target Web Interface Server
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name ASP.NET
Counter Name Requests Queued

Overridable parameters
Parameter Default Value
IntervalSeconds 300

Top

ASP.NET Requests Rejected (Performance DB)

Display Name ASP.NET Requests Rejected (Performance DB)
Description
Collects the number of ASP.NET rejected requests for a Web Interface Server and stores data to OpsMgr database.
Knowledge Article
Summary

Rule collects and stores the number of ASP.NET rejected requests in monitoring interval. For example, if monitoring interval is 5 minutes, then each data point represents the number of rejected requests in the last 5 minutes.

Target Web Interface Server
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name ASP.NET
Counter Name Requests Rejected

Overridable parameters
Parameter Default Value
IntervalSeconds 300

Top

IIS Worker Process Thread Count (Performance DB)

Display Name IIS Worker Process Thread Count (Performance DB)
Description
Collects thread count for IIS Worker Processes on Web Interface Servers and stores data to OpsMgr database.
Knowledge Article
Summary

Typically there is more than one instance of IIS Worker Processes (w3wp.exe) on a Web server. Rule collects and stores the number of threads for w3wp process that has maximum number of threads at the time of collection.

Target Web Interface Server
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name w3wp
Counter Name Thread Count

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Web Interface Site

Site Availability (Performance DB DW)

Display Name Site Availability (Performance DB DW)
Description
Collects performance data for Web Interface site availability.
Target Web Interface Site
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Site Availability
Counter Name Availability

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Site Availability Connection Time (Performance DB DW)

Display Name Site Availability Connection Time (Performance DB DW)
Description
Collects performance data for Web Interface site availability connection time.
Target Web Interface Site
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Site Availability
Counter Name Connection

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Site Availability Duration (Performance DB DW)

Display Name Site Availability Duration (Performance DB DW)
Description
Collects performance data for Web Interface site availability duration.
Target Web Interface Site
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Site Availability
Counter Name Duration

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Site Availability Enumeration Time (Performance DB DW)

Display Name Site Availability Enumeration Time (Performance DB DW)
Description
Collects performance data for Web Interface site availability enumeration time.
Target Web Interface Site
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Site Availability
Counter Name Enumeration

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Site Availability Request Time (Performance DB DW)

Display Name Site Availability Request Time (Performance DB DW)
Description
Collects performance data for Web Interface site availability request time.
Target Web Interface Site
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Site Availability
Counter Name Request

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top

Site Availability Status (Performance DB DW)

Display Name Site Availability Status (Performance DB DW)
Description
Collects performance data for Web Interface site availability status.
Target Web Interface Site
Enabled by default Yes
Category PerformanceCollection
Generate Alert False
Object Name Site Availability
Counter Name StatusID

Overridable parameters
Parameter Default Value
IntervalSeconds 300
SyncTime

Top


Roll-up Monitors

Target Category Display Name Roll-up Algorithm
Web Interface Computer Role
Custom
Installation WorstOf
Citrix Management
Custom
Web Interface Sites Availability Rollup WorstOf
Web Interface Sites Performance Rollup WorstOf
Web Interface Farm
AvailabilityHealth
Broker Availability Rollup BestOf
PerformanceHealth
Broker Performance Rollup BestOf
Web Interface Server
AvailabilityHealth
Sites Container Availability Rollup WorstOf
PerformanceHealth
Sites Container Performance Rollup WorstOf
Web Interface Site
AvailabilityHealth
Farm Availability Rollup WorstOf
PerformanceHealth
Farm Performance Rollup WorstOf
Web Interface Servers
AvailabilityHealth
Web Interface Server Availability Rollup WorstOf
PerformanceHealth
Web Interface Server Performance Rollup WorstOf
Web Interface Sites Container
PerformanceHealth
Site Performance Rollup WorstOf
AvailabilityHealth
Site Availability Rollup WorstOf

Top


Tasks

Target Display Name Description Parameters
Web Interface Computer Role Check Installation Prerequisites for Citrix MPWI Agent
Checks if a Citrix system meets the requirements for Citrix Management Pack Agent for Web Interface installation.

Parameters:
- AgentInstallationSource: Agent installation and configuration source is specified as either with the management server name where WebInterface MP was installed or with the UNC path where Web Interface MP Agent installation and configuration files exist. If not specified, the task tries to identify the management server automatically.
Parameter Def.value
AgentInstallationSource
Web Interface Computer Role Check Requirements and Configuration for Citrix MPWI Agent
Checks if a Citrix system meets the requirements for Citrix Management Pack Agent for Web Interface.
---
Web Interface Computer Role Collect Support Information for Citrix MPWI Agent
Collects support information for Citrix Management Pack Agent for Web Interface.
---
Web Interface Computer Role Test Web Interface Site Availability
Tests availability of all Web Interface sites, farms and XML brokers.

Parameters:
- Resource: If specified, then for request phase specified resource (application) will be used. 
- ProbeUser: By default probing is done with user account(s) configured in MPWI configuration tool. With this parameter you can override the account that will be used for probing. It must be in <domain>\<username> format and that account must be already configured in MPWI configuration tool.
Parameter Def.value
Resource
ProbeUser
Web Interface Computer Role Install Citrix MPWI Agent
Installs Citrix Management Pack Agent for Web Interface on the Citrix system.

Parameters:
- AgentInstallationSource: Agent installation and configuration source is specified as either with the management server name where WebInterface MP was installed or with the UNC path where Web Interface MP Agent installation and configuration files exist. If not specified, the task tries to identify the management server automatically.
- AgentInstallationDestination: Specify the agent installation destination folder optionally.
- UpgradeAgent: If true, then existing agent is uninstalled initially and then the new one is installed. Before the agent is upgraded, put the managed node in the maintenance during the installation.
- IgnorePrereqCheck: Do not use it. It is used only for support purposes.
Parameter Def.value
AgentInstallationSource
AgentInstallationDestination
UpgradeAgent false
IgnorePrereqCheck false
Web Interface Computer Role Uninstall Citrix MPWI Agent
Uninstalls Citrix Management Pack Agent for Web Interface from the Citrix system
---
Web Interface Computer Role Update Configuration on Citrix MPWI Agent
Updates Configuration on Citrix Management Pack Agent for Web Interface.

Parameters:
- AgentInstallationSource: Agent installation and configuration source is specified as either with the management server name where Web Interface MP was installed or with the UNC path where Web Interface MP Agent installation and configuration files exist. If not specified, the tasks tries to identify the management server automatically.
Parameter Def.value
AgentInstallationSource
Web Interface Server Check Requirements and Configuration for Citrix MPWI Agent
Checks if a Citrix system meets the requirements for MPWI Agent.
---
Web Interface Server Test Web Interface Site Availability
Tests site availability for all Web Interface sites.
Parameter Def.value
Resource
ProbeUser

Views

Folder Display Name Description Target Category
Citrix Library Citrix Management Topology
This view displays topology for all Citrix Management Packs.
Citrix Management Topology
Citrix Library Web Interface Computers
This view displays all computers with Citrix Web Interface installed including info whether MPWI agent is installed on the node and MPWI agent version. It shows also MPWI agent service health state and all alerts related to MPWI agent.
Web Interface Computer Role HealthState
Citrix Web Interface Web Interface Alerts
This view displays all active and closed alerts in Web Interface environment.
Web Interface Servers Alert
Citrix Web Interface Web Interface Events
This view displays all events forwarded from the Windows Event Log related to Citrix Web Interface.
Web Interface Server EventCollection
Citrix Web Interface Web Interface Health State
This view displays a health state of Web Interface environment (sites state, farms state, brokers state).
Web Interface Servers Status
Citrix Web Interface Web Interface Topology
This view displays the Web Interface Topology.
Web Interface Servers Topology
Citrix Web Interface->Brokers Broker Alerts
This view displays active and closed broker alerts.
Web Interface Broker Alert
Citrix Web Interface->Brokers Broker Performance
This view shows performance data for brokers (availability, enumeration time).
Web Interface Broker PerformanceCollection
Citrix Web Interface->Brokers Broker State
This view displays a health state for all brokers.
Web Interface Broker Custom
Citrix Web Interface->Farms Farm Alerts
This view displays active and closed farm alerts.
Web Interface Farm Alert
Citrix Web Interface->Farms Farm Performance
This view shows performance data for farms (availability, enumeration time, request time with address and ticket subphases, complete duration).
Web Interface Farm PerformanceCollection
Citrix Web Interface->Farms Farm State
This view displays a health state for all farms.
Web Interface Farm Custom
Citrix Web Interface->Servers Server Alerts
This view displays active and closed server alerts.
Web Interface Server MyDefaultCategory
Citrix Web Interface->Servers Server Performance
This view shows performance data for server (requests queued, requests rejected, thread count)
Web Interface Server PerformanceCollection
Citrix Web Interface->Servers Server State
This view displays a health state for all servers.
Web Interface Server MyDefaultCategory
Citrix Web Interface->Sites Site Alerts
This view displays active and closed site alerts.
Web Interface Servers Alert
Citrix Web Interface->Sites Site Performance
This view shows performance data for sites (availability, connecition time, enumeration time, request time, complete duration).
Web Interface Site PerformanceCollection
Citrix Web Interface->Sites Site State
This view displays a health state for all sites.
Web Interface Site Custom

Reports

Target Name Description
Web Interface Broker Web Interface Broker Availability (Trending)
Report predicting Web Interface broker availability.
Web Interface Broker Web Interface Broker Availability Duration (Trending)
Report predicting Web Interface broker availability duration.
Web Interface Broker Web Interface Broker Availability Enumeration (Trending)
Report predicting Web Interface broker availability enumeration.
Web Interface Farm Web Interface Farm Availability (Trending)
Report predicting Web Interface farm availability.
Web Interface Farm Web Interface Farm Availability Address Request(Trending)
Report predicting Web Interface farm availability address request.
Web Interface Farm Web Interface Farm Availability Duration (Trending)
Report predicting Web Interface farm availability duration.
Web Interface Farm Web Interface Farm Availability Enumeration (Trending)
Report predicting Web Interface farm availability enumeration.
Web Interface Farm Web Interface Farm Availability Request (Trending)
Report predicting Web Interface farm availability request.
Web Interface Farm Web Interface Farm Availability Ticket Request(Trending)
Report predicting Web Interface farm availability ticket request.
Web Interface Site Web Interface Site Availability (Trending)
Report predicting Web Interface site availability.
Web Interface Site Web Interface Site Availability Connection (Trending)
Report predicting Web Interface site availability connection.
Web Interface Site Web Interface Site Availability Duration(Trending)
Report predicting Web Interface site availability duration.
Web Interface Site Web Interface Site Availability Enumeration (Trending)
Report predicting Web Interface site availability enumeration.
Web Interface Site Web Interface Site Availability Request (Trending)
Report predicting Web Interface site availability request.

Disabled by Default

Disabled Monitors

Web Interface Broker

Monitor Management Pack
Broker Availability Duration (OBSOLETE) Citrix Management Pack for Web Interface
Broker Availability - Phases Completed (OBSOLETE) Citrix Management Pack for Web Interface

Top


Web Interface Farm

Monitor Management Pack
Farm Availability Duration (OBSOLETE) Citrix Management Pack for Web Interface
Farm Availability - Phases Completed (OBSOLETE) Citrix Management Pack for Web Interface

Top


Web Interface Server

Monitor Management Pack
ASP.NET Requests Queued (OBSOLETE) Citrix Management Pack for Web Interface
IIS Worker Process Thread Count (OBSOLETE) Citrix Management Pack for Web Interface

Top


Web Interface Site

Monitor Management Pack
Site Availability Duration (OBSOLETE) Citrix Management Pack for Web Interface
Site Availability - Phases Completed (OBSOLETE) Citrix Management Pack for Web Interface

Top


Disabled Rules

Web Interface Server

Rule Management Pack
Web Interface Application Event Log Collect - Information (Event) Citrix Management Pack for Web Interface

Top