Status

List

Retrieve a list of RD Session Host servers with status information.

GET/api/RDS/Host/status

Query parameters

SiteIdinteger (int32)

Site ID for which RD Session Host servers with status information will be retrieved (optional)

Serverstring

Filter the result by server name (optional)

Response

Success

Body

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

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

serverTypeRASServerType (enum)

RAS Status Type

1 = RDSHost,2 = Provider,3 = Gateway,4 = Guest,7 = PA,9 = Site,16 = RDSGroup,25 = HALBDevice,45 = TenantBroker,46 = Enrollment,51 = HALB,64 = AVDWorkspace,65 = AVDHostPool,66 = AVDTemplate,67 = AVDHost,95 = VDITemplateVersion,96 = AVDTemplateVersion,97 = RDSTemplateVersion,107 = RDSTemplate,108 = VDITemplate,2013 = VDIHost,-1 = All

agentVernullable string

Agent Version.

servernullable string

Server name.

serverOSnullable string

Server Operating System.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

machineIdnullable string

Id of the machine

logLevelRASLogLevel (enum)

RAS Log Level

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

cpuLoadinteger (int32)

CPU load percentage.

memLoadinteger (int32)

Memory load percentage.

diskReadinteger (int32)

Disk Read.

diskWriteinteger (int32)

Disk Write.

enabledboolean

Whether the object is enabled or not.

preferredBrokernullable string

Specifies the preferred Connection Broker.

activeSessionsinteger (int32)

Number of active sessions.

disconnectedSessionsinteger (int32)

Number of disconnected sessions.

activeConnectionsinteger (int32)

Number of active connections.

ipnullable string

The IP the agent is using.

loginStatusSessionLoginStatus (enum)

Session Login Status on the Remote Desktop Service

0 = Enabled,1 = Disabled,2 = DrainMode,3 = DrainUntilReboot

updStatusSessionUPDStatus (enum)

User profile disk status

0 = Enabled,1 = Disabled,2 = NotSupported

pendingSchedulePendingScheduleType (enum)

Pending Schedule Type

0 = None,1 = DisabledState,2 = Reboot

appPackageStatusesnullable array of AppPackageStatus (object)

The Application Packages statuses.

namenullable string

The Application Package name.

statusAppPackageRegistrationStatus (enum)

Application Package Registration Status

0 = ImageMountingFailed,1 = StagingFailed,2 = StagingSuccessful,3 = Unsupported,-1 = NotApplied

Request

Response

Get

Retrieve the RD Session Host status information for the server.

GET/api/RDS/Host/{id}/status

Path parameters

id*integer (int32)

RD Session Host ID

Response

Success

Body

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

serverTypeRASServerType (enum)

RAS Status Type

agentVernullable string

Agent Version.

servernullable string

Server name.

serverOSnullable string

Server Operating System.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

machineIdnullable string

Id of the machine

logLevelRASLogLevel (enum)

RAS Log Level

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

cpuLoadinteger (int32)

CPU load percentage.

memLoadinteger (int32)

Memory load percentage.

diskReadinteger (int32)

Disk Read.

diskWriteinteger (int32)

Disk Write.

enabledboolean

Whether the object is enabled or not.

preferredBrokernullable string

Specifies the preferred Connection Broker.

activeSessionsinteger (int32)

Number of active sessions.

disconnectedSessionsinteger (int32)

Number of disconnected sessions.

activeConnectionsinteger (int32)

Number of active connections.

ipnullable string

The IP the agent is using.

loginStatusSessionLoginStatus (enum)

Session Login Status on the Remote Desktop Service

0 = Enabled,1 = Disabled,2 = DrainMode,3 = DrainUntilReboot

updStatusSessionUPDStatus (enum)

User profile disk status

0 = Enabled,1 = Disabled,2 = NotSupported

pendingSchedulePendingScheduleType (enum)

Pending Schedule Type

0 = None,1 = DisabledState,2 = Reboot

appPackageStatusesnullable array of AppPackageStatus (object)

The Application Packages statuses.

namenullable string

The Application Package name.

statusAppPackageRegistrationStatus (enum)

Application Package Registration Status

0 = ImageMountingFailed,1 = StagingFailed,2 = StagingSuccessful,3 = Unsupported,-1 = NotApplied

Request

Response

List

Retrieve a list of RD Session Host servers with status information.

GET/api/RDS/Host/status

Query parameters

SiteIdinteger (int32)

Site ID for which RD Session Host servers with status information will be retrieved (optional)

Serverstring

Filter the result by server name (optional)

Response

Success

Body

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

serverTypeRASServerType (enum)

RAS Status Type

agentVernullable string

Agent Version.

servernullable string

Server name.

serverOSnullable string

Server Operating System.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

machineIdnullable string

Id of the machine

logLevelRASLogLevel (enum)

RAS Log Level

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

cpuLoadinteger (int32)

CPU load percentage.

memLoadinteger (int32)

Memory load percentage.

diskReadinteger (int32)

Disk Read.

diskWriteinteger (int32)

Disk Write.

enabledboolean

Whether the object is enabled or not.

preferredBrokernullable string

Specifies the preferred Connection Broker.

activeSessionsinteger (int32)

Number of active sessions.

disconnectedSessionsinteger (int32)

Number of disconnected sessions.

activeConnectionsinteger (int32)

Number of active connections.

ipnullable string

The IP the agent is using.

loginStatusSessionLoginStatus (enum)

Session Login Status on the Remote Desktop Service

0 = Enabled,1 = Disabled,2 = DrainMode,3 = DrainUntilReboot

updStatusSessionUPDStatus (enum)

User profile disk status

0 = Enabled,1 = Disabled,2 = NotSupported

pendingSchedulePendingScheduleType (enum)

Pending Schedule Type

0 = None,1 = DisabledState,2 = Reboot

appPackageStatusesnullable array of AppPackageStatus (object)

The Application Packages statuses.

namenullable string

The Application Package name.

statusAppPackageRegistrationStatus (enum)

Application Package Registration Status

0 = ImageMountingFailed,1 = StagingFailed,2 = StagingSuccessful,3 = Unsupported,-1 = NotApplied

Request

Response

Get

Retrieve the RD Session Host status information for the server.

GET/api/RDS/Host/{id}/status

Path parameters

id*integer (int32)

RD Session Host ID

Response

Success

Body

idnullable string

ID of RAS Agent.

siteIdinteger (int32)

ID of Site.

agentStateAgentState (enum)

Agent State

serverTypeRASServerType (enum)

RAS Status Type

agentVernullable string

Agent Version.

servernullable string

Server name.

serverOSnullable string

Server Operating System.

serviceStartTimenullable string

Service start time.

systemBootTimenullable string

System boot time.

unhandledExceptionsinteger (int32)

Number of unhandled exceptions.

machineIdnullable string

Id of the machine

logLevelRASLogLevel (enum)

RAS Log Level

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

cpuLoadinteger (int32)

CPU load percentage.

memLoadinteger (int32)

Memory load percentage.

diskReadinteger (int32)

Disk Read.

diskWriteinteger (int32)

Disk Write.

enabledboolean

Whether the object is enabled or not.

preferredBrokernullable string

Specifies the preferred Connection Broker.

activeSessionsinteger (int32)

Number of active sessions.

disconnectedSessionsinteger (int32)

Number of disconnected sessions.

activeConnectionsinteger (int32)

Number of active connections.

ipnullable string

The IP the agent is using.

loginStatusSessionLoginStatus (enum)

Session Login Status on the Remote Desktop Service

0 = Enabled,1 = Disabled,2 = DrainMode,3 = DrainUntilReboot

updStatusSessionUPDStatus (enum)

User profile disk status

0 = Enabled,1 = Disabled,2 = NotSupported

pendingSchedulePendingScheduleType (enum)

Pending Schedule Type

0 = None,1 = DisabledState,2 = Reboot

appPackageStatusesnullable array of AppPackageStatus (object)

The Application Packages statuses.

namenullable string

The Application Package name.

statusAppPackageRegistrationStatus (enum)

Application Package Registration Status

0 = ImageMountingFailed,1 = StagingFailed,2 = StagingSuccessful,3 = Unsupported,-1 = NotApplied

Request

Response

[
  {
    "id": "text",
    "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"
    ],
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ],
    "agentVer": "text",
    "server": "text",
    "serverOS": "text",
    "serviceStartTime": "text",
    "systemBootTime": "text",
    "machineId": "text",
    "logLevel": [
      "0 = Critical",
      "1 = Error",
      "2 = Warning",
      "3 = Standard",
      "4 = Extended",
      "5 = Verbose",
      "-1 = None"
    ],
    "enabled": false,
    "preferredBroker": "text",
    "ip": "text",
    "loginStatus": [
      "0 = Enabled",
      "1 = Disabled",
      "2 = DrainMode",
      "3 = DrainUntilReboot"
    ],
    "updStatus": [
      "0 = Enabled",
      "1 = Disabled",
      "2 = NotSupported"
    ],
    "pendingSchedule": [
      "0 = None",
      "1 = DisabledState",
      "2 = Reboot"
    ],
    "appPackageStatuses": [
      {
        "name": "text",
        "status": [
          "0 = ImageMountingFailed",
          "1 = StagingFailed",
          "2 = StagingSuccessful",
          "3 = Unsupported",
          "-1 = NotApplied"
        ]
      }
    ]
  }
]

{
  "id": "text",
  "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"
  ],
  "serverType": [
    "1 = RDSHost",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = PA",
    "9 = Site",
    "16 = RDSGroup",
    "25 = HALBDevice",
    "45 = TenantBroker",
    "46 = Enrollment",
    "51 = HALB",
    "64 = AVDWorkspace",
    "65 = AVDHostPool",
    "66 = AVDTemplate",
    "67 = AVDHost",
    "95 = VDITemplateVersion",
    "96 = AVDTemplateVersion",
    "97 = RDSTemplateVersion",
    "107 = RDSTemplate",
    "108 = VDITemplate",
    "2013 = VDIHost",
    "-1 = All"
  ],
  "agentVer": "text",
  "server": "text",
  "serverOS": "text",
  "serviceStartTime": "text",
  "systemBootTime": "text",
  "machineId": "text",
  "logLevel": [
    "0 = Critical",
    "1 = Error",
    "2 = Warning",
    "3 = Standard",
    "4 = Extended",
    "5 = Verbose",
    "-1 = None"
  ],
  "enabled": false,
  "preferredBroker": "text",
  "ip": "text",
  "loginStatus": [
    "0 = Enabled",
    "1 = Disabled",
    "2 = DrainMode",
    "3 = DrainUntilReboot"
  ],
  "updStatus": [
    "0 = Enabled",
    "1 = Disabled",
    "2 = NotSupported"
  ],
  "pendingSchedule": [
    "0 = None",
    "1 = DisabledState",
    "2 = Reboot"
  ],
  "appPackageStatuses": [
    {
      "name": "text",
      "status": [
        "0 = ImageMountingFailed",
        "1 = StagingFailed",
        "2 = StagingSuccessful",
        "3 = Unsupported",
        "-1 = NotApplied"
      ]
    }
  ]
}