Product Documentation

GetLoadIndexTrend

Jul 24, 2013

Gets the Load Evaluation Index (LEI) trend for Server OS Machines for the specified time period, limited by load index types. Each data point in the trend has the total LEI, as well as the breakdown for each load index type (CPU, Memory, Disk, Network, SessionCount).

Parameter Name Type Comments
startDate DateTime Start of the time window to be queried for the load index trend. Must be UTC.
endDate DateTime End of the time window to be queried for the load index 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.
machineFilter string Comma-separated list of machine Sids to limit the trend result to. Expects MultiSession machines.
indexTypeFilter string Comma-separated list of load index to include (effective, CPU, network, memory, disk, session count). Corresponds to the LoadIndexType enum. An empty or null string returns all.

Returns

An IQueryable of objects that contains the following for each index type specified:

Property Name Type Comments
LoadIndexType int [LoadIndexType] Corresponds to the LoadIndex type enum.
LoadIndexTrend List<TrendItem> TrendItem contains a UTC Date (DateTime) and an integer for the index.

Examples

Gets a 24-hour trend (data point every 15 minutes) of the load index trend and breakdown for the two Delivery Groups specified.

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

Gets a week-long trend (data point every 4 hours) of the load index trend and breakdown.

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