Product Documentation

Métodos

Nov 11, 2015

Los temas siguientes describen los métodos que expone la API. Se describe cada método, además de los parámetros proporcionados y lo que devuelve la llamada de la API. También aparecen consultas de ejemplo.

Para obtener más información sobre cómo especificar intervalos de tiempo, consulte Acerca de los intervalos de fecha y hora. Para obtener más información acerca de los valores devueltos por la API de Monitor Service OData, consulte Determinación de los valores de enumeración.

GetAverageLogOnBreakdown

Obtiene el promedio de duración de los inicios de sesión durante el período de tiempo especificado, el Id. de usuario y desktopGroupUid.

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo del promedio que se debe obtener. Debe ser UTC DateTime.
endDate DateTime Fin de la ventana de tiempo del promedio que se debe obtener. Debe ser UTC DateTime.
userSid Cadena SID de usuario al que limitar el promedio.
desktopGroupUid GUID UID de grupo de escritorios al que limitar el promedio.

Devuelve

Un IQueryable de objetos LogOnBreakdown que contiene la siguiente información para cada paso del inicio de sesión:

Nombre de propiedad Tipo Comentarios
LogonStepItems List<LogOnStepItem> Lista de LogOnStepItems. Cada LogonStepItem tiene LogonStep (los valores pueden ser Brokering=1, VMStart=2, HDX=3, Authentication=4, Gpos=5, LogonScripts=6, ProfileLoad=7, Interactive=8, Total=0) y Duration (Nullable<double>) en milisegundos. Si no hay datos disponibles para el paso, el valor de Duration es null.
BreakdownType int Tipo de desglose. UsersLastSession=1, UsersSessionAverage=2, DesktopGroupAverage=3
Nota: La duración de HDX es un nuevo indicador que requiere cambios en el protocolo ICA. Esto significa que, si la nueva versión del cliente no se está utilizando, las métricas devueltas son NULL.

Ejemplo

Obtiene el promedio de duración de los inicios de sesión del 15 de marzo, este Id. de usuario y desktopGroupUid.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetAverageLogOnBreakdown?startDate=datetime'2012-03-15T00:00:00'&endDate=datetime'2012-03-30T00:00:00'&userSid='User%20Sid'&desktopGroupUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&$expand=LogOnStepItems

GetAverageLogOnDuration

Obtiene el promedio de las tendencias de duración de los inicios de sesión durante el período de tiempo especificado. Solo incluye los inicios de sesión que se han completado correctamente (que tienen un LogOnStartDate y un LogOnEndDate en la base de datos).

Nombre del parámetro Tipo Comentarios
start DateTime Inicio de la ventana de tiempo que se va a consultar del promedio de las tendencias de duración de los inicios de sesión. Debe ser UTC.
end DateTime Fin de la ventana de tiempo que se va a consultar de la tendencia de los fallos de conexión. Debe ser UTC.

Devuelve

Un valor "Double" que representa el promedio de duración de los inicios de sesión durante el período de tiempo especificado.

Ejemplo

Obtiene el promedio de duración de los inicios de sesión por hora especificada para todos los grupos de entrega.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetAverageLogOnDuration?start=datetime'2012-06-05T12:24:00'&end=datetime'2012-06-05T13:24:00'

GetConcurrentSessionsTrend

Obtiene los puntos de datos para representar una tendencia de las sesiones simultáneas en forma de lista de pares de DateTime/Value durante el período de tiempo especificado. Cada punto representa el número máximo de sesiones simultáneas en el intervalo especificado. El último punto que hay en la tendencia puede representar el número de usuarios actuales en el sistema.

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar de las sesiones simultáneas. Debe ser UTC. Fecha incluida.
endDate DateTime Fin de la ventana de tiempo que se va a consultar de las sesiones simultáneas. Debe ser UTC. Fecha incluida.
intervalLength int Intervalo entre puntos de datos en minutos de la tendencia.

Devuelve

Lista de IQueryable de objetos TrendItem - IQueryable<TrendItem> ordenada por fecha en orden ascendente.

Cada TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Value ("Double") para representar la tendencia.

Ejemplo

Obtiene una tendencia por hora (punto de datos cada minuto) de las sesiones simultáneas:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConcurrentSessionsTrend?startDate=datetime'2012-06-05T12:26:00'&endDate=datetime'2012-06-05T13:26:00'&intervalLength=1

GetConnectedUsersTrend

Obtiene la tendencia de los usuarios conectados de máquinas con sistema operativo de servidor en el período de tiempo especificado. Cada punto de datos de la tendencia contiene el número total de usuarios conectados a las máquinas con sistema operativo de servidor durante el último intervalo (intervalLength).

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar de la tendencia de los usuarios conectados. Debe ser UTC.
endDate DateTime Fin de la ventana de tiempo que se va a consultar de la tendencia de los usuarios conectados. Debe ser UTC.
intervalLength int Intervalo entre puntos de datos en minutos de la tendencia.
desktopGroupsFilter string Lista separada por comas de UID de grupos de entrega a los que limitar el resultado de la tendencia.
machineFilter string Lista separada por comas de SID de máquinas a los que limitar el resultado de la tendencia.

Devuelve

Un IQueryable de objetos que contiene la siguiente información:

Nombre de propiedad Tipo Comentarios
ConnectedUsersTrend List<TrendItem> TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Count (int) del número máximo de usuarios conectados en el intervalo.

Ejemplos

Obtiene una tendencia de 24 horas (un punto de datos cada 15 minutos) de la tendencia de los usuarios conectados de los dos grupos de entrega especificados.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectedUsersTrend?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'

Obtiene una tendencia una semana (un punto de datos cada 4 horas) de los usuarios conectados.

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

GetConnectionFailureTrend

Obtiene la tendencia de los fallos de conexión durante el período de tiempo especificado. Cada punto de datos de la tendencia representa el número total de fallos de conexión en el último intervalo (parámetro intervalLength).

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar de la tendencia de los fallos de conexión. Debe ser UTC.
endDate DateTime Fin de la ventana de tiempo que se va a consultar de la tendencia de los fallos de conexión. Debe ser UTC.
intervalLength int Intervalo entre puntos de datos en minutos de la tendencia.
desktopGroupsFilter string Lista separada por comas de UID de grupos de entrega a los que limitar el resultado de la tendencia.
connectionFailureTypeFilter string Lista separada por comas de enteros de los tipos de fallos de conexión a los que limitar el resultado de la tendencia. Este número entero corresponde a la enumeración ConnectionFailureType.
sessionSupportFilter string Lista separada por comas de enteros de los tipos de máquina (Única=1, Múltiple=2, Desconocido=0) a los que limitar el resultado de la tendencia. Si no hay ningún valor, devuelve los dos tipos.

Devuelve

Un IQueryable de objetos TrendItem

Nombre de propiedad Tipo Comentarios
FailureTrend List<TrendItem> TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Count (int) de los fallos para indicar la tendencia de los fallos de conexión durante el período de tiempo especificado para los filtros especificados.

Ejemplos

Obtiene una tendencia de 24 horas (un punto de datos cada 15 minutos) de todos los tipos de fallos de conexión de los dos grupos de entrega especificados con los tipos de máquina con sistema operativo de escritorio.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrend?startdate=datetime'2011-09-30T00:00:00'&enddate=datetime'2011-10-

Obtiene una tendencia de una semana (un punto de datos cada 4 horas) de 3 tipos de fallos de conexión (que se han agregado) de todos los grupos de entrega a los que tiene acceso el usuario.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrend?startdate=datetime'2011-09-23T00:00:00'&enddate=datetime'2011-10-01T00:00:00'intervalLength=240&connectionFailureTypeFilter='2,3,4'

GetConnectionFailureTrendsByType

Obtiene una lista de recuentos de fallos de conexión por tipo, junto con una tendencia para cada tipo, durante el período de tiempo especificado. Cada punto de datos de la tendencia representa el número total de fallos de conexión en el último intervalo (parámetro intervalLength). Permite especificar un determinado tipo de fallo para limitar la consulta u obtener todos los tipos de fallo.

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar de la tendencia de los fallos de conexión. Debe ser UTC.
endDate DateTime Fin de la ventana de tiempo que se va a consultar de la tendencia de los fallos de conexión. Debe ser UTC.
intervalLength Int Intervalo entre puntos de datos en minutos de la tendencia.
connectionFailureType Int [ConnectionFailureType] Si se proporciona (>0), devuelve solo ese tipo de fallo de conexión en los resultados. De lo contrario (null o cero), devuelve una lista de todos los tipos de fallo. Este número entero corresponde a la enumeración ConnectionFailureType.

Devuelve

Un IQueryable de objetos ConnectionFailureTrend que contiene la siguiente información para cada ConnectionFailureType.

Si se solicitan todos los tipos, la suma también se devuelve con ConnectionFailureType=-1.

Si $expand=FailureTrend se incluye en la consulta, la tendencia y las propiedades TotalFailureCount se recuperan para cada tipo de fallo.

Si $expand=DesktopGroupBreakdown se incluye en la consulta, esa propiedad también se recupera para cada tipo de fallo.

Nombre de propiedad Tipo Comentarios
ConnectionFailureType int [ConnectionFailureType] Tipo de fallo de conexión (de una enumeración ConnectionFailureType).
FailureTrend List<TrendItem> TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Value ("Double" que acepta valores null) para indicar la tendencia de los fallos de conexión durante el período de tiempo especificado de este tipo de fallo.
TotalFailureCount int Número total de fallos durante el período de tiempo especificado.
DesktopGroupBreakdown List<DesktopGroupBreakdown> DesktopGroupBreakdown contiene un objeto DesktopGroup (debe incluirse en la expansión para que se devuelva) y una propiedad Count (int) para representar el número total de fallos en la ventana de tiempo especificada.

Ejemplos

Recuperar la tendencia de fallos y desglose de los grupos de entrega de todos los tipos de fallo desde el 14 de noviembre a las 5:00 h (UTC) hasta el 14 de noviembre a las 7:00 h (UTC) con un punto de datos cada 30 minutos:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&intervalLength=30&connectionFailureType=0&$expand=FailureTrend,DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Recuperar el desglose de los grupos de entrega solo del tipo de fallo n.º 4 (Capacidad no disponible) desde el 14 de noviembre a las 5:00 h (UTC) hasta el 14 de noviembre a las 7:00 h (UTC):

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&connectionFailureType=4&$expand=DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Recuperar la tendencia de los fallos de todos los tipos de fallo desde el 14 de noviembre a las 0:00 h (UTC) hasta el 14 de noviembre a las 23:00 h (UTC) con un punto de datos cada hora:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByType?startDate=datetime'2011-11-14T00:00:00'&endDate=datetime'2011-11-14T23:00:00'&intervalLength=60&connectionFailureType=0&$expand=FailureTrend

GetConnectionFailureTrendsByTypeLatest

Actualizado: 11-11-2013

Obtiene una lista de recuentos de fallos de conexión por tipo, junto con una tendencia para cada tipo, del número de intervalos especificado desde ahora (hora UTC del servidor). Cada punto de datos de la tendencia representa el número total de fallos de conexión en el último intervalo (parámetro intervalLength). Permite especificar un determinado tipo de fallo para limitar la consulta u obtener todos los tipos de fallo.

Nombre del parámetro Tipo Comentarios
intervalLength int Intervalo entre puntos de datos en minutos de la tendencia.
numberOfIntervals int Número de puntos de datos solicitados. Se usa con intervalLength para calcular StartDate.
connectionFailureType int [ConnectionFailureType] Si se proporciona (>0), devuelve solo ese tipo de fallo de conexión en los resultados. De lo contrario (null o cero), devuelve una lista de todos los tipos de fallo. Este número entero corresponde a la enumeración ConnectionFailureType.

Devuelve:

Un IQueryable de objetos ConnectionFailureTrend que contiene la siguiente información para cada ConnectionFailureType.

Si se solicitan todos los tipos, la suma también se devuelve con ConnectionFailureType=-1.

Si $expand=FailureTrend se incluye en la consulta, la tendencia y las propiedades TotalFailureCount se recuperan para cada tipo de fallo.

Si $expand=DesktopGroupBreakdown se incluye en la consulta, esa propiedad también se recupera para cada tipo de fallo.

Nombre de propiedad Tipo Comentarios
ConnectionFailureType int [ConnectionFailureType] Tipo de fallo de conexión (de una enumeración ConnectionFailureType).
FailureTrend List<TrendItem> TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Value ("Double" que acepta valores null) para indicar la tendencia de los fallos de conexión durante el período de tiempo especificado de este tipo de fallo.
TotalFailureCount int Número total de fallos durante el período de tiempo especificado.
DesktopGroupBreakdown List<DesktopGroupBreakdown> DesktopGroupBreakdown contiene un objeto DesktopGroup (debe incluirse en la expansión para que se devuelva) y una propiedad Count (int) para representar el número total de fallos en la ventana de tiempo especificada.

Ejemplos

Recuperar la tendencia de fallos y desglose de los grupos de entrega de los últimos 60 minutos con un punto de datos cada minuto:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByTypeLatest?&intervalLength=1&numberOfIntervals=60&connectionFailureType=0&$expand=FailureTrend,DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Recuperar el desglose de los grupos de entrega solo del tipo de fallo n.º 4 (Capacidad no disponible) de los últimos 30 minutos:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByTypeLatest?&intervalLength=1&numberOfIntervals=30&connectionFailureType=4&$expand=DesktopGroupBreakdown,DesktopGroupBreakdown\DesktopGroup

Recuperar la tendencia de fallos de todos los tipos de fallo durante las últimas 24 horas con un punto de datos cada hora:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetConnectionFailureTrendsByTypeLatest?&intervalLength=60&numberOfIntervals=24&connectionFailureType=0&$expand=FailureTrend

GetLastSessionLogOnBreakdown

Obtiene el desglose de inicios de sesión de los usuarios y de los grupos de entrega. Devuelve la sesión de usuario actual, si existe.

Nombre del parámetro Tipo ¿Es necesaria? Comentarios
userSid Cadena El Id. del usuario para el que se solicita la información.
desktopGroupUid GUID Grupo de entrega que se consulta.
machineUid Cadena No La máquina en la que se ejecutó la última sesión. Esto puede no estar disponible.

Devuelve

Un IQueryable de objetos LogOnBreakdown que contiene la siguiente información para cada paso del inicio de sesión:

Nombre de propiedad Tipo Comentarios
LogonStepItems List<LogOnStepItem> Lista de LogOnStepItems. Cada LogonStepItem tiene LogonStep (los valores pueden ser Brokering=1, VMStart=2, HDX=3, Authentication=4, Gpos=5, LogonScripts=6, ProfileLoad=7, Interactive=8, Total=0) y Duration (Nullable<double>) en milisegundos. Si no hay datos disponibles para el paso, el valor de Duration es null.
BreakdownType int Tipo de desglose: UsersLastSession=1, UsersSessionAverage=2, DesktopGroupAverage=3

Ejemplo

Obtener el desglose de los inicios de sesión de los usuarios y de los grupos de entrega. Devuelve la sesión de usuario actual, si existe.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLastSessionLogOnBreakdown?userSid='User%20Sid'&desktopGroupUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&machineUid=guid'28D15C1F-7D4C-43BC-BAF2-5886D8514642'&$expand=LogOnStepItems

GetEffectiveLoadIndexTrend

Obtiene la tendencia del índice de evaluación de carga (LEI) de máquinas con sistema operativo de servidor durante el período de tiempo especificado (en minutos). Cada punto de datos representa el índice de carga medio en este intervalo. Se devuelve un IQueryable de LoadIndexTrendItems, el cual representa el índice de carga efectivo y el desglose por tipos individuales (CPU, Memory, Disk, Network, SessionCount).

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar para la tendencia del índice de carga. Debe ser UTC.
endDate DateTime Fin de la ventana de tiempo que se va a consultar para la tendencia del índice de carga. Debe ser UTC.
intervalLength int Intervalo entre puntos de datos en minutos de la tendencia.
desktopGroupsFilter string Lista separada por comas de UID de grupos de entrega a los que limitar el resultado de la tendencia.
machineFilter string Lista separada por comas de SID de máquinas a los que limitar el resultado de la tendencia. Espera máquinas MultiSession.

Devuelve

Un IQueryable de objetos que contiene la siguiente información:

Nombre de propiedad Tipo Comentarios
LoadIndexTrend List<LoadIndexTrendItem> LoadIndexTrendItem contiene una propiedad UTC Date (DateTime) y un número entero para el LEI total, así como enteros para cada una de las partes del LEI (CPU, Memory, Disk, Network, SessionCount) en un objeto independiente (proporcionados si $expand=Breakdown se incluye en la consulta).

Ejemplos

Obtiene una tendencia de 24 horas (un punto de datos cada 15 minutos) de la tendencia y el desglose del índice de carga de los dos grupos de entrega especificados.

 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

Obtiene una tendencia de una semana (un punto de datos cada 4 horas) del índice de carga.

 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

GetLoadIndexTrend

Actualizado: 24-07-2013

Obtiene la tendencia del índice de evaluación de carga (LEI) de las máquinas con sistema operativo de servidor durante el período de tiempo especificado, limitado por los tipos de índice de carga. Cada punto de datos de la tendencia contiene el LEI total, así como el desglose para cada tipo de índice de carga (CPU, Memory, Disk, Network, SessionCount).

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar para la tendencia del índice de carga. Debe ser UTC.
endDate DateTime Fin de la ventana de tiempo que se va a consultar para la tendencia del índice de carga. Debe ser UTC.
intervalLength int Intervalo en minutos entre puntos de datos de la tendencia
desktopGroupsFilter string Lista separada por comas de UID de grupos de entrega a los que limitar el resultado de la tendencia.
machineFilter string Lista separada por comas de SID de máquinas a los que limitar el resultado de la tendencia. Espera máquinas MultiSession.
indexTypeFilter string Lista separada por comas de los índices de carga que incluir (effective, CPU, network, memory, disk, session count). Corresponde a la enumeración LoadIndexType. Una cadena vacía o null devuelve todos.

Devuelve

Un IQueryable de objetos que contiene la siguiente información para cada tipo de índice especificado:

Nombre de propiedad Tipo Comentarios
LoadIndexType int [LoadIndexType] Corresponde a la enumeración tipo LoadIndex.
LoadIndexTrend List<TrendItem> TrendItem contiene una propiedad UTC Date (DateTime) y un número entero para el índice.

Ejemplos

Obtiene una tendencia de 24 horas (un punto de datos cada 15 minutos) de la tendencia y el desglose del índice de carga de los dos grupos de entrega especificados.

 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'

Obtiene una tendencia de una semana (un punto de datos cada 4 horas) y un desglose del índice de carga.

 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

GetLogOnCountTrend

Obtiene la tendencia media de la duración de los inicios de sesión agrupada por un intervalo (TimeOfDay, DayOfWeek, etc.) durante el período de tiempo especificado. Solo incluye los inicios de sesión que se han completado correctamente (que tienen un LogOnStartDate y un LogOnEndDate en la base de datos).

Nombre del parámetroTipoComentarios
startDateTimeInicio de la ventana de tiempo que se va a consultar para la tendencia media de la duración de los inicios de sesión . Debe ser UTC.
endDateTimeFin de la ventana de tiempo que se va a consultar para la tendencia de la duración de los inicios de sesión . Debe ser UTC.
intervalLengthintIntervalo entre puntos de datos en minutos de la tendencia.

Devuelve

Un IQueryable de objetos TrendItem. TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Value para indicar la tendencia media de los recuentos de los inicios de sesión entre el inicio y la finalización de un período de tiempo especificado.

Ejemplo

Obtiene una hora de datos, un único punto de datos por minuto que representa el número total de inicios de sesión de ese minuto. Si no hay inicios de sesión durante ese minuto, el valor de TrendItem es cero.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnCountTrend?startDate=datetime'2012-06-05T12:24:00'&endDate=datetime'2012-06-05T13:24:00'&intervalLength=1

GetLogOnCountTrendFiltered

Obtiene la tendencia de los recuentos de inicios de sesión durante el período de tiempo especificado. Cada punto de datos de la tendencia representa el número total de inicios de sesión en el último intervalo (intervalLength). Solo incluye los inicios de sesión que se han completado correctamente (que tienen un LogOnStartDate y un LogOnEndDate en la base de datos).

Nombre del parámetroTipoComentarios
startDateDateTimeInicio de la ventana de tiempo que se va a consultar para la tendencia de recuento de los inicios de sesión . Debe ser UTC.
endDateDateTimeFin de la ventana de tiempo que se va a consultar para la tendencia de la duración de los inicios de sesión . Debe ser UTC.
intervalLengthintIntervalo entre puntos de datos en minutos de la tendencia.
desktopGroupsFilterstringLista separada por comas de UID de grupos de escritorios a los que limitar el resultado de la tendencia.

Devuelve

Una lista de TrendItems:

Nombre de propiedadTipoComentarios
LogonCountTrendList<TrendItem>LogonDurationTrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Count (int) para representar el número de inicios de sesión de la fecha.

Ejemplo

Obtiene una tendencia de 24 horas (punto de datos cada 15 minutos) para la tendencia de recuentos de inicios de sesión (en milisegundos) referente a los dos grupos de entrega especificados.

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

Obtiene una tendencia de una semana (un punto de datos cada 4 horas) de la tendencia de duración (en milisegundos) de inicios de sesión .

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

GetLogOnDurationAverageTrend

Obtiene la tendencia media de la duración de los inicios de sesión de la ventana de tiempo especificada, con medias agrupadas por el intervalo especificado. Cada punto de datos de la tendencia tiene una duración y un desglose de inicios de sesión medios para cada intervalo en el parámetro groupByInterval.

Nombre del parámetro Tipo Comentarios
start DateTime Inicio de la ventana de tiempo que se va a consultar de la tendencia de la duración de los inicios de sesión. Debe ser UTC.
end DateTime Fin de la ventana de tiempo que se va a consultar de la tendencia de la duración de los inicios de sesión. Debe ser UTC.
groupByInterval int Cómo se presentan las medias. Opciones: TimeOfDay=1, DayOfWeek=2, Month=3, Year=4. Requerido.
desktopGroupsFilter string Lista separada por comas de UID de grupos de entrega a los que limitar el resultado de la tendencia.

Devuelve

Una lista de GroupedLogOnDurationTrendItem.

Nombre de propiedad Tipo Comentarios
GroupByDate int Representa el grupo por fecha (4=4:00 h, 2007=año 2007 en función de la entrada del parámetro groupByInterval).

Número de puntos devueltos:

GroupByInterval=TimeOfDay (1): 24 puntos (0-23)

0=0:00 h, 1=1:00 h, 2=2:00 h... 23=23:00 h

GroupByInterval=DayOfWeek (2): 7 puntos (0-6)

0=domingo, 1=lunes... 6=sábado

GroupByInterval=Month (3): 12 puntos (0-11)

0=enero, 1=febrero... 11=diciembre

GroupByInterval=Year (4): independientemente de todos los años que se incluyan en el intervalo startDate/endDate.

Orden de puntos. Los datos siempre se devuelven ordenados por el parámetro GroupByDate, independientemente de las fechas de inicio y finalización transferidas a la API.

Valor Nullable<double>

Duración media de inicios de sesión totales en milisegundos y la duración media de cada paso para este grupo.

Desglose Collection<LogOnStepItem>

Colección de objetos LogOnStepItem que contienen:

La propiedad Duration (Nullable<double>) que tiene la duración media de este paso en milisegundos y la propiedad LogOnStep (int) que devuelve el valor de enumeración entero del paso del inicio de sesión (hace referencia a la enumeración LogOnStep)

Ejemplo

Obtiene una media de 7 días por tiempo del día (hora) de la tendencia de la duración de los inicios de sesión (en milisegundos) de los dos grupos de entrega especificados. Esto devuelve un elemento de tendencia cada hora del día que cumple con la media de la duración de los inicios de sesión durante el intervalo de tiempo especificado (24 puntos de datos devueltos).

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetDurationAverageTrend?start=datetime'2011-09-23T00:00:00'&end=datetime'2011-10-01T00:00:00'groupByInterval=1&desktopGroupsFilter='04D53BBE-F5CC-11E0-B401-3F054824019B,0FBEFBBE-F5CC-11E0-9472-40054824019B'

GetLogOnDurationDetailsTrend

Obtiene la tendencia de la duración de los inicios de sesión para el período de tiempo especificado. Cada punto de datos de la tendencia contiene la duración total de los inicios de sesión , así como el desglose de cada paso.

Nombre del parámetroTipoComentarios
startDateDateTimeInicio de la ventana de tiempo que se va a consultar de la tendencia de los fallos de conexión. Debe ser UTC.
endDateDateTimeFin de la ventana de tiempo que se va a consultar de la tendencia de los fallos de conexión. Debe ser UTC.
intervalLengthintIntervalo entre puntos de datos en minutos de la tendencia.
desktopGroupsFilterstringLista separada por comas de UID de grupos de entrega a los que limitar el resultado de la tendencia.

Devuelve

Una lista de LogonDurationTrendItems:

Nombre de propiedadTipoComentarios
LogonDurationTrendList<LogonDurationTrendItem>LogOnDurationTrendItem contiene una propiedad UTC Date (DateTime) y un "Double" de la duración media de los inicios de sesión en milisegundos de ese tiempo. También contiene un desglose de la duración media de cada paso en el inicio de sesión para cada punto de datos.

Ejemplo

Obtiene una tendencia de 24 horas (punto de datos cada 15 minutos) para la tendencia de duración de los inicios de sesión referente a los dos grupos de entrega especificados.

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationDetailsTrend?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'

Obtiene una tendencia de una semana (un punto de datos cada 4 horas) de la tendencia de duración (en milisegundos) de los inicios de sesión .

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

GetLogOnDurationTrend

Obtiene la tendencia media de la duración de los inicios de sesión durante el período de tiempo especificado.

Nombre del parámetroTipoComentarios
startDateTimeInicio de la ventana de tiempo que se va a consultar para la tendencia media de la duración de los inicios de sesión . Debe ser UTC.
endDateTimeFin de la ventana de tiempo que se va a consultar para la tendencia media de la duración de los inicios de sesión . Debe ser UTC.
intervalLengthintIntervalo entre puntos de datos en minutos de la tendencia.

Devuelve

Un IQueryable de objetos TrendItem. TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Value (en milisegundos) para indicar la tendencia media de la duración de los inicios de sesión durante el período de tiempo especificado.

Ejemplos

Obtiene una hora de datos, un único punto de datos por minuto que representa la duración media de los inicios de sesión de ese minuto. Si no hay inicios de sesión durante ese minuto, el valor de TrendItem es NaN (not a number).

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationTrend?start=datetime'2012-06-05T12:24:00'&end=datetime'2012-06-05T13:24:00'&intervalLength=1

Obtiene un único punto de datos que representa la duración media de los inicios de sesión de esa hora.

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetLogOnDurationTrend?start=datetime'2012-06-05T12:24:00'&end=datetime'2012-06-05T13:23:00'&intervalLength=60

GetMachineFailureTrend

Obtiene la tendencia de los fallos de máquinas simultáneas durante el período de tiempo especificado. Cada punto de datos de la tendencia representa el número máximo de máquinas fallidas en cualquier momento del último intervalo (parámetro intervalLength). Permite especificar un tipo de fallo de máquina específico para limitar la consulta u obtener todos los tipos de fallo.

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar de la tendencia de los fallos de conexión. Debe ser UTC.
endDate DateTime Fin de la ventana de tiempo que se va a consultar de la tendencia de los fallos de conexión. Debe ser UTC.
intervalLength int Intervalo entre puntos de datos en minutos de la tendencia.
desktopGroupsFilter string Lista separada por comas de UID de grupos de entrega a los que limitar el resultado de la tendencia.
machineFailureTypeFilter string Lista separada por comas de enteros de los tipos de fallos de conexión a los que limitar el resultado de la tendencia. Este número entero corresponde a la enumeración MachineFaultStateCode. Si no se proporciona, devuelve todos los tipos agregados de la tendencia.
sessionSupportFilter int Lista separada por comas de enteros de tipos de máquina (Única=1, Múltiple=2, Desconocido=0) a los que limitar el resultado de la tendencia. Si no hay ningún valor, devuelve todos los tipos.

Devuelve

Una lista de objetos TrendItem (FailureTrend).

Nombre de propiedad Tipo Comentarios
FailureTrend List<TrendItem> TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Count (int) de los fallos para indicar la tendencia de los fallos de máquina durante el período de tiempo especificado para los filtros especificados.

Ejemplo

Obtiene una tendencia de 24 horas (un punto de datos cada 15 minutos) de todos los tipos de fallos de máquina de los dos grupos de entrega especificados con los tipos de máquina con sistema operativo de escritorio.

 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'

Obtiene una tendencia de 24 horas (un punto de datos cada 2 horas) para todos los grupos de entrega, todos los tipos de sesión y los fallos de máquina del tipo "No se iniciaron" y "Atascadas en el arranque".

 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'

GetMachineFailureTrendsByType

Obtiene una lista de fallos de máquina y recuentos correctos por tipo, junto con una tendencia para cada tipo, del período de tiempo especificado. Cada punto de datos de la tendencia representa la cantidad total de máquinas en un estado fallido en el último intervalo (parámetro intervalLength). Puede especificar un tipo de fallo determinado para limitar la consulta u obtener todos los tipos de fallo.

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar para la tendencia de los fallos de máquina. Debe ser UTC. No es necesario si no se obtienen tendencias.
endDate DateTime Fin de la ventana de tiempo que se va a consultar de la tendencia de los fallos de máquina. Debe ser UTC.
intervalLength int Intervalo entre puntos de datos en minutos de la tendencia.
machineFailureType int (MachineFailureType) Si se proporciona (>0), devuelve solo ese tipo de fallo de máquina en los resultados. De lo contrario (null o cero), devuelve una lista de todos los tipos de fallo. Este número entero corresponde a la enumeración MachineFailureType.
sessionSupport int (SessionSupport) Enteros que aceptan valores null. Si no se proporciona, devuelve todos los tipos de sessionSupport. Única=1, Múltiple=2, Desconocida=0

Devuelve

Un IQueryable de objetos MachineFailureTrend que contiene la siguiente información para cada MachineFailureType.

Si se solicitan todos los tipos, la suma también se devuelve con MachineFailureType=-1

Si $expand=FailureTrend se incluye en la consulta, la tendencia y las propiedades TotalFailureCount se recuperan para cada tipo de fallo.

Si $expand=DesktopGroupBreakdown se incluye en la consulta, esa propiedad también se recupera para cada tipo de fallo.

Nombre de propiedad Tipo Comentarios
MachineFailureType int [MachineFailureType] Tipo de fallo de conexión (consulte: Determinación de los valores de enumeración).
TotalFailureCount int Número total de fallos en el endDate especificado.
FailureTrend List<TrendItem> TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Count (double) para indicar la tendencia de los fallos de máquina durante el período de tiempo especificado de este tipo de fallo.
DesktopGroupBreakdown List<DesktopGroupBreakdown> DesktopGroupBreakdown contiene un objeto DesktopGroup y un Count (int) para representar la cantidad total de máquinas en un estado de fallo en el endDate especificado.

Ejemplos

Recuperar el desglose de los grupos de entrega y la tendencia de los fallos de todos los tipos de fallo de máquina desde el 14 de noviembre a las 5:00 h (UTC) hasta el 14 de noviembre a las 7:00 h (UTC), con un punto de datos cada 30 minutos para todas las máquinas con sistema operativo de servidor (es decir, sessionSupport=2):

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&intervalLength=30&machineFailureType=0&sessionSupport=2&$expand=FailureTrend,DesktopGroupBreakdown

Recuperar el desglose de los grupos de entrega solo del tipo de fallo de máquina n.º 3 (Atascadas en el arranque) desde el 14 de noviembre a las 5:00 h (UTC) hasta el 14 de noviembre a las 7:00 h (UTC) para las máquinas con sistema operativo de escritorio:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrendsByType?startDate=datetime'2011-11-14T05:00:00'&endDate=datetime'2011-11-14T07:00:00'&machineFailureType=3&sessionSupport=1&$expand=FailureTrend

Recuperar la tendencia de los fallos de todos los tipos de fallo de máquina y de todos los tipos de sesión de máquina desde el 14 de noviembre a las 0:00 h (UTC) hasta el 14 de noviembre a las 23:00 h (UTC) con un punto de datos cada hora:

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetMachineFailureTrendsByType?startDate=datetime'2011-11-14T00:00:00'&endDate=datetime'2011-11-14T23:00:00'&intervalLength=60&machineFailureType=0&$expand=FailureTrend

GetSessionCountTrend

Obtiene los puntos de datos para representar una tendencia de las sesiones simultáneas (conectadas) en forma de lista de pares de DateTime/Value durante la ventana de tiempo especificada. Cada punto representa el número máximo de sesiones simultáneas conectadas en el intervalo especificado. Este valor se calcula a raíz de la suma de los DesktopGroups y el máximo de la suma.

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar de las sesiones simultáneas. Debe ser UTC.
endDate DateTime Fin de la ventana de tiempo que se va a consultar de las sesiones simultáneas. Debe ser UTC.
intervalLength int Intervalo entre puntos de datos en minutos de la tendencia.
sessionSupportFilter string Lista de enteros de tipos de máquina delimitados por comas a los que limitar la consulta (Única=1, Múltiple=2, Desconocida=0). Si no se especifica, el valor predeterminado es todo.
connectionStateFilter string Lista de enteros de estado de conexión delimitados por comas a los que limitar la consulta (1=Conectada, 2=Desconectada). Si no se especifica, devuelve los dos.
desktopGroupFilter string Lista de UID de grupos de entrega delimitados por comas a los que limitar la consulta. Si no se especifica, devuelve todos los grupos de entrega.

Devuelve

Lista de IQueryable de objetos TrendItem (IQueryable<TrendItem>) ordenados por fecha en orden ascendente.

Cada TrendItem contiene una propiedad UTC Date (DateTime) y una propiedad Value (int) para representar la tendencia.

Ejemplo

Obtiene una tendencia de 24 horas con puntos de datos cada hora de las sesiones simultáneas conectadas. Cada punto de datos representa el número máximo de sesiones simultáneas (solo conectadas) en el último intervalo (60 minutos en este caso).

 http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=60&connectionStateFilter='1'

Obtiene una tendencia de 24 horas con puntos de datos cada hora de las sesiones simultáneas desconectadas. Cada punto de datos representa el número máximo de sesiones simultáneas (solo desconectadas) en el último intervalo (60 minutos en este caso).

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionCountTrend?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&intervalLength=60&connectionStateFilter='2'

Obtiene la tendencia de la semana anterior con puntos de datos cada 6 horas de las sesiones simultáneas (conectadas y desconectadas) de ambos tipos de máquina (máquinas con sistema operativo de escritorio y de servidor). Cada punto de datos representa el número máximo de sesiones simultáneas en el último intervalo (6 horas en este caso).

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

GetSessionSummary

Obtiene los puntos de datos para representar una tendencia de las sesiones simultáneas (conectadas) en forma de lista de pares de DateTime/Value durante el período de tiempo especificado. Cada punto representa el número máximo de sesiones simultáneas conectadas en el intervalo especificado.

Nombre del parámetro Tipo Comentarios
startDate DateTime Inicio de la ventana de tiempo que se va a consultar de las sesiones simultáneas. Debe ser UTC.
endDate DateTime Fin de la ventana de tiempo que se va a consultar de las sesiones simultáneas. Debe ser UTC.
sessionSupportFilter string Lista de enteros de tipos de máquina delimitados por comas a los que limitar la consulta (Única=1, Múltiple=2, Desconocida=0). Si no hay ningún filtro especificado, el valor predeterminado son todos los tipos.
desktopGroupFilter string Lista de UID de grupos de entrega delimitados por comas a los que limitar la consulta. Si no se especifica ningún valor, se devuelven todos los grupos de entrega.
connectionStateFilter string Lista de enteros de estado de conexión delimitados por comas a los que limitar la consulta (1=Conectada, 2=Desconectada). Si no se especifica, el valor predeterminado son ambos.

Devuelve

Lista de IQueryable de objetos SessionSummary (IQueryable<SessionSummary>).

Cada SessionSummary contiene la siguiente información:

  • DesktopGroup (nombre y UID)
  • AverageSessionCount ("double")
  • Media de sesiones simultáneas durante el período de tiempo especificado. Esta es la media de los valores máximos del período de tiempo mediante la granularidad disponible para ese período de tiempo
  • AverageUserCount ("double")
  • Media de usuarios conectados durante el período de tiempo especificado
  • PeakUserCount (int)
  • Número máximo de usuarios conectados en cualquier momento del período de tiempo especificado
  • UniqueUserCount (int)
  • Número total de usuarios únicos durante el período de tiempo especificado
  • AverageHoursPerDay ("double")
  • Duración media de una sesión (horas por usuario por día)
  • DesktopGroup (nombre y UID)

Ejemplo

Obtiene una lista de todos los objetos SessionSummary durante 24 horas de todas las sesiones.

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

Obtiene una lista de objetos Summary durante 24 horas de las sesiones de máquinas con sistema operativo de servidor

http://{dc-host}/Citrix/Monitor/OData/v1/Methods/GetSessionSummary?startDate=datetime'2011-09-30T00:00:00'&endDate=datetime'2011-10-01T00:00:00'&sessionSupportFilter='2'