Product Documentation

GetEffectiveLoadIndexTrend

Jul 24, 2013

Gets the Load Evaluation Index (LEI) trend for Server OS Machines for the specified time period (in minutes). Each data point represents the average load index over this interval. An IQueryable of LoadIndexTrendItems is returned, which represents the effective load index and the breakdown by individual types (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.

Returns

An IQueryable of objects that contains the following:

Property Name Type Comments
LoadIndexTrend List<LoadIndexTrendItem> LoadIndexTrendItem contains a UTC Date (DateTime) and an integer for total LEI, as well as integers for each of the LEI portions (CPU, Memory, Disk, Network, SessionCount) in a separate object (provided if $expand=Breakdown is included in the query).

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/GetEffectiveLoadIndexTrend?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'&$expand=Breakdown

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

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