Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Citrix XenDesktop

Connection Parameters

Name
Required?
Description

Delivery Controller Hostname

Required

OData API Username

Required

OData API Password

Required

OData API Domain

OData Thread Pool Size

OData API timeout for Applications (seconds)

Timeout for OData API call to retrieve Applications (seconds)

OData API timeout for Application Instances (seconds)

Timeout for OData API call to retrieve Application Instances (seconds)

OData API timeout for Catalogs (seconds)

Timeout for OData API call to retrieve Catalogs (seconds)

OData API timeout for Connection (seconds)

Timeout for OData API call to retrieve Connection (seconds)

OData API timeout for Connection Failure Logs (seconds)

Timeout for OData API call to retrieve Connection Failure Logs (seconds)

OData API timeout for Desktop Groups (seconds)

Timeout for OData API call to retrieve Desktop Groups (seconds)

OData API timeout for Hypervisors (seconds)

Timeout for OData API call to retrieve Hypervisors (seconds)

OData API timeout for Load Indexes (seconds)

Timeout for OData API call to retrieve Load Indexes (seconds)

OData API timeout for Machine Failure Logs (seconds)

Timeout for OData API call to retrieve Machine Failure Logs (seconds)

OData API timeout for Machines (seconds)

Timeout for OData API call to retrieve Machines (seconds)

OData API timeout for Sessions (seconds)

Timeout for OData API call to retrieve Sessions (seconds)

OData API timeout for Users (seconds)

Timeout for OData API call to retrieve Users (seconds)

Use PowerShell

Required

PowerShell Username

Required

PowerShell Password

Required

PowerShell Domain

PowerShell Port

PowerShell Authentication Mechanism

SSL Configuration

PowerShell Call Timeout

Timeout for each PowerShell call made to a VDA (seconds)

Metrics

Application

Name
Description

Active Session Count (Sessions)

The number of active sessions associated with the resource.

Active Session Reconnect Disabled Connection Failures (Sessions)

The number of connection failures with the 'ActiveSessionReconnectDisabled' type.

Admin Folder

The Admin Folder of the Application.

Anonymous Session Count (Sessions)

The number of anonymous sessions associated with the resource.

Application Disabled Connection Failures

The number of connection failures with the 'ApplicationDisabled' type.

Application Session Count (Sessions)

The number of application sessions associated with the resource.

Application Type

The Application's type.

Average Authentication Duration (Milliseconds)

The average amount of time for a connection to spend in the Authentication segment of the connection process.

Average Brokering Duration (Milliseconds)

The average amount of time for a connection to spend in the Brokering segment of the connection process.

Average Duration (Minutes)

The average Application/Desktop instance duration associated with the resource.

Average Group Policy Duration (Milliseconds)

The average amount of time for a connection to spend in the Group Policy segment of the connection process.

Average HDX Duration (Milliseconds)

The average amount of time for a connection to spend in the HDX segment of the connection process.

Average Interactive Duration (Milliseconds)

The average amount of time for a connection to spend in the Interactive segment of the connection process.

Average Log On Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On segment of the connection process.

Average Log On Scripts Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On Scripts segment of the connection process.

Average Profile Load Duration (Milliseconds)

The average amount of time for a connection to spend in the Profile Load segment of the connection process.

Average VM Start Duration (Milliseconds)

The average amount of time for a connection to spend in the VM Start segment of the connection process.

Configuration Set Failures

The number of connection failures with the 'ConfigurationSetFailure' type.

Connected Session Count (Sessions)

The number of connected sessions associated with the resource.

Connection Count (Connections)

The number of connections associated with the resource.

Connection Timeout Failures

The number of connection failures with the 'ConnectionTimeout' type.

Desktop Session Count (Sessions)

The number of desktop sessions associated with the resource.

Disallowed Protocol Connection Failures

The number of connection failures with the 'DisallowedProtocol' type.

Disconnected Session Count (Sessions)

The number of disconnected sessions associated with the resource.

Enabled

Whether or not the Application is enabled.

General Connection Failures

The number of connection failures with the 'GeneralFail' type.

Id

The GUID from the OData API for this Application.

Instance Count (Sessions)

The number of Application/Desktop instances associated with the resource.

License Feature Refused Connection Failures

The number of connection failures with the 'LicenseFeatureRefused' type.

Licensing Connection Failures

The number of connection failures with the 'Licensing' type.

Lifecycle State

The Lifecycle State of the Application.

Machine Not Functional Connection Failures

The number of connection failures with the 'MachineNotFunctional' type.

Maintenance Mode Connection Failures

The number of connection failures with the 'MaintenanceMode' type.

Name

The Name of the Application.

New Connection Count (Connections)

The number of new connections associated with the resource.

No Desktop Available Connection Failures

The number of connection failures with the 'NoDesktopAvailable' type.

No Machine Available Connection Failures

The number of connection failures with the 'NoMachineAvailable' type.

No Session To Reconnect Connection Failures

The number of connection failures with the 'NoSessionToReconnect' type.

Non Brokered Session Count (Sessions)

The number of non-brokered sessions associated with the resource.

Other Connection Failures

The number of connection failures with the 'Other' type.

Other Session Count (Sessions)

The number of 'other' sessions associated with the resource.

Peak Concurrent Session Count (Sessions)

The peak concurrent sessions associated with the resource.

Pending Session Count (Sessions)

The number of pending sessions associated with the resource.

Preparing Session Count (Sessions)

The number of sessions being prepared that are associated with the resource.

Published Name

The Published Name of the Application.

Reconnecting Session Count (Sessions)

The number of reconnecting sessions associated with the resource.

Refused Connection Failures

The number of connection failures with the 'Refused' type.

Registration Timeout Connection Failures

The number of connection failures with the 'RegistrationTimeout' type.

Resource Unavailable Connection Failures

The number of connection failures with the 'ResourceUnavailable' type.

Secure ICA Connection Count (Connections)

The number of secure ICA connections associated with the resource.

Session Limit Reached Connection Failures

The number of connection failures with the 'SessionLimitReached' type.

Session Preparation Connection Failures

The number of connection failures with the 'SessionPreparation' type.

Spin Up Failed Connection Failures

The number of connection failures with the 'SpinUpFailed' type.

Terminated Session Count (Sessions)

The number of terminated sessions associated with the resource.

Ticketing Connection Failures

The number of connection failures with the 'Ticketing' type.

Total Connection Failures

The total number of connections failures.

Total Session Count (Sessions)

The total number of sessions associated with the resource.

Uncategorized Connection Failures

The number of connection failures with the 'None' type.

Unknown Connection Failures

The number of connection failures with the 'Unknown' type.

Unknown Session Count (Sessions)

The number of sessions in an unknown state that are associated with the resource.

Application Instance

Name
Description

Application ID

The application ID of the Application Instance.

End Date

The End Date of the Application Instance.

Id

The GUID from the OData API for this Application Instance.

Session Key

The Session Key for the Application Instance.

Start Date

The Start Date of the Application Instance.

Catalog

Name
Description

Active Session Count (Sessions)

The number of active sessions associated with the resource.

Active Session Reconnect Disabled Connection Failures (Sessions)

The number of connection failures with the 'ActiveSessionReconnectDisabled' type.

Allocation Type

The Allocation Type of the Catalog.

Anonymous Session Count (Sessions)

The number of anonymous sessions associated with the resource.

Application Disabled Connection Failures

The number of connection failures with the 'ApplicationDisabled' type.

Application Session Count (Sessions)

The number of application sessions associated with the resource.

Average Authentication Duration (Milliseconds)

The average amount of time for a connection to spend in the Authentication segment of the connection process.

Average Brokering Duration (Milliseconds)

The average amount of time for a connection to spend in the Brokering segment of the connection process.

Average Group Policy Duration (Milliseconds)

The average amount of time for a connection to spend in the Group Policy segment of the connection process.

Average HDX Duration (Milliseconds)

The average amount of time for a connection to spend in the HDX segment of the connection process.

Average Interactive Duration (Milliseconds)

The average amount of time for a connection to spend in the Interactive segment of the connection process.

Average Log On Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On segment of the connection process.

Average Log On Scripts Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On Scripts segment of the connection process.

Average Profile Load Duration (Milliseconds)

The average amount of time for a connection to spend in the Profile Load segment of the connection process.

Average VM Start Duration (Milliseconds)

The average amount of time for a connection to spend in the VM Start segment of the connection process.

Configuration Set Failures

The number of connection failures with the 'ConfigurationSetFailure' type.

Connected Session Count (Sessions)

The number of connected sessions associated with the resource.

Connection Count (Connections)

The number of connections associated with the resource.

Connection Timeout Failures

The number of connection failures with the 'ConnectionTimeout' type.

CPU

The CPU Load Index from the related underlying VDA machine(s).

CPU Utilization (%)

The CPU Load Index from the related underlying VDA machine(s).

Desktop Session Count (Sessions)

The number of desktop sessions associated with the resource.

Disallowed Protocol Connection Failures

The number of connection failures with the 'DisallowedProtocol' type.

Disconnected Session Count (Sessions)

The number of disconnected sessions associated with the resource.

Disk

The Disk Load Index from the related underlying VDA machine(s).

Disk Utilization (%)

The Disk Load Index from the related underlying VDA machine(s).

Effective Load

The Effective Load Index from the related underlying VDA machine(s).

Effective Load Utilization (%)

The Effective Load Index from the related underlying VDA machine(s).

General Connection Failures

The number of connection failures with the 'GeneralFail' type.

Id

The GUID from the OData API for the Catalog.

Is Machine Physical

The Is Machine Physical of the Catalog.

License Feature Refused Connection Failures

The number of connection failures with the 'LicenseFeatureRefused' type.

Licensing Connection Failures

The number of connection failures with the 'Licensing' type.

Lifecycle State

The Lifecycle State of the Catalog.

Machine Not Functional Connection Failures

The number of connection failures with the 'MachineNotFunctional' type.

Maintenance Mode Connection Failures

The number of connection failures with the 'MaintenanceMode' type.

Memory

The Memory Load Index from the related underlying VDA machine(s).

Memory Utilization (%)

The Memory Load Index from the related underlying VDA machine(s).

Name

The Name of the Catalog.

Network

The Network Load Index from the related underlying VDA machine(s).

Network Utilization (%)

The Network Load Index from the related underlying VDA machine(s).

New Connection Count (Connections)

The number of new connections associated with the resource.

No Desktop Available Connection Failures

The number of connection failures with the 'NoDesktopAvailable' type.

No Machine Available Connection Failures

The number of connection failures with the 'NoMachineAvailable' type.

No Session To Reconnect Connection Failures

The number of connection failures with the 'NoSessionToReconnect' type.

Non Brokered Session Count (Sessions)

The number of non-brokered sessions associated with the resource.

Other Connection Failures

The number of connection failures with the 'Other' type.

Other Session Count (Sessions)

The number of 'other' sessions associated with the resource.

Peak Concurrent Session Count (Sessions)

The peak concurrent sessions associated with the resource.

Pending Session Count (Sessions)

The number of pending sessions associated with the resource.

Persistent User Changes

The Persistent User Changes of the Catalog.

Preparing Session Count (Sessions)

The number of sessions being prepared that are associated with the resource.

Provisioning Scheme Id

The Provisioning Scheme Id of the Catalog.

Provisioning Type

The Provisioning Type of the Catalog.

Reconnecting Session Count (Sessions)

The number of reconnecting sessions associated with the resource.

Refused Connection Failures

The number of connection failures with the 'Refused' type.

Registration Timeout Connection Failures

The number of connection failures with the 'RegistrationTimeout' type.

Resource Unavailable Connection Failures

The number of connection failures with the 'ResourceUnavailable' type.

Secure ICA Connection Count (Connections)

The number of secure ICA connections associated with the resource.

Session Capacity (Sessions)

The session capacity based on the underlying VDA machine(s).

Session Count

The Session Count Load Index from the related underlying VDA machine(s).

Session Limit Reached Connection Failures

The number of connection failures with the 'SessionLimitReached' type.

Session Preparation Connection Failures

The number of connection failures with the 'SessionPreparation' type.

Session Support

The Session Support of the Catalog.

Session Utilization (%)

The Session Count Load Index from the related underlying VDA machine(s).

Spin Up Failed Connection Failures

The number of connection failures with the 'SpinUpFailed' type.

Terminated Session Count (Sessions)

The number of terminated sessions associated with the resource.

Ticketing Connection Failures

The number of connection failures with the 'Ticketing' type.

Total Connection Failures

The total number of connections failures.

Total Session Count (Sessions)

The total number of sessions associated with the resource.

Uncategorized Connection Failures

The number of connection failures with the 'None' type.

Unknown Connection Failures

The number of connection failures with the 'Unknown' type.

Unknown Session Count (Sessions)

The number of sessions in an unknown state that are associated with the resource.

DDC Machine

Name
Description

DNS Name

The DNS Name of the DDC Machine.

Fault State

The Fault State of the DDC Machine.

Id

The GUID of the DDC Machine from the OData API.

Lifecycle State

The Lifecycle State of the DDC Machine.

Machine Role

The Machine Role of the DDC Machine.

OS Type

The OS Type of the DDC Machine.

Delivery Group

Name
Description

Active Session Count (Sessions)

The number of active sessions associated with the resource.

Active Session Reconnect Disabled Connection Failures (Sessions)

The number of connection failures with the 'ActiveSessionReconnectDisabled' type.

Anonymous Session Count (Sessions)

The number of anonymous sessions associated with the resource.

Application Disabled Connection Failures

The number of connection failures with the 'ApplicationDisabled' type.

Application Session Count (Sessions)

The number of application sessions associated with the resource.

Average Authentication Duration (Milliseconds)

The average amount of time for a connection to spend in the Authentication segment of the connection process.

Average Brokering Duration (Milliseconds)

The average amount of time for a connection to spend in the Brokering segment of the connection process.

Average Group Policy Duration (Milliseconds)

The average amount of time for a connection to spend in the Group Policy segment of the connection process.

Average HDX Duration (Milliseconds)

The average amount of time for a connection to spend in the HDX segment of the connection process.

Average Interactive Duration (Milliseconds)

The average amount of time for a connection to spend in the Interactive segment of the connection process.

Average Log On Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On segment of the connection process.

Average Log On Scripts Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On Scripts segment of the connection process.

Average Profile Load Duration (Milliseconds)

The average amount of time for a connection to spend in the Profile Load segment of the connection process.

Average VM Start Duration (Milliseconds)

The average amount of time for a connection to spend in the VM Start segment of the connection process.

Configuration Set Failures

The number of connection failures with the 'ConfigurationSetFailure' type.

Connected Session Count (Sessions)

The number of connected sessions associated with the resource.

Connection Count (Connections)

The number of connections associated with the resource.

Connection Timeout Failures

The number of connection failures with the 'ConnectionTimeout' type.

CPU

The CPU Load Index from the related underlying VDA machine(s).

CPU Utilization (%)

The CPU Load Index from the related underlying VDA machine(s).

Delivery Type

The Delivery Type of the Delivery Group.

Desktop Kind

The Desktop Kind of the Delivery Group.

Desktop Session Count (Sessions)

The number of desktop sessions associated with the resource.

Disallowed Protocol Connection Failures

The number of connection failures with the 'DisallowedProtocol' type.

Disconnected Session Count (Sessions)

The number of disconnected sessions associated with the resource.

Disk

The Disk Load Index from the related underlying VDA machine(s).

Disk Utilization (%)

The Disk Load Index from the related underlying VDA machine(s).

Effective Load

The Effective Load Index from the related underlying VDA machine(s).

Effective Load Utilization (%)

The Effective Load Index from the related underlying VDA machine(s).

General Connection Failures

The number of connection failures with the 'GeneralFail' type.

Id

The GUID of the Delivery Group from the OData API.

Is Remote PC

The Is Remote PC of the Delivery Group.

License Feature Refused Connection Failures

The number of connection failures with the 'LicenseFeatureRefused' type.

Licensing Connection Failures

The number of connection failures with the 'Licensing' type.

Lifecycle State

The Lifecycle State of the Delivery Group.

Machine Not Functional Connection Failures

The number of connection failures with the 'MachineNotFunctional' type.

Maintenance Mode Connection Failures

The number of connection failures with the 'MaintenanceMode' type.

Memory

The Memory Load Index from the related underlying VDA machine(s).

Memory Utilization (%)

The Memory Load Index from the related underlying VDA machine(s).

Name

The Name of the Delivery Group.

Network

The Network Load Index from the related underlying VDA machine(s).

Network Utilization (%)

The Network Load Index from the related underlying VDA machine(s).

New Connection Count (Connections)

The number of new connections associated with the resource.

No Desktop Available Connection Failures

The number of connection failures with the 'NoDesktopAvailable' type.

No Machine Available Connection Failures

The number of connection failures with the 'NoMachineAvailable' type.

No Session To Reconnect Connection Failures

The number of connection failures with the 'NoSessionToReconnect' type.

Non Brokered Session Count (Sessions)

The number of non-brokered sessions associated with the resource.

Other Connection Failures

The number of connection failures with the 'Other' type.

Other Session Count (Sessions)

The number of 'other' sessions associated with the resource.

Peak Concurrent Session Count (Sessions)

The peak concurrent sessions associated with the resource.

Pending Session Count (Sessions)

The number of pending sessions associated with the resource.

Preparing Session Count (Sessions)

The number of sessions being prepared that are associated with the resource.

Reconnecting Session Count (Sessions)

The number of reconnecting sessions associated with the resource.

Refused Connection Failures

The number of connection failures with the 'Refused' type.

Registration Timeout Connection Failures

The number of connection failures with the 'RegistrationTimeout' type.

Resource Unavailable Connection Failures

The number of connection failures with the 'ResourceUnavailable' type.

Secure ICA Connection Count (Connections)

The number of secure ICA connections associated with the resource.

Session Capacity (Sessions)

The session capacity based on the underlying VDA machine(s).

Session Count

The Session Count Load Index from the related underlying VDA machine(s).

Session Limit Reached Connection Failures

The number of connection failures with the 'SessionLimitReached' type.

Session Preparation Connection Failures

The number of connection failures with the 'SessionPreparation' type.

Session Support

The Session Support of the Delivery Group.

Session Utilization (%)

The Session Count Load Index from the related underlying VDA machine(s).

Spin Up Failed Connection Failures

The number of connection failures with the 'SpinUpFailed' type.

Terminated Session Count (Sessions)

The number of terminated sessions associated with the resource.

Ticketing Connection Failures

The number of connection failures with the 'Ticketing' type.

Total Connection Failures

The total number of connections failures.

Total Session Count (Sessions)

The total number of sessions associated with the resource.

Uncategorized Connection Failures

The number of connection failures with the 'None' type.

Unknown Connection Failures

The number of connection failures with the 'Unknown' type.

Unknown Session Count (Sessions)

The number of sessions in an unknown state that are associated with the resource.

VDA Machine Count

The number of VDAs in the Delivery Group.

Desktop

Name
Description

Active Session Count (Sessions)

The number of active sessions associated with the resource.

Active Session Reconnect Disabled Connection Failures (Sessions)

The number of connection failures with the 'ActiveSessionReconnectDisabled' type.

Anonymous Session Count (Sessions)

The number of anonymous sessions associated with the resource.

Application Disabled Connection Failures

The number of connection failures with the 'ApplicationDisabled' type.

Application Session Count (Sessions)

The number of application sessions associated with the resource.

Average Authentication Duration (Milliseconds)

The average amount of time for a connection to spend in the Authentication segment of the connection process.

Average Brokering Duration (Milliseconds)

The average amount of time for a connection to spend in the Brokering segment of the connection process.

Average Duration (Minutes)

The average Application/Desktop instance duration associated with the resource.

Average Group Policy Duration (Milliseconds)

The average amount of time for a connection to spend in the Group Policy segment of the connection process.

Average HDX Duration (Milliseconds)

The average amount of time for a connection to spend in the HDX segment of the connection process.

Average Interactive Duration (Milliseconds)

The average amount of time for a connection to spend in the Interactive segment of the connection process.

Average Log On Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On segment of the connection process.

Average Log On Scripts Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On Scripts segment of the connection process.

Average Profile Load Duration (Milliseconds)

The average amount of time for a connection to spend in the Profile Load segment of the connection process.

Average VM Start Duration (Milliseconds)

The average amount of time for a connection to spend in the VM Start segment of the connection process.

Configuration Set Failures

The number of connection failures with the 'ConfigurationSetFailure' type.

Connected Session Count (Sessions)

The number of connected sessions associated with the resource.

Connection Count (Connections)

The number of connections associated with the resource.

Connection Timeout Failures

The number of connection failures with the 'ConnectionTimeout' type.

Desktop Session Count (Sessions)

The number of desktop sessions associated with the resource.

Disallowed Protocol Connection Failures

The number of connection failures with the 'DisallowedProtocol' type.

Disconnected Session Count (Sessions)

The number of disconnected sessions associated with the resource.

General Connection Failures

The number of connection failures with the 'GeneralFail' type.

Id

The GUID of the Desktop.

Instance Count (Sessions)

The number of Application/Desktop instances associated with the resource.

License Feature Refused Connection Failures

The number of connection failures with the 'LicenseFeatureRefused' type.

Licensing Connection Failures

The number of connection failures with the 'Licensing' type.

Machine Not Functional Connection Failures

The number of connection failures with the 'MachineNotFunctional' type.

Maintenance Mode Connection Failures

The number of connection failures with the 'MaintenanceMode' type.

Name

The Name of the Desktop.

New Connection Count (Connections)

The number of new connections associated with the resource.

No Desktop Available Connection Failures

The number of connection failures with the 'NoDesktopAvailable' type.

No Machine Available Connection Failures

The number of connection failures with the 'NoMachineAvailable' type.

No Session To Reconnect Connection Failures

The number of connection failures with the 'NoSessionToReconnect' type.

Non Brokered Session Count (Sessions)

The number of non-brokered sessions associated with the resource.

Other Connection Failures

The number of connection failures with the 'Other' type.

Other Session Count (Sessions)

The number of 'other' sessions associated with the resource.

Peak Concurrent Session Count (Sessions)

The peak concurrent sessions associated with the resource.

Pending Session Count (Sessions)

The number of pending sessions associated with the resource.

Preparing Session Count (Sessions)

The number of sessions being prepared that are associated with the resource.

Reconnecting Session Count (Sessions)

The number of reconnecting sessions associated with the resource.

Refused Connection Failures

The number of connection failures with the 'Refused' type.

Registration Timeout Connection Failures

The number of connection failures with the 'RegistrationTimeout' type.

Resource Unavailable Connection Failures

The number of connection failures with the 'ResourceUnavailable' type.

Secure ICA Connection Count (Connections)

The number of secure ICA connections associated with the resource.

Session Limit Reached Connection Failures

The number of connection failures with the 'SessionLimitReached' type.

Session Preparation Connection Failures

The number of connection failures with the 'SessionPreparation' type.

Spin Up Failed Connection Failures

The number of connection failures with the 'SpinUpFailed' type.

Terminated Session Count (Sessions)

The number of terminated sessions associated with the resource.

Ticketing Connection Failures

The number of connection failures with the 'Ticketing' type.

Total Connection Failures

The total number of connections failures.

Total Session Count (Sessions)

The total number of sessions associated with the resource.

Uncategorized Connection Failures

The number of connection failures with the 'None' type.

Unknown Connection Failures

The number of connection failures with the 'Unknown' type.

Unknown Session Count (Sessions)

The number of sessions in an unknown state that are associated with the resource.

Hypervisor

Name
Description

Active Session Count (Sessions)

The number of active sessions associated with the resource.

Active Session Reconnect Disabled Connection Failures (Sessions)

The number of connection failures with the 'ActiveSessionReconnectDisabled' type.

Anonymous Session Count (Sessions)

The number of anonymous sessions associated with the resource.

Application Disabled Connection Failures

The number of connection failures with the 'ApplicationDisabled' type.

Application Session Count (Sessions)

The number of application sessions associated with the resource.

Average Authentication Duration (Milliseconds)

The average amount of time for a connection to spend in the Authentication segment of the connection process.

Average Brokering Duration (Milliseconds)

The average amount of time for a connection to spend in the Brokering segment of the connection process.

Average Group Policy Duration (Milliseconds)

The average amount of time for a connection to spend in the Group Policy segment of the connection process.

Average HDX Duration (Milliseconds)

The average amount of time for a connection to spend in the HDX segment of the connection process.

Average Interactive Duration (Milliseconds)

The average amount of time for a connection to spend in the Interactive segment of the connection process.

Average Log On Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On segment of the connection process.

Average Log On Scripts Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On Scripts segment of the connection process.

Average Profile Load Duration (Milliseconds)

The average amount of time for a connection to spend in the Profile Load segment of the connection process.

Average VM Start Duration (Milliseconds)

The average amount of time for a connection to spend in the VM Start segment of the connection process.

Configuration Set Failures

The number of connection failures with the 'ConfigurationSetFailure' type.

Connected Session Count (Sessions)

The number of connected sessions associated with the resource.

Connection Count (Connections)

The number of connections associated with the resource.

Connection Timeout Failures

The number of connection failures with the 'ConnectionTimeout' type.

CPU

The CPU Load Index from the related underlying VDA machine(s).

CPU Utilization (%)

The CPU Load Index from the related underlying VDA machine(s).

Desktop Session Count (Sessions)

The number of desktop sessions associated with the resource.

Disallowed Protocol Connection Failures

The number of connection failures with the 'DisallowedProtocol' type.

Disconnected Session Count (Sessions)

The number of disconnected sessions associated with the resource.

Disk

The Disk Load Index from the related underlying VDA machine(s).

Disk Utilization (%)

The Disk Load Index from the related underlying VDA machine(s).

Effective Load

The Effective Load Index from the related underlying VDA machine(s).

Effective Load Utilization (%)

The Effective Load Index from the related underlying VDA machine(s).

General Connection Failures

The number of connection failures with the 'GeneralFail' type.

Id

The GUID from the OData API for the Hypervisor.

License Feature Refused Connection Failures

The number of connection failures with the 'LicenseFeatureRefused' type.

Licensing Connection Failures

The number of connection failures with the 'Licensing' type.

Lifecycle State

The Lifecycle State of the Hypervisor.

Machine Not Functional Connection Failures

The number of connection failures with the 'MachineNotFunctional' type.

Maintenance Mode Connection Failures

The number of connection failures with the 'MaintenanceMode' type.

Memory

The Memory Load Index from the related underlying VDA machine(s).

Memory Utilization (%)

The Memory Load Index from the related underlying VDA machine(s).

Name

The Name of the Hypervisor.

Network

The Network Load Index from the related underlying VDA machine(s).

Network Utilization (%)

The Network Load Index from the related underlying VDA machine(s).

New Connection Count (Connections)

The number of new connections associated with the resource.

No Desktop Available Connection Failures

The number of connection failures with the 'NoDesktopAvailable' type.

No Machine Available Connection Failures

The number of connection failures with the 'NoMachineAvailable' type.

No Session To Reconnect Connection Failures

The number of connection failures with the 'NoSessionToReconnect' type.

Non Brokered Session Count (Sessions)

The number of non-brokered sessions associated with the resource.

Other Connection Failures

The number of connection failures with the 'Other' type.

Other Session Count (Sessions)

The number of 'other' sessions associated with the resource.

Peak Concurrent Session Count (Sessions)

The peak concurrent sessions associated with the resource.

Pending Session Count (Sessions)

The number of pending sessions associated with the resource.

Preparing Session Count (Sessions)

The number of sessions being prepared that are associated with the resource.

Reconnecting Session Count (Sessions)

The number of reconnecting sessions associated with the resource.

Refused Connection Failures

The number of connection failures with the 'Refused' type.

Registration Timeout Connection Failures

The number of connection failures with the 'RegistrationTimeout' type.

Resource Unavailable Connection Failures

The number of connection failures with the 'ResourceUnavailable' type.

Secure ICA Connection Count (Connections)

The number of secure ICA connections associated with the resource.

Session Capacity (Sessions)

The session capacity based on the underlying VDA machine(s).

Session Count

The Session Count Load Index from the related underlying VDA machine(s).

Session Limit Reached Connection Failures

The number of connection failures with the 'SessionLimitReached' type.

Session Preparation Connection Failures

The number of connection failures with the 'SessionPreparation' type.

Session Utilization (%)

The Session Count Load Index from the related underlying VDA machine(s).

Spin Up Failed Connection Failures

The number of connection failures with the 'SpinUpFailed' type.

Terminated Session Count (Sessions)

The number of terminated sessions associated with the resource.

Ticketing Connection Failures

The number of connection failures with the 'Ticketing' type.

Total Connection Failures

The total number of connections failures.

Total Session Count (Sessions)

The total number of sessions associated with the resource.

Uncategorized Connection Failures

The number of connection failures with the 'None' type.

Unknown Connection Failures

The number of connection failures with the 'Unknown' type.

Unknown Session Count (Sessions)

The number of sessions in an unknown state that are associated with the resource.

Session

Name
Description

Application Name

The Application Name of the Session.

Authentication Duration (Milliseconds)

The amount of time for a connection to spend in the Authentication segment of the connection process.

Average Latency (Milliseconds)

The average latency for the session.

Brokering Duration (Milliseconds)

The amount of time for a connection to spend in the Brokering segment of the connection process.

Client Address

The address of the client used to connect to the session.

Client Name

The name of the client used to connect to the session.

Client Version

The version of the client used to connect to the session.

Connected via Host Name

The hostname from which the connection connected to the session.

Connected via IP Address

The IP address from which the connection connected to the session.

Connection Count (Milliseconds)

The number of connections associated with the resource.

Connection State

The Connection State of the Session.

Connection State Change Date

The Connection State Change Date of the Session.

Current Connection Id

The Current Connection Id of the Session.

End Date

The End Date of the Session.

Exit Code

The Exit Code of the Session.

Exit Status

The Exit Status of the Session.

Failure Date

The Failure Date of the Session.

Group Policy Duration (Milliseconds)

The amount of time for a connection to spend in the Group Policy segment of the connection process.

HDX Duration (Milliseconds)

The amount of time for a connection to spend in the HDX segment of the connection process.

Interactive Duration (Milliseconds)

The amount of time for a connection to spend in the Interactive segment of the connection process.

Is Anonymous

The Is Anonymous of the Session.

Is Reconnect

Whether or not the session has been reconnected to.

Is Secure ICA

Whether or not the ICA protocol was used to secure the connection to the session.

Last Recorded Latency (Milliseconds)

The last recorded latency measurement of the session.

Launched via Host Name

The hostname from which the connection to the session was launched.

Launched via IP Address

The IP address from which the connection to the session was launched.

Lifecycle State

The Lifecycle State of the Session.

Log On Duration (Milliseconds)

The amount of time for a connection to spend in the Log On segment of the connection process.

Log On Scripts Duration (Milliseconds)

The amount of time for a connection to spend in the Log On Scripts segment of the connection process.

Machine Id

The Machine Id of the Session.

Machine Name

The Machine Name of the Session.

New Connection Count (Milliseconds)

The number of new connections associated with the resource.

Profile Load Duration (Milliseconds)

The amount of time for a connection to spend in the Profile Load segment of the connection process.

Protocol

The protocol of the connection to the session.

Round Trip Time (Milliseconds)

ICA RTT (Roundtrip Time) is the detected network latency between the ICA client device and the XenApp Server.

Secure ICA Connection Count (Milliseconds)

The number of secure ICA connections associated with the resource.

Session Duration (Seconds)

The Session Duration of the Session.

Session Key

The Session Key.

Start Date

The Start Date of the Session.

Type

The Session Type of the Session.

User Full Name

The full name of the User.

User Id

The User Id of the Session.

User UPN

The User UPN of the Session.

User Username

The username of the User.

VM Start Duration (Milliseconds)

The amount of time for a connection to spend in the VM Start segment of the connection process.

Site

Name
Description

Active Session Count (Sessions)

The number of active sessions associated with the resource.

Active Session Reconnect Disabled Connection Failures (Sessions)

The number of connection failures with the 'ActiveSessionReconnectDisabled' type.

Anonymous Session Count (Sessions)

The number of anonymous sessions associated with the resource.

Application Count

The number of Application in the Site.

Application Disabled Connection Failures

The number of connection failures with the 'ApplicationDisabled' type.

Application Session Count (Sessions)

The number of application sessions associated with the resource.

Average Authentication Duration (Milliseconds)

The average amount of time for a connection to spend in the Authentication segment of the connection process.

Average Brokering Duration (Milliseconds)

The average amount of time for a connection to spend in the Brokering segment of the connection process.

Average Group Policy Duration (Milliseconds)

The average amount of time for a connection to spend in the Group Policy segment of the connection process.

Average HDX Duration (Milliseconds)

The average amount of time for a connection to spend in the HDX segment of the connection process.

Average Interactive Duration (Milliseconds)

The average amount of time for a connection to spend in the Interactive segment of the connection process.

Average Log On Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On segment of the connection process.

Average Log On Scripts Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On Scripts segment of the connection process.

Average Profile Load Duration (Milliseconds)

The average amount of time for a connection to spend in the Profile Load segment of the connection process.

Average VM Start Duration (Milliseconds)

The average amount of time for a connection to spend in the VM Start segment of the connection process.

Catalog Count

The number of Catalog in the Site.

Configuration Set Failures

The number of connection failures with the 'ConfigurationSetFailure' type.

Connected Session Count (Sessions)

The number of connected sessions associated with the resource.

Connection Count (Connections)

The number of connections associated with the resource.

Connection Timeout Failures

The number of connection failures with the 'ConnectionTimeout' type.

CPU

The CPU Load Index from the related underlying VDA machine(s).

CPU Utilization (%)

The CPU Load Index from the related underlying VDA machine(s).

Database Server

The name of the database server for the Site.

DDC Machine Count

The number of DdcMachine in the Site.

Delivery Group Count

The number of Delivery Groups in the Site.

Desktop Count

The number of Desktops in the Site.

Desktop Session Count (Sessions)

The number of desktop sessions associated with the resource.

Disallowed Protocol Connection Failures

The number of connection failures with the 'DisallowedProtocol' type.

Disconnected Session Count (Sessions)

The number of disconnected sessions associated with the resource.

Disk

The Disk Load Index from the related underlying VDA machine(s).

Disk Utilization (%)

The Disk Load Index from the related underlying VDA machine(s).

Dual Role Machine Count

The number of machines with the dual-role (DDC and VDA) in the Site.

Effective Load

The Effective Load Index from the related underlying VDA machine(s).

Effective Load Utilization (%)

The Effective Load Index from the related underlying VDA machine(s).

General Connection Failures

The number of connection failures with the 'GeneralFail' type.

Hypervisor Count

The number of Hypervisor connections in the Site.

Id

The Id of the Site.

Initial Catalog

The initial catalog of the database server for the Site.

License Feature Refused Connection Failures

The number of connection failures with the 'LicenseFeatureRefused' type.

Licensing Connection Failures

The number of connection failures with the 'Licensing' type.

Machine Count

The number of VDA or DDC machines in the Site.

Machine Not Functional Connection Failures

The number of connection failures with the 'MachineNotFunctional' type.

Maintenance Mode Connection Failures

The number of connection failures with the 'MaintenanceMode' type.

Memory

The Memory Load Index from the related underlying VDA machine(s).

Memory Utilization (%)

The Memory Load Index from the related underlying VDA machine(s).

Name

The Name of the Site.

Network

The Network Load Index from the related underlying VDA machine(s).

Network Utilization (%)

The Network Load Index from the related underlying VDA machine(s).

New Connection Count (Connections)

The number of new connections associated with the resource.

No Desktop Available Connection Failures

The number of connection failures with the 'NoDesktopAvailable' type.

No Machine Available Connection Failures

The number of connection failures with the 'NoMachineAvailable' type.

No Session To Reconnect Connection Failures

The number of connection failures with the 'NoSessionToReconnect' type.

Non Brokered Session Count (Sessions)

The number of non-brokered sessions associated with the resource.

Other Connection Failures

The number of connection failures with the 'Other' type.

Other Session Count (Sessions)

The number of 'other' sessions associated with the resource.

Peak Concurrent Session Count (Sessions)

The peak concurrent sessions associated with the resource.

Pending Session Count (Sessions)

The number of pending sessions associated with the resource.

Preparing Session Count (Sessions)

The number of sessions being prepared that are associated with the resource.

Reconnecting Session Count (Sessions)

The number of reconnecting sessions associated with the resource.

Refused Connection Failures

The number of connection failures with the 'Refused' type.

Registration Timeout Connection Failures

The number of connection failures with the 'RegistrationTimeout' type.

Resource Unavailable Connection Failures

The number of connection failures with the 'ResourceUnavailable' type.

Secure ICA Connection Count (Connections)

The number of secure ICA connections associated with the resource.

Session Capacity (Sessions)

The session capacity based on the underlying VDA machine(s).

Session Count

The Session Count Load Index from the related underlying VDA machine(s).

Session Limit Reached Connection Failures

The number of connection failures with the 'SessionLimitReached' type.

Session Preparation Connection Failures

The number of connection failures with the 'SessionPreparation' type.

Session Utilization (%)

The Session Count Load Index from the related underlying VDA machine(s).

Spin Up Failed Connection Failures

The number of connection failures with the 'SpinUpFailed' type.

Terminated Session Count (Sessions)

The number of terminated sessions associated with the resource.

Ticketing Connection Failures

The number of connection failures with the 'Ticketing' type.

Total Connection Failures

The total number of connections failures.

Total Session Count (Sessions)

The total number of sessions associated with the resource.

Uncategorized Connection Failures

The number of connection failures with the 'None' type.

Unknown Connection Failures

The number of connection failures with the 'Unknown' type.

Unknown Session Count (Sessions)

The number of sessions in an unknown state that are associated with the resource.

VDA Machine Count

The number of VDA machines in the Site.

User

Name
Description

Active Session Count (Sessions)

The number of active sessions associated with the resource.

Anonymous Session Count (Sessions)

The number of anonymous sessions associated with the resource.

Application Session Count (Sessions)

The number of application sessions associated with the resource.

Average Authentication Duration (Milliseconds)

The average amount of time for a connection to spend in the Authentication segment of the connection process.

Average Brokering Duration (Milliseconds)

The average amount of time for a connection to spend in the Brokering segment of the connection process.

Average Group Policy Duration (Milliseconds)

The average amount of time for a connection to spend in the Group Policy segment of the connection process.

Average HDX Duration (Milliseconds)

The average amount of time for a connection to spend in the HDX segment of the connection process.

Average Interactive Duration (Milliseconds)

The average amount of time for a connection to spend in the Interactive segment of the connection process.

Average Log On Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On segment of the connection process.

Average Log On Scripts Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On Scripts segment of the connection process.

Average Profile Load Duration (Milliseconds)

The average amount of time for a connection to spend in the Profile Load segment of the connection process.

Average Session Duration (Seconds)

The average duration of sessions associated with the resource.

Average VM Start Duration (Milliseconds)

The average amount of time for a connection to spend in the VM Start segment of the connection process.

Connected Session Count (Sessions)

The number of connected sessions associated with the resource.

Connection Count (Connections)

The number of connections associated with the resource.

Desktop Session Count (Sessions)

The number of desktop sessions associated with the resource.

Disconnected Session Count (Sessions)

The number of disconnected sessions associated with the resource.

Domain

The domain of the User.

Full Name

The full name of the User.

Id

The GUID of the User from the OData API.

New Connection Count (Connections)

The number of new connections associated with the resource.

Non Brokered Session Count (Sessions)

The number of non-brokered sessions associated with the resource.

Other Session Count (Sessions)

The number of 'other' sessions associated with the resource.

Pending Session Count (Sessions)

The number of pending sessions associated with the resource.

Preparing Session Count (Sessions)

The number of sessions being prepared that are associated with the resource.

Reconnecting Session Count (Sessions)

The number of reconnecting sessions associated with the resource.

Secure ICA Connection Count (Connections)

The number of secure ICA connections associated with the resource.

SID

The SID of the User.

Terminated Session Count (Sessions)

The number of terminated sessions associated with the resource.

Total Session Count (Sessions)

The total number of sessions associated with the resource.

Total Session Duration (Seconds)

The total duration of sessions associated with the resource.

Unknown Session Count (Sessions)

The number of sessions in an unknown state that are associated with the resource.

UPN

The UPN of the User.

User Name

The name of the User.

VDA Machine

Name
Description

Active Session Count (Sessions)

The number of active sessions associated with the resource.

Active Session Reconnect Disabled Connection Failures (Sessions)

The number of connection failures with the 'ActiveSessionReconnectDisabled' type.

Agent Version

The Agent Version of the VDA Machine.

Anonymous Session Count (Sessions)

The number of anonymous sessions associated with the resource.

Application Disabled Connection Failures

The number of connection failures with the 'ApplicationDisabled' type.

Application Session Count (Sessions)

The number of application sessions associated with the resource.

Average Authentication Duration (Milliseconds)

The average amount of time for a connection to spend in the Authentication segment of the connection process.

Average Brokering Duration (Milliseconds)

The average amount of time for a connection to spend in the Brokering segment of the connection process.

Average Group Policy Duration (Milliseconds)

The average amount of time for a connection to spend in the Group Policy segment of the connection process.

Average HDX Duration (Milliseconds)

The average amount of time for a connection to spend in the HDX segment of the connection process.

Average Interactive Duration (Milliseconds)

The average amount of time for a connection to spend in the Interactive segment of the connection process.

Average Log On Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On segment of the connection process.

Average Log On Scripts Duration (Milliseconds)

The average amount of time for a connection to spend in the Log On Scripts segment of the connection process.

Average Profile Load Duration (Milliseconds)

The average amount of time for a connection to spend in the Profile Load segment of the connection process.

Average VM Start Duration (Milliseconds)

The average amount of time for a connection to spend in the VM Start segment of the connection process.

Catalog ID

The Catalog ID associated with the VDA Machine.

Configuration Set Failures

The number of connection failures with the 'ConfigurationSetFailure' type.

Connected Session Count (Sessions)

The number of connected sessions associated with the resource.

Connection Count (Connections)

The number of connections associated with the resource.

Connection Timeout Failures

The number of connection failures with the 'ConnectionTimeout' type.

Controller DNS Name

The Controller Dns Name of the VDA Machine.

CPU

The CPU Load Index from the related underlying VDA machine(s).

CPU Utilization (%)

The CPU Load Index from the related underlying VDA machine(s).

Current Disk Queue Length

Number of requests outstanding on the disk at the time the performance data is collected.

Current Power State

The Current Power State of the VDA Machine.

Current Registration State

The Current Registration State of the VDA Machine.

Current Session Count

The Current Session Count of the VDA Machine.

Delivery Group ID

The Delivery Group ID of the VDA Machine.

Desktop Session Count (Sessions)

The number of desktop sessions associated with the resource.

Disallowed Protocol Connection Failures

The number of connection failures with the 'DisallowedProtocol' type.

Disconnected Session Count (Sessions)

The number of disconnected sessions associated with the resource.

Disk

The Disk Load Index from the related underlying VDA machine(s).

Disk Transfers (per Second)

Rate of read and write operations on the disk in quantity over seconds.

Disk Utilization (%)

The Disk Load Index from the related underlying VDA machine(s).

DNS Name

The Dns Name of the VDA Machine.

Effective Load

The Effective Load Index from the related underlying VDA machine(s).

Effective Load Utilization (%)

The Effective Load Index from the related underlying VDA machine(s).

Fault State

The Fault State of the VDA Machine.

Free Space (Bytes)

The amount of space remaining available on the logical disk of the VDA.

Functional Level

The Functional Level of the VDA Machine.

General Connection Failures

The number of connection failures with the 'GeneralFail' type.

Hosting Server Name

The Hosting Server Name of the VDA Machine.

Hypervisor ID

The Hypervisor ID associated with the VDA Machine.

Id

The GUID of the VDA Machine from the OData API.

IP Address

The IP Address of the VDA Machine.

Is Assigned

The Is Assigned of the VDA Machine.

Is In Maintenance Mode

The Is In Maintenance Mode of the VDA Machine.

Is Pending Update

The Is Pending Update of the VDA Machine.

Is Preparing

The Is Preparing of the VDA Machine.

Last Deregistered Code

The Last Deregistered Code of the VDA Machine.

License Feature Refused Connection Failures

The number of connection failures with the 'LicenseFeatureRefused' type.

Licensing Connection Failures

The number of connection failures with the 'Licensing' type.

Lifecycle State

The Lifecycle State of the VDA Machine.

Logical Processor Count

The Number of logical processors of the VDA Machine.

Machine Not Functional Connection Failures

The number of connection failures with the 'MachineNotFunctional' type.

Machine Role

The Machine Role of the VDA Machine.

Maintenance Mode Connection Failures

The number of connection failures with the 'MaintenanceMode' type.

Memory

The Memory Load Index from the related underlying VDA machine(s).

Memory Utilization (%)

The Memory Load Index from the related underlying VDA machine(s).

Name

The Name of the VDA Machine.

Network

The Network Load Index from the related underlying VDA machine(s).

Network Utilization (%)

The Network Load Index from the related underlying VDA machine(s).

New Connection Count (Connections)

The number of new connections associated with the resource.

No Desktop Available Connection Failures

The number of connection failures with the 'NoDesktopAvailable' type.

No Machine Available Connection Failures

The number of connection failures with the 'NoMachineAvailable' type.

No Session To Reconnect Connection Failures

The number of connection failures with the 'NoSessionToReconnect' type.

Non Brokered Session Count (Sessions)

The number of non-brokered sessions associated with the resource.

OS Type

The OS Type of the VDA Machine.

Other Connection Failures

The number of connection failures with the 'Other' type.

Other Session Count (Sessions)

The number of 'other' sessions associated with the resource.

Peak Concurrent Session Count (Sessions)

The peak concurrent sessions associated with the resource.

Pending Session Count (Sessions)

The number of pending sessions associated with the resource.

Preparing Session Count (Sessions)

The number of sessions being prepared that are associated with the resource.

Reconnecting Session Count (Sessions)

The number of reconnecting sessions associated with the resource.

Refused Connection Failures

The number of connection failures with the 'Refused' type.

Registration Timeout Connection Failures

The number of connection failures with the 'RegistrationTimeout' type.

Resource Unavailable Connection Failures

The number of connection failures with the 'ResourceUnavailable' type.

Secure ICA Connection Count (Connections)

The number of secure ICA connections associated with the resource.

Session Capacity (Sessions)

The session capacity based on the underlying VDA machine(s).

Session Count

The Session Count Load Index from the related underlying VDA machine(s).

Session Limit Reached Connection Failures

The number of connection failures with the 'SessionLimitReached' type.

Session Preparation Connection Failures

The number of connection failures with the 'SessionPreparation' type.

Session Utilization (%)

The Session Count Load Index from the related underlying VDA machine(s).

Size (Bytes)

The Size of the logical disk of the VDA.

Spin Up Failed Connection Failures

The number of connection failures with the 'SpinUpFailed' type.

Terminated Session Count (Sessions)

The number of terminated sessions associated with the resource.

Ticketing Connection Failures

The number of connection failures with the 'Ticketing' type.

Total Connection Failures

The total number of connections failures.

Total Physical Memory (Bytes)

The Total size of machine's physical memory.

Total Session Count (Sessions)

The total number of sessions associated with the resource.

Uncategorized Connection Failures

The number of connection failures with the 'None' type.

Unknown Connection Failures

The number of connection failures with the 'Unknown' type.

Unknown Session Count (Sessions)

The number of sessions in an unknown state that are associated with the resource.

Windows Connection Setting

The Windows Connection Setting of the VDA Machine.