Remote system console

Back to Index

This page describes param to InvokeRmOperation call and returned value from OnRmOperationResult for snapinId = 15009.

Note

When operation fails, OnRmOperationResult comes with non-zero status and Error object in value:

{
   "Error" : {
      "code" : 4101,
      "message" : "Failed to send RM command"
   }
}

When status is zero, value is as provided in following documentation.

Paged output

RM requests may yield lots of data so responses are restricted in size.
That's where StartAt, UpTo and Total are used.

StartAt

• -1 value - execute request on the host, cache data, return starting part of the data
• >=0 value - get cached data from that position

UpTo says which StartAt use next to continue data retrieval

Total says how many data at all. When UpTo equals to Total, then all data has been retrieved.

Operation: Check if supported

snapinId=15009 opId=0

Check if host supports Remote system console subsystem (Snap-In) for RM calls.

Parameters

{}

Returns

{
   "Supported" : 1
}

Supported 1 if supports, 0 if not

Operation: Supported operations

snapinId=15009 opId=901

Gets which system actions are available.

Parameters

{}

Returns

{
   "BackLightOff" : 0,
   "BackLightOn" : 0,
   "HardReset" : 0,
   "Lock" : 1,
   "LogOff" : 1,
   "Restart" : 1,
   "ShutDown" : 1,
   "Suspend" : 0
}

when 1 - the specified action is available.

Client may choose which options, whether available or not, are presented in UI
in accordance with HostVersion reported by OnRmHostInfo event:

HostVersion = 2 (mobile platform)

  BackLightOff
  BackLightOn
  Restart (i.e. SoftReset)
  HardReset
  Suspend
  
otherwise

  Lock
  LogOff
  Restart
  ShutDown

Operation: Logged user name

snapinId=15009 opId=902

Parameters

{}

Returns

{
   "State" : 1,
   "User" : "DOMAIN\\user"
}

State:

• 1 Logged on
• 2 Locked
• 3 Logged off

Operation: System control action

snapinId=15009 opId=903

Parameters

{"SessionID":0,"Action":2,"Options":2,"Timeout":5,"Message":"Current user will be logged off" }

Returns

null

Action, one of:

• 1 Lock computer
• 2 Log off user
• 3 Restart computer
• 4 Shutdown computer
• 5 Suspend (WinCE-specific)
• 6 Backlight off (WinCE-specific)
• 7 Backlight on (WinCE-specific)
• 8 Hard reset (WinCE-specific)

Options, combination of:

• 1 Prompt user
• 2 Allow cancel
• 4 Close without save

SessionID: 0 if irrelevant or one from Sessions information result.

Operation: Sessions information

snapinId=15009 opId=904

Get list of currently running user sessions.

Parameters

{}

Returns

{
   "Sessions" : [
      {
         "SessionId" : 0,
         "State" : 1,
         "UserName" : "user"
      }
   ]
}

State:

• 1 Logged on
• 2 Locked
• 3 Logged off