GET /remoteaccess/remoteControl

Use this GET method to retrieve a JNLP file or URL to open a remote-control session to a specific managed server.

Note:
  • For System x servers, this method returns a JNLP file that you can open using Java Web Start.

  • For ThinkSystem servers, this method returns a URL that you can use to launch the HTML5-based remote control page.

  • For ThinkServer servers:

    • Each remote control session can managed only one ThinkServer server.

    • This method returns a JNLP file that you can open using Java Web Start.

For ThinkServer servers, each remote control session can managed only one ThinkServer server.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/remoteaccess/remoteControl

Query parameters

Parameters Required / Optional Description
uuid=<UUID> Optional UUID of server to which to open the remote-control session. To obtain the node UUID, use the GET /chassis or GET /nodes method.

If a UIUD not specified, the remote-control session opens untargeted.

Note: Untargeted sessions are not supported for ThinkServer and ThinkSystem servers.
userMode=<mode> Optional (ThinkSystem servers only) User session mode. This can be one of the following values.
  • singleUser. One user can open an exclusive remote-control session to the server. All other sessions to the server are blocked until you disconnect from the server.

    This option is available only if there are no other remote-control sessions open for the server.

  • multiUser. (default) Multiple users can open a remote-control session to the server.

The following example retrieve a JNLP file to open a remote-control session to a System X or ThinkServer server.
GET https://192.0.2.0/remoteaccess/remoteControl?uuid=425AF828DF7D11D4B0F8E76767BBBBBB
The following example retrieve a URL to open a remote-control session to a ThinkSystem server.
GET https://192.0.2.0/remoteaccess/remoteControl?uuid=425AF828DF7D11D4B0F8E76767BBBBBB&userMode=singleUser

Request body

None

Response codes

Code Description
200 OK
409 Conflict
500 Internal server error

Response body

For System x and ThinkServer servers, a ‚ÄčJNLP file of type application/x-java-jnlp-file is returned.

For ThinkSystem servers, the following JSON is returned.

Field Type Description
url String Link to open a remote-control session

Response example

The following example returns the URL that can be used to open a remote-control session for a ThinkSystem server.
{
   "url": "https://192.0.2.10"
}
The following example returns a JNLP file that can be used to open a remote-control session for a System x or ThinkServer server.
<?xml version="1.0" encoding="UTF-8"?>
<jnlp spec="6.0+" codebase="https://drsbandol.labs.lenovo.com:443/remoteaccess/remoteControl/"
 href="remotecontrol.jnlp?loggedInUser=USERID&userPassword=G5Dl05zEEarfIN204L9sjA==">
   <information>
      <title>Remote Control - drsbandol.labs.lenovo.com<title>
      <vendor>Lenovo</vendor>
      <icon href="../console/RemoteConsole.ico" width="32" height="32" kind="shortcut" />
      <icon href="../console/RemoteConsole.ico" width="64" height="64" kind="default" />
   </information>
   <security>
      <all-permissions/> 
   </security>
   <update check="always" policy="always" />
   <resources>
      <j2se version="1.6+ 1.7+" href="http://java.sun.com/products/autodl/j2se"
            max-heap-size="768m"/>
      <jar href="../console/lxcarpz-1.0.jar" main="true" download="eager"/>
      <jar href="../console/lxcarpz-mri-1.0.jar" main="true" download="eager"/>
      <jar href="../console/lib/wink-json4j-1.1.2-incubating.jar" download="lazy"/>
      <extension name="rplib" href="rplib.jnlp?serverName=drsbandol.labs.lenovo.com&serverPort=443"/>
   </resources>
   <resources os="Windows">
      <nativelib href="../console/lib/remotedriveWin-1.0.jar"/>
      <nativelib href="../console/lib/remotedriveWin64-1.0.jar"/>
   </resources>
   <application-desc 
        name="Remote Control - drsbandol.labs.lenovo.com"
        main-class="com.lenovo.lxca.rpz.launcher.RemoteControl">
      <argument>loggedInUser=USERID</argument>
<argument>userPassword=<<ENCRYPTED_PASS>>/argument>
<argument>serverName=drsbandol.labs.lenovo.com</argument>
<argument>serverPort=443</argument>
<argument>cryptoMode=SSL</argument>
   </application-desc>
</jnlp>