Product Documentation

GetMachineFailureTrend

Jul 03, 2014

Gets the concurrent machine failure trend for the specified time period. Each data point in the trend represents the maximum number of failed machines at any point in the last interval (intervalLength parameter). Provides ability to specify a particular machine failure type to limit the query or get all failure types.

Parameter Name Type Comments
startDate DateTime Start of the time window to be queried for the connection failure trend. Must be UTC.
endDate DateTime End of the time window to be queried for the connection failure trend. Must be UTC.
intervalLength int Interval between data points in minutes for the trend.
desktopGroupsFilter string Comma-separated list of Delivery Group Uids to limit the trend result to.
machineFailureTypeFilter string Comma-separated list of connection failure type integers to limit the trend result to. This integer corresponds to MachineFaultStateCode enum. If not provided, returns all types aggregated in the trend.
sessionSupportFilter int Comma-separated list of machine types integers (Single=1, Multiple=2, Unknown=0) to limit the trend result to. No value returns all types

Returns

A list of TrendItem objects (FailureTrend).

Property Name Type Comments
FailureTrend List<TrendItem> TrendItem contains a UTC Date (DateTime) and a Count (int) of failures to indicate the trend of machine failures over the specified time period for the filters specified.

Example

Gets a 24-hour trend (data point every 15 minutes) for all types of machine failures for the two Delivery Groups specified with Desktop OS Machine types.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=15&sessionSupportFilter='1'&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

Gets a 24-hour trend (data point every 2 hours) for all Delivery Groups, all Session Types, and for machine failures of type "Failed to Start" and "Stuck on Boot".

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrend?startDate=datetime'2011-09-23T00:00:00'&endDate=datetime'2011-10-01T00:00:00'intervalLength=240&machineFailureTypeFilter='2,3'