1 of 4

Host

Process

Kill

Status

List Host Statuses by Site ID

Retrieve the list of all statuses.

GET/api/Provider/VM/Host/Status

Query parameters

SiteIdinteger (int32)

Site ID of which the sessions will be retrieved (optional)

Serverstring

Filter the result by server name (optional)

Response

Success

Body

namenullable string

Provider name.

servernullable string

FQDN or IP address of the RAS Server.

stateVDIHostState (enum)

VDI Host State

0 = On,1 = OnAgentConnected,2 = Off,3 = Paused,4 = RASTemplate,5 = MaintenanceMode,6 = Cloning,7 = Personalizing,8 = FailedToCreate,-1 = Unknown

connectionVDIHostConn (enum)

VDI Host Connection

0 = Disconnected,1 = Preparing,2 = Waiting,3 = Connected,4 = RASTemplate,-1 = Unknown

templateNamenullable string

Template Name.

templateIDinteger (int32)

Template ID.

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

usernullable string

Provider user name.

ipnullable string

IP of the Provider.

hostIDnullable string

Host ID.

providerIDinteger (int32)

Provider ID.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

logLevelRASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

sessionVDIRDPSession (object)

VDI user session

sessionIDinteger (int32)

RAS session ID.

ipnullable string

Session server IP.

serverIDinteger (int32)

Session server ID.

typeSessionType (enum)

Session Type

0 = Desktop,1 = PublishedApps,2 = Application,3 = VDI,4 = VDIApp,5 = PC,6 = PCApp,7 = Admin,8 = Unknown,9 = RemoteApps,10 = DirectRDP,-1 = All

usernullable string

User to which the session belongs to.

themeIDinteger (int32)

Theme ID.

connectionModeConnMode (enum)

Connection Mode.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode,4 = DirectRDPMode,200 = Unknown

authenticationTypeMainAuthenticationMode (enum)

Main Authentication Mode.

0 = None,1 = Credentials,2 = SCard,3 = SAML

idleStartTimenullable string (date-time)

Session Idle Time.

mfaProviderProviderType (enum)

Provider Type

0 = None,1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

rfiCountinteger (int32)

Flow Information Count.

rfiInfoListnullable array of RouteFlowInfoEntry (object)

Flow Information.

typeRouteFlowHopType (enum)

Route Flow Hop Type.

0 = Unknown,1 = HALBInst,2 = Gateway,3 = ForwardingGateway,4 = HALBDevice,5 = HTML5,6 = Other,7 = AVDGateway

ipnullable string

IP.

logonDurationinteger (int32)

Logon Duration.

connectionDurationinteger (int32)

Connection Duration (in seconds).

authenticationDurationinteger (int32)

Authentication Duration (in seconds).

rasPolicyLookupinteger (int32)

RAS Policy Lookup (in ms).

hostPreparationinteger (int32)

Host Preparation (in ms).

groupPolicyLoadTimeinteger (int32)

Group Policy Load Time (in ms).

userProfileLoadTimeinteger (int32)

User Profile Load Time (in ms).

desktopLoadTimeinteger (int32)

Desktop Load Time (in ms).

logonOthersDurationinteger (int32)

Logon Others Duration (in seconds).

userProfileTypeUserProfileType (enum)

User Profile Type.

0 = Unknown,1 = Others,2 = UPD,3 = FSLogix

uxEvaluatorinteger (int32)

Round Trip Time.

connectionQualityQualityLevel (enum)

Connection Quality Level.

0 = None,1 = Poor,2 = Fair,3 = Good,4 = Excellent

latencyinteger (int32)

Latency.

protocolSessionProtocol (enum)

Session Protocol

0 = Console,2 = RDP,10 = RDP_UDP

bandwidthAvailabilityinteger (int32)

Bandwidth Availability (in Kbps).

lastReconnectsinteger (int32)

Last Reconnects.

reconnectsinteger (int32)

Total Reconnects.

disconnectReasonnullable string

Disconnect Reason.

stateSessionState (enum)

Session State

0 = Active,1 = Connected,2 = ConnectQuery,3 = Shadow,4 = Disconnected,5 = Idle,6 = Listen,7 = Reset,8 = Down,9 = Init,-1 = All

logonTimestring (date-time)

Session Logon Time.

sessionLengthinteger (int32)

Session Length (in seconds).

idleTimeinteger (int32)

Idle Time (in seconds).

incomingDatainteger (int32)

Incoming Data (in bytes).

outgoingDatainteger (int32)

Outgoing Data (in bytes).

verticalResolutioninteger (int32)

Session Vertical Resolution.

horizontalResolutioninteger (int32)

Session Horizontal Resolution.

colourDepthSessionColorDepth (enum)

Session Color Depth

1 = COLOURDEPTH_4BIT,2 = COLOURDEPTH_8BIT,4 = COLOURDEPTH_16BIT,8 = COLOURDEPTH_3BYTE,16 = COLOURDEPTH_15BIT,24 = COLOURDEPTH_24BIT,32 = COLOURDEPTH_32BIT

bandwidthUsageinteger (int32)

Bandwidth Usage.

deviceNamenullable string

Client Device Name.

clientIPAddressnullable string

Client IP Address.

clientOSnullable string

Client OS.

clientOSVersionnullable string

Client OS Version.

clientVersionnullable string

Client Version.

hostIdnullable string

Host ID to which Remote Desktop Session is connected to.

isMaintenanceboolean

Whether the Provider is in maintenance or not.

isTemplateboolean

Whether the Provider is a template or not.

agentStateAgentState (enum)

Agent State

0 = OK,1 = EnumSessionsFailed,2 = RDSRoleDisabled,3 = MaxNonCompletedSessions,4 = RASScheduleInProgress,5 = ConnectionFailed,6 = InvalidCredentials,7 = NeedsSysprep,8 = SysPrepInProgress,9 = CloningFailed,10 = Synchronising,13 = LogonDrainUntilRestart,14 = LogonDrain,15 = LogonDisabled,16 = ForcedDisconnect,17 = CloningCanceled,18 = RASprepInProgress,20 = InstallingRDSRole,21 = RebootPending,22 = PortMismatch,23 = NeedsDowngrade,24 = NotApplied,25 = CloningInProgress,26 = MarkedForDeletion,27 = StandBy,28 = UnsupportedVDIType,29 = FreeESXLicenseNotSupported,30 = ManagedESXNotSupported,32 = InvalidHostVersion,33 = NotJoined,35 = LicenseExpired,36 = JoinBroken,37 = InUse,38 = NotInUse,39 = Unsupported,40 = NoAvailableGateways,41 = EnrollServerNotInitialized,42 = EnrollmentUnavailable,43 = InvalidCAConfig,44 = InvalidEAUserCredentials,45 = InvalidESSettings,46 = FSLogixNotAvail,47 = NoDevices,48 = NeedsAttention,49 = ImageOptimizationPending,50 = ImageOptimization,51 = Unavailable,52 = UnderConstruction,53 = Broken,54 = NonRAS,55 = Provisioning,56 = Invalid,57 = FSLogixNeedsUpdate,58 = NoMembersAvailable,59 = MembersNeedUpdate,60 = FailedPerfCounters,61 = PendingRecreation,62 = RemovingMembers,63 = AddingMembers,64 = DeleteInProgress,66 = JoiningToHostPool,67 = AutoUpgradeInProgress,68 = AutoUpgradeInitiated,-8 = AutoUpgradeLimitReached,-7 = AutoUpgradeFailed,-6 = Unknown,-5 = NeedsUpdate,-4 = NotVerified,-3 = ServerDeleted,-2 = DisabledFromSettings,-1 = Disconnected

Request

Response

List Host Statuses by Provider ID

Retrieve a list of statuses for a specific Provider.

GET/api/Provider/{providerId}/VM/Host/Status

Path parameters

providerId*integer (int32)

The ID of the Provider server.

Response

Success

Body

namenullable string

Provider name.

servernullable string

FQDN or IP address of the RAS Server.

stateVDIHostState (enum)

VDI Host State

0 = On,1 = OnAgentConnected,2 = Off,3 = Paused,4 = RASTemplate,5 = MaintenanceMode,6 = Cloning,7 = Personalizing,8 = FailedToCreate,-1 = Unknown

connectionVDIHostConn (enum)

VDI Host Connection

0 = Disconnected,1 = Preparing,2 = Waiting,3 = Connected,4 = RASTemplate,-1 = Unknown

templateNamenullable string

Template Name.

templateIDinteger (int32)

Template ID.

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

usernullable string

Provider user name.

ipnullable string

IP of the Provider.

hostIDnullable string

Host ID.

providerIDinteger (int32)

Provider ID.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

logLevelRASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

sessionVDIRDPSession (object)

VDI user session

sessionIDinteger (int32)

RAS session ID.

ipnullable string

Session server IP.

serverIDinteger (int32)

Session server ID.

typeSessionType (enum)

Session Type

0 = Desktop,1 = PublishedApps,2 = Application,3 = VDI,4 = VDIApp,5 = PC,6 = PCApp,7 = Admin,8 = Unknown,9 = RemoteApps,10 = DirectRDP,-1 = All

usernullable string

User to which the session belongs to.

themeIDinteger (int32)

Theme ID.

connectionModeConnMode (enum)

Connection Mode.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode,4 = DirectRDPMode,200 = Unknown

authenticationTypeMainAuthenticationMode (enum)

Main Authentication Mode.

0 = None,1 = Credentials,2 = SCard,3 = SAML

idleStartTimenullable string (date-time)

Session Idle Time.

mfaProviderProviderType (enum)

Provider Type

0 = None,1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

rfiCountinteger (int32)

Flow Information Count.

rfiInfoListnullable array of RouteFlowInfoEntry (object)

Flow Information.

typeRouteFlowHopType (enum)

Route Flow Hop Type.

0 = Unknown,1 = HALBInst,2 = Gateway,3 = ForwardingGateway,4 = HALBDevice,5 = HTML5,6 = Other,7 = AVDGateway

ipnullable string

IP.

logonDurationinteger (int32)

Logon Duration.

connectionDurationinteger (int32)

Connection Duration (in seconds).

authenticationDurationinteger (int32)

Authentication Duration (in seconds).

rasPolicyLookupinteger (int32)

RAS Policy Lookup (in ms).

hostPreparationinteger (int32)

Host Preparation (in ms).

groupPolicyLoadTimeinteger (int32)

Group Policy Load Time (in ms).

userProfileLoadTimeinteger (int32)

User Profile Load Time (in ms).

desktopLoadTimeinteger (int32)

Desktop Load Time (in ms).

logonOthersDurationinteger (int32)

Logon Others Duration (in seconds).

userProfileTypeUserProfileType (enum)

User Profile Type.

0 = Unknown,1 = Others,2 = UPD,3 = FSLogix

uxEvaluatorinteger (int32)

Round Trip Time.

connectionQualityQualityLevel (enum)

Connection Quality Level.

0 = None,1 = Poor,2 = Fair,3 = Good,4 = Excellent

latencyinteger (int32)

Latency.

protocolSessionProtocol (enum)

Session Protocol

0 = Console,2 = RDP,10 = RDP_UDP

bandwidthAvailabilityinteger (int32)

Bandwidth Availability (in Kbps).

lastReconnectsinteger (int32)

Last Reconnects.

reconnectsinteger (int32)

Total Reconnects.

disconnectReasonnullable string

Disconnect Reason.

stateSessionState (enum)

Session State

0 = Active,1 = Connected,2 = ConnectQuery,3 = Shadow,4 = Disconnected,5 = Idle,6 = Listen,7 = Reset,8 = Down,9 = Init,-1 = All

logonTimestring (date-time)

Session Logon Time.

sessionLengthinteger (int32)

Session Length (in seconds).

idleTimeinteger (int32)

Idle Time (in seconds).

incomingDatainteger (int32)

Incoming Data (in bytes).

outgoingDatainteger (int32)

Outgoing Data (in bytes).

verticalResolutioninteger (int32)

Session Vertical Resolution.

horizontalResolutioninteger (int32)

Session Horizontal Resolution.

colourDepthSessionColorDepth (enum)

Session Color Depth

1 = COLOURDEPTH_4BIT,2 = COLOURDEPTH_8BIT,4 = COLOURDEPTH_16BIT,8 = COLOURDEPTH_3BYTE,16 = COLOURDEPTH_15BIT,24 = COLOURDEPTH_24BIT,32 = COLOURDEPTH_32BIT

bandwidthUsageinteger (int32)

Bandwidth Usage.

deviceNamenullable string

Client Device Name.

clientIPAddressnullable string

Client IP Address.

clientOSnullable string

Client OS.

clientOSVersionnullable string

Client OS Version.

clientVersionnullable string

Client Version.

hostIdnullable string

Host ID to which Remote Desktop Session is connected to.

isMaintenanceboolean

Whether the Provider is in maintenance or not.

isTemplateboolean

Whether the Provider is a template or not.

agentStateAgentState (enum)

Agent State

Request

Response

Get Host Status

Retrieve a specific Host Status.

GET/api/Provider/{providerId}/VM/{vmId}/Host/Status

Path parameters

providerId*integer (int32)

The ID of the Provider server.

vmId*string

VM ID.

Response

Success

Body

namenullable string

Provider name.

servernullable string

FQDN or IP address of the RAS Server.

stateVDIHostState (enum)

VDI Host State

0 = On,1 = OnAgentConnected,2 = Off,3 = Paused,4 = RASTemplate,5 = MaintenanceMode,6 = Cloning,7 = Personalizing,8 = FailedToCreate,-1 = Unknown

connectionVDIHostConn (enum)

VDI Host Connection

0 = Disconnected,1 = Preparing,2 = Waiting,3 = Connected,4 = RASTemplate,-1 = Unknown

templateNamenullable string

Template Name.

templateIDinteger (int32)

Template ID.

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

usernullable string

Provider user name.

ipnullable string

IP of the Provider.

hostIDnullable string

Host ID.

providerIDinteger (int32)

Provider ID.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

logLevelRASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

sessionVDIRDPSession (object)

VDI user session

sessionIDinteger (int32)

RAS session ID.

ipnullable string

Session server IP.

serverIDinteger (int32)

Session server ID.

typeSessionType (enum)

Session Type

0 = Desktop,1 = PublishedApps,2 = Application,3 = VDI,4 = VDIApp,5 = PC,6 = PCApp,7 = Admin,8 = Unknown,9 = RemoteApps,10 = DirectRDP,-1 = All

usernullable string

User to which the session belongs to.

themeIDinteger (int32)

Theme ID.

connectionModeConnMode (enum)

Connection Mode.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode,4 = DirectRDPMode,200 = Unknown

authenticationTypeMainAuthenticationMode (enum)

Main Authentication Mode.

0 = None,1 = Credentials,2 = SCard,3 = SAML

idleStartTimenullable string (date-time)

Session Idle Time.

mfaProviderProviderType (enum)

Provider Type

0 = None,1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

rfiCountinteger (int32)

Flow Information Count.

rfiInfoListnullable array of RouteFlowInfoEntry (object)

Flow Information.

typeRouteFlowHopType (enum)

Route Flow Hop Type.

0 = Unknown,1 = HALBInst,2 = Gateway,3 = ForwardingGateway,4 = HALBDevice,5 = HTML5,6 = Other,7 = AVDGateway

ipnullable string

IP.

logonDurationinteger (int32)

Logon Duration.

connectionDurationinteger (int32)

Connection Duration (in seconds).

authenticationDurationinteger (int32)

Authentication Duration (in seconds).

rasPolicyLookupinteger (int32)

RAS Policy Lookup (in ms).

hostPreparationinteger (int32)

Host Preparation (in ms).

groupPolicyLoadTimeinteger (int32)

Group Policy Load Time (in ms).

userProfileLoadTimeinteger (int32)

User Profile Load Time (in ms).

desktopLoadTimeinteger (int32)

Desktop Load Time (in ms).

logonOthersDurationinteger (int32)

Logon Others Duration (in seconds).

userProfileTypeUserProfileType (enum)

User Profile Type.

0 = Unknown,1 = Others,2 = UPD,3 = FSLogix

uxEvaluatorinteger (int32)

Round Trip Time.

connectionQualityQualityLevel (enum)

Connection Quality Level.

0 = None,1 = Poor,2 = Fair,3 = Good,4 = Excellent

latencyinteger (int32)

Latency.

protocolSessionProtocol (enum)

Session Protocol

0 = Console,2 = RDP,10 = RDP_UDP

bandwidthAvailabilityinteger (int32)

Bandwidth Availability (in Kbps).

lastReconnectsinteger (int32)

Last Reconnects.

reconnectsinteger (int32)

Total Reconnects.

disconnectReasonnullable string

Disconnect Reason.

stateSessionState (enum)

Session State

0 = Active,1 = Connected,2 = ConnectQuery,3 = Shadow,4 = Disconnected,5 = Idle,6 = Listen,7 = Reset,8 = Down,9 = Init,-1 = All

logonTimestring (date-time)

Session Logon Time.

sessionLengthinteger (int32)

Session Length (in seconds).

idleTimeinteger (int32)

Idle Time (in seconds).

incomingDatainteger (int32)

Incoming Data (in bytes).

outgoingDatainteger (int32)

Outgoing Data (in bytes).

verticalResolutioninteger (int32)

Session Vertical Resolution.

horizontalResolutioninteger (int32)

Session Horizontal Resolution.

colourDepthSessionColorDepth (enum)

Session Color Depth

1 = COLOURDEPTH_4BIT,2 = COLOURDEPTH_8BIT,4 = COLOURDEPTH_16BIT,8 = COLOURDEPTH_3BYTE,16 = COLOURDEPTH_15BIT,24 = COLOURDEPTH_24BIT,32 = COLOURDEPTH_32BIT

bandwidthUsageinteger (int32)

Bandwidth Usage.

deviceNamenullable string

Client Device Name.

clientIPAddressnullable string

Client IP Address.

clientOSnullable string

Client OS.

clientOSVersionnullable string

Client OS Version.

clientVersionnullable string

Client Version.

hostIdnullable string

Host ID to which Remote Desktop Session is connected to.

isMaintenanceboolean

Whether the Provider is in maintenance or not.

isTemplateboolean

Whether the Provider is a template or not.

agentStateAgentState (enum)

Agent State

Request

Response

List

Retrieve the list of all processes for all the VDI Host sessions.

GET/api/Provider/VM/Host/Process

Query parameters

SiteIdinteger (int32)

Site ID from which to retrieve the specified Provider server information (optional).

Serverstring

The name of the Provider server for which to retrieve the information (optional).

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

vdiHostIdnullable string

Host VM ID

Request

Response

List by Provider ID

Retrieve the list of all processes for all the sessions of a specified Provider.

GET/api/Provider/{providerId}/VM/Host/Process

Path parameters

providerId*integer (int32)

The ID of the Provider server.

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

vdiHostIdnullable string

Host VM ID

Request

Response

List by Provider and VM ID

Retrieve the list of all processes for a specified VDI Host of a specified Provider.

GET/api/Provider/{providerId}/VM/{vmId}/Host/Process

Path parameters

providerId*integer (int32)

The ID of the Provider server.

vmId*string

VM ID.

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

vdiHostIdnullable string

Host VM ID

Request

Response

Get

Retrieve a specified process for a specified session of a specified Provider.

GET/api/Provider/{providerId}/VM/{vmId}/Host/Process/{pId}

Path parameters

providerId*integer (int32)

The ID of the Provider server.

vmId*string

VM ID.

pId*integer (int32)

ID of the process to be retrieved

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

vdiHostIdnullable string

Host VM ID

Request

Response

Kill

Invoke the VDI Process Command to send the Kill command to the Process with specified Process ID.

POST/api/Provider/{providerId}/VM/{vmId}/Host/Process/{id}/Kill

Path parameters

providerId*integer (int32)

The ID of the provider.

vmId*string

VM ID.

id*integer (int32)

Process ID.

Response

No Content

Request

Response

Kill

Invoke the VDI Process Command to send the Kill command to the Process with specified Process ID.

POST/api/Provider/{providerId}/VM/{vmId}/Host/Process/{id}/Kill

Path parameters

providerId*integer (int32)

The ID of the provider.

vmId*string

VM ID.

id*integer (int32)

Process ID.

Response

No Content

Request

Response

List by Provider and VM ID

Retrieve the list of all processes for a specified VDI Host of a specified Provider.

GET/api/Provider/{providerId}/VM/{vmId}/Host/Process

Path parameters

providerId*integer (int32)

The ID of the Provider server.

vmId*string

VM ID.

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

vdiHostIdnullable string

Host VM ID

Request

Response

Get

Retrieve a specified process for a specified session of a specified Provider.

GET/api/Provider/{providerId}/VM/{vmId}/Host/Process/{pId}

Path parameters

providerId*integer (int32)

The ID of the Provider server.

vmId*string

VM ID.

pId*integer (int32)

ID of the process to be retrieved

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

vdiHostIdnullable string

Host VM ID

Request

Response

List

Retrieve the list of all processes for all the VDI Host sessions.

GET/api/Provider/VM/Host/Process

Query parameters

SiteIdinteger (int32)

Site ID from which to retrieve the specified Provider server information (optional).

Serverstring

The name of the Provider server for which to retrieve the information (optional).

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

vdiHostIdnullable string

Host VM ID

Request

Response

List by Provider ID

Retrieve the list of all processes for all the sessions of a specified Provider.

GET/api/Provider/{providerId}/VM/Host/Process

Path parameters

providerId*integer (int32)

The ID of the Provider server.

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

vdiHostIdnullable string

Host VM ID

Request

Response

Get Host Status

Retrieve a specific Host Status.

GET/api/Provider/{providerId}/VM/{vmId}/Host/Status

Path parameters

providerId*integer (int32)

The ID of the Provider server.

vmId*string

VM ID.

Response

Success

Body

namenullable string

Provider name.

servernullable string

FQDN or IP address of the RAS Server.

stateVDIHostState (enum)

VDI Host State

0 = On,1 = OnAgentConnected,2 = Off,3 = Paused,4 = RASTemplate,5 = MaintenanceMode,6 = Cloning,7 = Personalizing,8 = FailedToCreate,-1 = Unknown

connectionVDIHostConn (enum)

VDI Host Connection

0 = Disconnected,1 = Preparing,2 = Waiting,3 = Connected,4 = RASTemplate,-1 = Unknown

templateNamenullable string

Template Name.

templateIDinteger (int32)

Template ID.

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

usernullable string

Provider user name.

ipnullable string

IP of the Provider.

hostIDnullable string

Host ID.

providerIDinteger (int32)

Provider ID.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

logLevelRASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

sessionVDIRDPSession (object)

VDI user session

sessionIDinteger (int32)

RAS session ID.

ipnullable string

Session server IP.

serverIDinteger (int32)

Session server ID.

typeSessionType (enum)

Session Type

0 = Desktop,1 = PublishedApps,2 = Application,3 = VDI,4 = VDIApp,5 = PC,6 = PCApp,7 = Admin,8 = Unknown,9 = RemoteApps,10 = DirectRDP,-1 = All

usernullable string

User to which the session belongs to.

themeIDinteger (int32)

Theme ID.

connectionModeConnMode (enum)

Connection Mode.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode,4 = DirectRDPMode,200 = Unknown

authenticationTypeMainAuthenticationMode (enum)

Main Authentication Mode.

0 = None,1 = Credentials,2 = SCard,3 = SAML

idleStartTimenullable string (date-time)

Session Idle Time.

mfaProviderProviderType (enum)

Provider Type

0 = None,1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

rfiCountinteger (int32)

Flow Information Count.

rfiInfoListnullable array of RouteFlowInfoEntry (object)

Flow Information.

typeRouteFlowHopType (enum)

Route Flow Hop Type.

0 = Unknown,1 = HALBInst,2 = Gateway,3 = ForwardingGateway,4 = HALBDevice,5 = HTML5,6 = Other,7 = AVDGateway

ipnullable string

IP.

logonDurationinteger (int32)

Logon Duration.

connectionDurationinteger (int32)

Connection Duration (in seconds).

authenticationDurationinteger (int32)

Authentication Duration (in seconds).

rasPolicyLookupinteger (int32)

RAS Policy Lookup (in ms).

hostPreparationinteger (int32)

Host Preparation (in ms).

groupPolicyLoadTimeinteger (int32)

Group Policy Load Time (in ms).

userProfileLoadTimeinteger (int32)

User Profile Load Time (in ms).

desktopLoadTimeinteger (int32)

Desktop Load Time (in ms).

logonOthersDurationinteger (int32)

Logon Others Duration (in seconds).

userProfileTypeUserProfileType (enum)

User Profile Type.

0 = Unknown,1 = Others,2 = UPD,3 = FSLogix

uxEvaluatorinteger (int32)

Round Trip Time.

connectionQualityQualityLevel (enum)

Connection Quality Level.

0 = None,1 = Poor,2 = Fair,3 = Good,4 = Excellent

latencyinteger (int32)

Latency.

protocolSessionProtocol (enum)

Session Protocol

0 = Console,2 = RDP,10 = RDP_UDP

bandwidthAvailabilityinteger (int32)

Bandwidth Availability (in Kbps).

lastReconnectsinteger (int32)

Last Reconnects.

reconnectsinteger (int32)

Total Reconnects.

disconnectReasonnullable string

Disconnect Reason.

stateSessionState (enum)

Session State

0 = Active,1 = Connected,2 = ConnectQuery,3 = Shadow,4 = Disconnected,5 = Idle,6 = Listen,7 = Reset,8 = Down,9 = Init,-1 = All

logonTimestring (date-time)

Session Logon Time.

sessionLengthinteger (int32)

Session Length (in seconds).

idleTimeinteger (int32)

Idle Time (in seconds).

incomingDatainteger (int32)

Incoming Data (in bytes).

outgoingDatainteger (int32)

Outgoing Data (in bytes).

verticalResolutioninteger (int32)

Session Vertical Resolution.

horizontalResolutioninteger (int32)

Session Horizontal Resolution.

colourDepthSessionColorDepth (enum)

Session Color Depth

1 = COLOURDEPTH_4BIT,2 = COLOURDEPTH_8BIT,4 = COLOURDEPTH_16BIT,8 = COLOURDEPTH_3BYTE,16 = COLOURDEPTH_15BIT,24 = COLOURDEPTH_24BIT,32 = COLOURDEPTH_32BIT

bandwidthUsageinteger (int32)

Bandwidth Usage.

deviceNamenullable string

Client Device Name.

clientIPAddressnullable string

Client IP Address.

clientOSnullable string

Client OS.

clientOSVersionnullable string

Client OS Version.

clientVersionnullable string

Client Version.

hostIdnullable string

Host ID to which Remote Desktop Session is connected to.

isMaintenanceboolean

Whether the Provider is in maintenance or not.

isTemplateboolean

Whether the Provider is a template or not.

agentStateAgentState (enum)

Agent State

Request

Response

List Host Statuses by Provider ID

Retrieve a list of statuses for a specific Provider.

GET/api/Provider/{providerId}/VM/Host/Status

Path parameters

providerId*integer (int32)

The ID of the Provider server.

Response

Success

Body

namenullable string

Provider name.

servernullable string

FQDN or IP address of the RAS Server.

stateVDIHostState (enum)

VDI Host State

0 = On,1 = OnAgentConnected,2 = Off,3 = Paused,4 = RASTemplate,5 = MaintenanceMode,6 = Cloning,7 = Personalizing,8 = FailedToCreate,-1 = Unknown

connectionVDIHostConn (enum)

VDI Host Connection

0 = Disconnected,1 = Preparing,2 = Waiting,3 = Connected,4 = RASTemplate,-1 = Unknown

templateNamenullable string

Template Name.

templateIDinteger (int32)

Template ID.

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

usernullable string

Provider user name.

ipnullable string

IP of the Provider.

hostIDnullable string

Host ID.

providerIDinteger (int32)

Provider ID.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

logLevelRASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

sessionVDIRDPSession (object)

VDI user session

sessionIDinteger (int32)

RAS session ID.

ipnullable string

Session server IP.

serverIDinteger (int32)

Session server ID.

typeSessionType (enum)

Session Type

0 = Desktop,1 = PublishedApps,2 = Application,3 = VDI,4 = VDIApp,5 = PC,6 = PCApp,7 = Admin,8 = Unknown,9 = RemoteApps,10 = DirectRDP,-1 = All

usernullable string

User to which the session belongs to.

themeIDinteger (int32)

Theme ID.

connectionModeConnMode (enum)

Connection Mode.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode,4 = DirectRDPMode,200 = Unknown

authenticationTypeMainAuthenticationMode (enum)

Main Authentication Mode.

0 = None,1 = Credentials,2 = SCard,3 = SAML

idleStartTimenullable string (date-time)

Session Idle Time.

mfaProviderProviderType (enum)

Provider Type

0 = None,1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

rfiCountinteger (int32)

Flow Information Count.

rfiInfoListnullable array of RouteFlowInfoEntry (object)

Flow Information.

typeRouteFlowHopType (enum)

Route Flow Hop Type.

0 = Unknown,1 = HALBInst,2 = Gateway,3 = ForwardingGateway,4 = HALBDevice,5 = HTML5,6 = Other,7 = AVDGateway

ipnullable string

IP.

logonDurationinteger (int32)

Logon Duration.

connectionDurationinteger (int32)

Connection Duration (in seconds).

authenticationDurationinteger (int32)

Authentication Duration (in seconds).

rasPolicyLookupinteger (int32)

RAS Policy Lookup (in ms).

hostPreparationinteger (int32)

Host Preparation (in ms).

groupPolicyLoadTimeinteger (int32)

Group Policy Load Time (in ms).

userProfileLoadTimeinteger (int32)

User Profile Load Time (in ms).

desktopLoadTimeinteger (int32)

Desktop Load Time (in ms).

logonOthersDurationinteger (int32)

Logon Others Duration (in seconds).

userProfileTypeUserProfileType (enum)

User Profile Type.

0 = Unknown,1 = Others,2 = UPD,3 = FSLogix

uxEvaluatorinteger (int32)

Round Trip Time.

connectionQualityQualityLevel (enum)

Connection Quality Level.

0 = None,1 = Poor,2 = Fair,3 = Good,4 = Excellent

latencyinteger (int32)

Latency.

protocolSessionProtocol (enum)

Session Protocol

0 = Console,2 = RDP,10 = RDP_UDP

bandwidthAvailabilityinteger (int32)

Bandwidth Availability (in Kbps).

lastReconnectsinteger (int32)

Last Reconnects.

reconnectsinteger (int32)

Total Reconnects.

disconnectReasonnullable string

Disconnect Reason.

stateSessionState (enum)

Session State

0 = Active,1 = Connected,2 = ConnectQuery,3 = Shadow,4 = Disconnected,5 = Idle,6 = Listen,7 = Reset,8 = Down,9 = Init,-1 = All

logonTimestring (date-time)

Session Logon Time.

sessionLengthinteger (int32)

Session Length (in seconds).

idleTimeinteger (int32)

Idle Time (in seconds).

incomingDatainteger (int32)

Incoming Data (in bytes).

outgoingDatainteger (int32)

Outgoing Data (in bytes).

verticalResolutioninteger (int32)

Session Vertical Resolution.

horizontalResolutioninteger (int32)

Session Horizontal Resolution.

colourDepthSessionColorDepth (enum)

Session Color Depth

1 = COLOURDEPTH_4BIT,2 = COLOURDEPTH_8BIT,4 = COLOURDEPTH_16BIT,8 = COLOURDEPTH_3BYTE,16 = COLOURDEPTH_15BIT,24 = COLOURDEPTH_24BIT,32 = COLOURDEPTH_32BIT

bandwidthUsageinteger (int32)

Bandwidth Usage.

deviceNamenullable string

Client Device Name.

clientIPAddressnullable string

Client IP Address.

clientOSnullable string

Client OS.

clientOSVersionnullable string

Client OS Version.

clientVersionnullable string

Client Version.

hostIdnullable string

Host ID to which Remote Desktop Session is connected to.

isMaintenanceboolean

Whether the Provider is in maintenance or not.

isTemplateboolean

Whether the Provider is a template or not.

agentStateAgentState (enum)

Agent State

Request

Response

List Host Statuses by Site ID

Retrieve the list of all statuses.

GET/api/Provider/VM/Host/Status

Query parameters

SiteIdinteger (int32)

Site ID of which the sessions will be retrieved (optional)

Serverstring

Filter the result by server name (optional)

Response

Success

Body

namenullable string

Provider name.

servernullable string

FQDN or IP address of the RAS Server.

stateVDIHostState (enum)

VDI Host State

0 = On,1 = OnAgentConnected,2 = Off,3 = Paused,4 = RASTemplate,5 = MaintenanceMode,6 = Cloning,7 = Personalizing,8 = FailedToCreate,-1 = Unknown

connectionVDIHostConn (enum)

VDI Host Connection

0 = Disconnected,1 = Preparing,2 = Waiting,3 = Connected,4 = RASTemplate,-1 = Unknown

templateNamenullable string

Template Name.

templateIDinteger (int32)

Template ID.

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

usernullable string

Provider user name.

ipnullable string

IP of the Provider.

hostIDnullable string

Host ID.

providerIDinteger (int32)

Provider ID.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

logLevelRASLogLevel (enum)

RAS Log Level

0 = Critical,1 = Error,2 = Warning,3 = Standard,4 = Extended,5 = Verbose,-1 = None

sessionVDIRDPSession (object)

VDI user session

sessionIDinteger (int32)

RAS session ID.

ipnullable string

Session server IP.

serverIDinteger (int32)

Session server ID.

typeSessionType (enum)

Session Type

0 = Desktop,1 = PublishedApps,2 = Application,3 = VDI,4 = VDIApp,5 = PC,6 = PCApp,7 = Admin,8 = Unknown,9 = RemoteApps,10 = DirectRDP,-1 = All

usernullable string

User to which the session belongs to.

themeIDinteger (int32)

Theme ID.

connectionModeConnMode (enum)

Connection Mode.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode,4 = DirectRDPMode,200 = Unknown

authenticationTypeMainAuthenticationMode (enum)

Main Authentication Mode.

0 = None,1 = Credentials,2 = SCard,3 = SAML

idleStartTimenullable string (date-time)

Session Idle Time.

mfaProviderProviderType (enum)

Provider Type

0 = None,1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

rfiCountinteger (int32)

Flow Information Count.

rfiInfoListnullable array of RouteFlowInfoEntry (object)

Flow Information.

typeRouteFlowHopType (enum)

Route Flow Hop Type.

0 = Unknown,1 = HALBInst,2 = Gateway,3 = ForwardingGateway,4 = HALBDevice,5 = HTML5,6 = Other,7 = AVDGateway

ipnullable string

IP.

logonDurationinteger (int32)

Logon Duration.

connectionDurationinteger (int32)

Connection Duration (in seconds).

authenticationDurationinteger (int32)

Authentication Duration (in seconds).

rasPolicyLookupinteger (int32)

RAS Policy Lookup (in ms).

hostPreparationinteger (int32)

Host Preparation (in ms).

groupPolicyLoadTimeinteger (int32)

Group Policy Load Time (in ms).

userProfileLoadTimeinteger (int32)

User Profile Load Time (in ms).

desktopLoadTimeinteger (int32)

Desktop Load Time (in ms).

logonOthersDurationinteger (int32)

Logon Others Duration (in seconds).

userProfileTypeUserProfileType (enum)

User Profile Type.

0 = Unknown,1 = Others,2 = UPD,3 = FSLogix

uxEvaluatorinteger (int32)

Round Trip Time.

connectionQualityQualityLevel (enum)

Connection Quality Level.

0 = None,1 = Poor,2 = Fair,3 = Good,4 = Excellent

latencyinteger (int32)

Latency.

protocolSessionProtocol (enum)

Session Protocol

0 = Console,2 = RDP,10 = RDP_UDP

bandwidthAvailabilityinteger (int32)

Bandwidth Availability (in Kbps).

lastReconnectsinteger (int32)

Last Reconnects.

reconnectsinteger (int32)

Total Reconnects.

disconnectReasonnullable string

Disconnect Reason.

stateSessionState (enum)

Session State

0 = Active,1 = Connected,2 = ConnectQuery,3 = Shadow,4 = Disconnected,5 = Idle,6 = Listen,7 = Reset,8 = Down,9 = Init,-1 = All

logonTimestring (date-time)

Session Logon Time.

sessionLengthinteger (int32)

Session Length (in seconds).

idleTimeinteger (int32)

Idle Time (in seconds).

incomingDatainteger (int32)

Incoming Data (in bytes).

outgoingDatainteger (int32)

Outgoing Data (in bytes).

verticalResolutioninteger (int32)

Session Vertical Resolution.

horizontalResolutioninteger (int32)

Session Horizontal Resolution.

colourDepthSessionColorDepth (enum)

Session Color Depth

1 = COLOURDEPTH_4BIT,2 = COLOURDEPTH_8BIT,4 = COLOURDEPTH_16BIT,8 = COLOURDEPTH_3BYTE,16 = COLOURDEPTH_15BIT,24 = COLOURDEPTH_24BIT,32 = COLOURDEPTH_32BIT

bandwidthUsageinteger (int32)

Bandwidth Usage.

deviceNamenullable string

Client Device Name.

clientIPAddressnullable string

Client IP Address.

clientOSnullable string

Client OS.

clientOSVersionnullable string

Client OS Version.

clientVersionnullable string

Client Version.

hostIdnullable string

Host ID to which Remote Desktop Session is connected to.

isMaintenanceboolean

Whether the Provider is in maintenance or not.

isTemplateboolean

Whether the Provider is a template or not.

agentStateAgentState (enum)

Agent State

Request

Response

const response = await fetch('/api/Provider/{providerId}/VM/{vmId}/Host/Process/{id}/Kill', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/Provider/{providerId}/VM/{vmId}/Host/Process', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "name": "text",
    "appName": "text",
    "process": "text",
    "user": "text",
    "vdiHostId": "text"
  }
]

const response = await fetch('/api/Provider/{providerId}/VM/{vmId}/Host/Process/{pId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "name": "text",
  "appName": "text",
  "process": "text",
  "user": "text",
  "vdiHostId": "text"
}

const response = await fetch('/api/Provider/VM/Host/Process', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "name": "text",
    "appName": "text",
    "process": "text",
    "user": "text",
    "vdiHostId": "text"
  }
]

const response = await fetch('/api/Provider/{providerId}/VM/Host/Process', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "name": "text",
    "appName": "text",
    "process": "text",
    "user": "text",
    "vdiHostId": "text"
  }
]

const response = await fetch('/api/Provider/{providerId}/VM/{vmId}/Host/Status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "name": "text",
  "server": "text",
  "state": [
    "0 = On",
    "1 = OnAgentConnected",
    "2 = Off",
    "3 = Paused",
    "4 = RASTemplate",
    "5 = MaintenanceMode",
    "6 = Cloning",
    "7 = Personalizing",
    "8 = FailedToCreate",
    "-1 = Unknown"
  ],
  "connection": [
    "0 = Disconnected",
    "1 = Preparing",
    "2 = Waiting",
    "3 = Connected",
    "4 = RASTemplate",
    "-1 = Unknown"
  ],
  "templateName": "text",
  "templateType": [
    "0 = SingleSession",
    "1 = MultiSession"
  ],
  "user": "text",
  "ip": "text",
  "hostID": "text",
  "serviceStartTime": "text",
  "systemBootTime": "text",
  "logLevel": [
    "0 = Critical",
    "1 = Error",
    "2 = Warning",
    "3 = Standard",
    "4 = Extended",
    "5 = Verbose",
    "-1 = None"
  ],
  "session": {
    "ip": "text",
    "type": [
      "0 = Desktop",
      "1 = PublishedApps",
      "2 = Application",
      "3 = VDI",
      "4 = VDIApp",
      "5 = PC",
      "6 = PCApp",
      "7 = Admin",
      "8 = Unknown",
      "9 = RemoteApps",
      "10 = DirectRDP",
      "-1 = All"
    ],
    "user": "text",
    "connectionMode": [
      "0 = GatewayMode",
      "1 = DirectMode",
      "2 = GatewaySSLMode",
      "3 = DirectSSLMode",
      "4 = DirectRDPMode",
      "200 = Unknown"
    ],
    "authenticationType": [
      "0 = None",
      "1 = Credentials",
      "2 = SCard",
      "3 = SAML"
    ],
    "idleStartTime": "2024-11-07T09:56:29.432Z",
    "mfaProvider": [
      "0 = None",
      "1 = Deepnet",
      "2 = SafeNet",
      "3 = Radius",
      "4 = AzureRadius",
      "5 = DuoRadius",
      "6 = FortiRadius",
      "7 = TekRadius",
      "8 = GAuthTOTP",
      "9 = TOTP",
      "10 = MicrosoftTOTP",
      "11 = EmailOTP"
    ],
    "rfiInfoList": [
      {
        "type": [
          "0 = Unknown",
          "1 = HALBInst",
          "2 = Gateway",
          "3 = ForwardingGateway",
          "4 = HALBDevice",
          "5 = HTML5",
          "6 = Other",
          "7 = AVDGateway"
        ],
        "ip": "text"
      }
    ],
    "userProfileType": [
      "0 = Unknown",
      "1 = Others",
      "2 = UPD",
      "3 = FSLogix"
    ],
    "connectionQuality": [
      "0 = None",
      "1 = Poor",
      "2 = Fair",
      "3 = Good",
      "4 = Excellent"
    ],
    "protocol": [
      "0 = Console",
      "2 = RDP",
      "10 = RDP_UDP"
    ],
    "disconnectReason": "text",
    "state": [
      "0 = Active",
      "1 = Connected",
      "2 = ConnectQuery",
      "3 = Shadow",
      "4 = Disconnected",
      "5 = Idle",
      "6 = Listen",
      "7 = Reset",
      "8 = Down",
      "9 = Init",
      "-1 = All"
    ],
    "logonTime": "2024-11-07T09:56:29.432Z",
    "colourDepth": [
      "1 = COLOURDEPTH_4BIT",
      "2 = COLOURDEPTH_8BIT",
      "4 = COLOURDEPTH_16BIT",
      "8 = COLOURDEPTH_3BYTE",
      "16 = COLOURDEPTH_15BIT",
      "24 = COLOURDEPTH_24BIT",
      "32 = COLOURDEPTH_32BIT"
    ],
    "deviceName": "text",
    "clientIPAddress": "text",
    "clientOS": "text",
    "clientOSVersion": "text",
    "clientVersion": "text",
    "hostId": "text"
  },
  "isMaintenance": false,
  "isTemplate": false,
  "agentState": [
    "0 = OK",
    "1 = EnumSessionsFailed",
    "2 = RDSRoleDisabled",
    "3 = MaxNonCompletedSessions",
    "4 = RASScheduleInProgress",
    "5 = ConnectionFailed",
    "6 = InvalidCredentials",
    "7 = NeedsSysprep",
    "8 = SysPrepInProgress",
    "9 = CloningFailed",
    "10 = Synchronising",
    "13 = LogonDrainUntilRestart",
    "14 = LogonDrain",
    "15 = LogonDisabled",
    "16 = ForcedDisconnect",
    "17 = CloningCanceled",
    "18 = RASprepInProgress",
    "20 = InstallingRDSRole",
    "21 = RebootPending",
    "22 = PortMismatch",
    "23 = NeedsDowngrade",
    "24 = NotApplied",
    "25 = CloningInProgress",
    "26 = MarkedForDeletion",
    "27 = StandBy",
    "28 = UnsupportedVDIType",
    "29 = FreeESXLicenseNotSupported",
    "30 = ManagedESXNotSupported",
    "32 = InvalidHostVersion",
    "33 = NotJoined",
    "35 = LicenseExpired",
    "36 = JoinBroken",
    "37 = InUse",
    "38 = NotInUse",
    "39 = Unsupported",
    "40 = NoAvailableGateways",
    "41 = EnrollServerNotInitialized",
    "42 = EnrollmentUnavailable",
    "43 = InvalidCAConfig",
    "44 = InvalidEAUserCredentials",
    "45 = InvalidESSettings",
    "46 = FSLogixNotAvail",
    "47 = NoDevices",
    "48 = NeedsAttention",
    "49 = ImageOptimizationPending",
    "50 = ImageOptimization",
    "51 = Unavailable",
    "52 = UnderConstruction",
    "53 = Broken",
    "54 = NonRAS",
    "55 = Provisioning",
    "56 = Invalid",
    "57 = FSLogixNeedsUpdate",
    "58 = NoMembersAvailable",
    "59 = MembersNeedUpdate",
    "60 = FailedPerfCounters",
    "61 = PendingRecreation",
    "62 = RemovingMembers",
    "63 = AddingMembers",
    "64 = DeleteInProgress",
    "66 = JoiningToHostPool",
    "67 = AutoUpgradeInProgress",
    "68 = AutoUpgradeInitiated",
    "-8 = AutoUpgradeLimitReached",
    "-7 = AutoUpgradeFailed",
    "-6 = Unknown",
    "-5 = NeedsUpdate",
    "-4 = NotVerified",
    "-3 = ServerDeleted",
    "-2 = DisabledFromSettings",
    "-1 = Disconnected"
  ]
}

const response = await fetch('/api/Provider/{providerId}/VM/Host/Status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "name": "text",
    "server": "text",
    "state": [
      "0 = On",
      "1 = OnAgentConnected",
      "2 = Off",
      "3 = Paused",
      "4 = RASTemplate",
      "5 = MaintenanceMode",
      "6 = Cloning",
      "7 = Personalizing",
      "8 = FailedToCreate",
      "-1 = Unknown"
    ],
    "connection": [
      "0 = Disconnected",
      "1 = Preparing",
      "2 = Waiting",
      "3 = Connected",
      "4 = RASTemplate",
      "-1 = Unknown"
    ],
    "templateName": "text",
    "templateType": [
      "0 = SingleSession",
      "1 = MultiSession"
    ],
    "user": "text",
    "ip": "text",
    "hostID": "text",
    "serviceStartTime": "text",
    "systemBootTime": "text",
    "logLevel": [
      "0 = Critical",
      "1 = Error",
      "2 = Warning",
      "3 = Standard",
      "4 = Extended",
      "5 = Verbose",
      "-1 = None"
    ],
    "session": {
      "ip": "text",
      "type": [
        "0 = Desktop",
        "1 = PublishedApps",
        "2 = Application",
        "3 = VDI",
        "4 = VDIApp",
        "5 = PC",
        "6 = PCApp",
        "7 = Admin",
        "8 = Unknown",
        "9 = RemoteApps",
        "10 = DirectRDP",
        "-1 = All"
      ],
      "user": "text",
      "connectionMode": [
        "0 = GatewayMode",
        "1 = DirectMode",
        "2 = GatewaySSLMode",
        "3 = DirectSSLMode",
        "4 = DirectRDPMode",
        "200 = Unknown"
      ],
      "authenticationType": [
        "0 = None",
        "1 = Credentials",
        "2 = SCard",
        "3 = SAML"
      ],
      "idleStartTime": "2024-11-07T09:56:29.432Z",
      "mfaProvider": [
        "0 = None",
        "1 = Deepnet",
        "2 = SafeNet",
        "3 = Radius",
        "4 = AzureRadius",
        "5 = DuoRadius",
        "6 = FortiRadius",
        "7 = TekRadius",
        "8 = GAuthTOTP",
        "9 = TOTP",
        "10 = MicrosoftTOTP",
        "11 = EmailOTP"
      ],
      "rfiInfoList": [
        {
          "type": [
            "0 = Unknown",
            "1 = HALBInst",
            "2 = Gateway",
            "3 = ForwardingGateway",
            "4 = HALBDevice",
            "5 = HTML5",
            "6 = Other",
            "7 = AVDGateway"
          ],
          "ip": "text"
        }
      ],
      "userProfileType": [
        "0 = Unknown",
        "1 = Others",
        "2 = UPD",
        "3 = FSLogix"
      ],
      "connectionQuality": [
        "0 = None",
        "1 = Poor",
        "2 = Fair",
        "3 = Good",
        "4 = Excellent"
      ],
      "protocol": [
        "0 = Console",
        "2 = RDP",
        "10 = RDP_UDP"
      ],
      "disconnectReason": "text",
      "state": [
        "0 = Active",
        "1 = Connected",
        "2 = ConnectQuery",
        "3 = Shadow",
        "4 = Disconnected",
        "5 = Idle",
        "6 = Listen",
        "7 = Reset",
        "8 = Down",
        "9 = Init",
        "-1 = All"
      ],
      "logonTime": "2024-11-07T09:56:29.432Z",
      "colourDepth": [
        "1 = COLOURDEPTH_4BIT",
        "2 = COLOURDEPTH_8BIT",
        "4 = COLOURDEPTH_16BIT",
        "8 = COLOURDEPTH_3BYTE",
        "16 = COLOURDEPTH_15BIT",
        "24 = COLOURDEPTH_24BIT",
        "32 = COLOURDEPTH_32BIT"
      ],
      "deviceName": "text",
      "clientIPAddress": "text",
      "clientOS": "text",
      "clientOSVersion": "text",
      "clientVersion": "text",
      "hostId": "text"
    },
    "isMaintenance": false,
    "isTemplate": false,
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ]
  }
]

const response = await fetch('/api/Provider/VM/Host/Status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "name": "text",
    "server": "text",
    "state": [
      "0 = On",
      "1 = OnAgentConnected",
      "2 = Off",
      "3 = Paused",
      "4 = RASTemplate",
      "5 = MaintenanceMode",
      "6 = Cloning",
      "7 = Personalizing",
      "8 = FailedToCreate",
      "-1 = Unknown"
    ],
    "connection": [
      "0 = Disconnected",
      "1 = Preparing",
      "2 = Waiting",
      "3 = Connected",
      "4 = RASTemplate",
      "-1 = Unknown"
    ],
    "templateName": "text",
    "templateType": [
      "0 = SingleSession",
      "1 = MultiSession"
    ],
    "user": "text",
    "ip": "text",
    "hostID": "text",
    "serviceStartTime": "text",
    "systemBootTime": "text",
    "logLevel": [
      "0 = Critical",
      "1 = Error",
      "2 = Warning",
      "3 = Standard",
      "4 = Extended",
      "5 = Verbose",
      "-1 = None"
    ],
    "session": {
      "ip": "text",
      "type": [
        "0 = Desktop",
        "1 = PublishedApps",
        "2 = Application",
        "3 = VDI",
        "4 = VDIApp",
        "5 = PC",
        "6 = PCApp",
        "7 = Admin",
        "8 = Unknown",
        "9 = RemoteApps",
        "10 = DirectRDP",
        "-1 = All"
      ],
      "user": "text",
      "connectionMode": [
        "0 = GatewayMode",
        "1 = DirectMode",
        "2 = GatewaySSLMode",
        "3 = DirectSSLMode",
        "4 = DirectRDPMode",
        "200 = Unknown"
      ],
      "authenticationType": [
        "0 = None",
        "1 = Credentials",
        "2 = SCard",
        "3 = SAML"
      ],
      "idleStartTime": "2024-11-07T09:56:29.432Z",
      "mfaProvider": [
        "0 = None",
        "1 = Deepnet",
        "2 = SafeNet",
        "3 = Radius",
        "4 = AzureRadius",
        "5 = DuoRadius",
        "6 = FortiRadius",
        "7 = TekRadius",
        "8 = GAuthTOTP",
        "9 = TOTP",
        "10 = MicrosoftTOTP",
        "11 = EmailOTP"
      ],
      "rfiInfoList": [
        {
          "type": [
            "0 = Unknown",
            "1 = HALBInst",
            "2 = Gateway",
            "3 = ForwardingGateway",
            "4 = HALBDevice",
            "5 = HTML5",
            "6 = Other",
            "7 = AVDGateway"
          ],
          "ip": "text"
        }
      ],
      "userProfileType": [
        "0 = Unknown",
        "1 = Others",
        "2 = UPD",
        "3 = FSLogix"
      ],
      "connectionQuality": [
        "0 = None",
        "1 = Poor",
        "2 = Fair",
        "3 = Good",
        "4 = Excellent"
      ],
      "protocol": [
        "0 = Console",
        "2 = RDP",
        "10 = RDP_UDP"
      ],
      "disconnectReason": "text",
      "state": [
        "0 = Active",
        "1 = Connected",
        "2 = ConnectQuery",
        "3 = Shadow",
        "4 = Disconnected",
        "5 = Idle",
        "6 = Listen",
        "7 = Reset",
        "8 = Down",
        "9 = Init",
        "-1 = All"
      ],
      "logonTime": "2024-11-07T09:56:29.432Z",
      "colourDepth": [
        "1 = COLOURDEPTH_4BIT",
        "2 = COLOURDEPTH_8BIT",
        "4 = COLOURDEPTH_16BIT",
        "8 = COLOURDEPTH_3BYTE",
        "16 = COLOURDEPTH_15BIT",
        "24 = COLOURDEPTH_24BIT",
        "32 = COLOURDEPTH_32BIT"
      ],
      "deviceName": "text",
      "clientIPAddress": "text",
      "clientOS": "text",
      "clientOSVersion": "text",
      "clientVersion": "text",
      "hostId": "text"
    },
    "isMaintenance": false,
    "isTemplate": false,
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ]
  }
]