Status

List

get

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

Query parameters

SiteIdinteger · int32Optional

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

ServerstringOptional

Filter the result by server name (optional)

Responses

200

Success

application/json; api-version=1.0

RDS System Information

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:

serverTypestring · enumOptional

RAS Status Type

Possible values:

agentVerstring · nullableOptional

Agent Version.

serverstring · nullableOptional

Server name.

serverOSstring · nullableOptional

Server Operating System.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

machineIdstring · nullableOptional

Id of the machine

logLevelstring · enumOptional

RAS Log Level

Possible values:

cpuLoadinteger · int32Optional

CPU load percentage.

memLoadinteger · int32Optional

Memory load percentage.

diskReadinteger · int32Optional

Disk Read.

diskWriteinteger · int32Optional

Disk Write.

enabledbooleanOptional

Whether the object is enabled or not.

preferredBrokerstring · nullableOptional

Specifies the preferred Connection Broker.

activeSessionsinteger · int32Optional

Number of active sessions.

disconnectedSessionsinteger · int32Optional

Number of disconnected sessions.

activeConnectionsinteger · int32Optional

Number of active connections.

ipstring · nullableOptional

The IP the agent is using.

loginStatusstring · enumOptional

Session Login Status on the Remote Desktop Service

Possible values:

updStatusstring · enumOptional

User profile disk status

Possible values:

pendingSchedulestring · enumOptional

Pending Schedule Type

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/RDS/Host/status

HTTPcURLJavaScriptPython

GET /api/RDS/Host/status HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "siteId": 1,
    "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",
    "unhandledExceptions": 1,
    "machineId": "text",
    "logLevel": [
      "0 = Critical",
      "1 = Error",
      "2 = Warning",
      "3 = Standard",
      "4 = Extended",
      "5 = Verbose",
      "-1 = None"
    ],
    "cpuLoad": 1,
    "memLoad": 1,
    "diskRead": 1,
    "diskWrite": 1,
    "enabled": true,
    "preferredBroker": "text",
    "activeSessions": 1,
    "disconnectedSessions": 1,
    "activeConnections": 1,
    "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"
        ]
      }
    ]
  }
]

Get

get

Retrieve the RD Session Host status information for the server.

Path parameters

idinteger · int32Required

RD Session Host ID

Responses

200

Success

application/json; api-version=1.0

RDS System Information

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:

serverTypestring · enumOptional

RAS Status Type

Possible values:

agentVerstring · nullableOptional

Agent Version.

serverstring · nullableOptional

Server name.

serverOSstring · nullableOptional

Server Operating System.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

machineIdstring · nullableOptional

Id of the machine

logLevelstring · enumOptional

RAS Log Level

Possible values:

cpuLoadinteger · int32Optional

CPU load percentage.

memLoadinteger · int32Optional

Memory load percentage.

diskReadinteger · int32Optional

Disk Read.

diskWriteinteger · int32Optional

Disk Write.

enabledbooleanOptional

Whether the object is enabled or not.

preferredBrokerstring · nullableOptional

Specifies the preferred Connection Broker.

activeSessionsinteger · int32Optional

Number of active sessions.

disconnectedSessionsinteger · int32Optional

Number of disconnected sessions.

activeConnectionsinteger · int32Optional

Number of active connections.

ipstring · nullableOptional

The IP the agent is using.

loginStatusstring · enumOptional

Session Login Status on the Remote Desktop Service

Possible values:

updStatusstring · enumOptional

User profile disk status

Possible values:

pendingSchedulestring · enumOptional

Pending Schedule Type

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

HTTPcURLJavaScriptPython

GET /api/RDS/Host/{id}/status HTTP/1.1
Accept: */*

{
  "id": "text",
  "siteId": 1,
  "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",
  "unhandledExceptions": 1,
  "machineId": "text",
  "logLevel": [
    "0 = Critical",
    "1 = Error",
    "2 = Warning",
    "3 = Standard",
    "4 = Extended",
    "5 = Verbose",
    "-1 = None"
  ],
  "cpuLoad": 1,
  "memLoad": 1,
  "diskRead": 1,
  "diskWrite": 1,
  "enabled": true,
  "preferredBroker": "text",
  "activeSessions": 1,
  "disconnectedSessions": 1,
  "activeConnections": 1,
  "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"
      ]
    }
  ]
}