GET /remoteaccess/remoteControl
Use this method to return a JNLP file or URL to open a remote-control session to a specific managed server.
For ThinkSystem servers, this method returns a URL that you can use to launch the HTML5-based remote control page.
For System x (IMM2) servers, the 410 code is returned. To launch a remote-control session, download the remote-control application by clicking user-actions menu > Resources from the user interface, uncompress the ZIP file, and then run the JAR file to start the remote-control application on the local system.. You must provide IP address, username, and password for XClarity Administrator to access the IMM2 server.
The user account that is used to start the remote-control session must be a valid user account that has been defined in the XClarity Administrator authentication server. The user account must also have sufficient user authority to access and manage a server.
For System x (IMM1) servers, 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.
This method returns a JNLP file that you can open using Java Web Start.
Authentication
Authentication with username 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.
|
GET https://192.0.2.0/remoteaccess/remoteControl?uuid=425AF828DF7D11D4B0F8E76767BBBBBB
GET https://192.0.2.0/remoteaccess/remoteControl?uuid=425AF828DF7D11D4B0F8E76767BBBBBB&userMode=singleUser
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 406 | Not Supported | A specified resource is not supported or not available for connection. A descriptive error message is returned in the response body. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
| 501 | Not Implemented | HTML5 remote control is requested but the baseboard-management controller type is not supported. |
| 504 | Service Unavailable | The server is not ready to handle the request. |
Response body
Attributes Type Description result String Results of the request. This can be one of the following values.
- information
- warning
- critical
statusCode String Return code statusDescription String Return code description messages Array of objects Information about one or more messages id String Message identifier of a returned message text String Message text associated with the message identifier explanation String Additional information to clarify the reason for the message recovery String Recovery information The following example is returned.
{
"result": "warning",
"statusCode": 410,
"statusDescription": "The requested resource is no longer available.",
"messages": [{
"id": "FQXHMRC0001J",
"text": "The requested resource is no longer available.",
"recovery": "Download the resource from User -> Resources page.",
"explanation": "SystemX remote control resource was moved to another location."
}]
}
A JNLP file of type application/x-java-jnlp-file is returned. The following example shows the contents of the JNLP file that can be used to open a remote-control session<?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>
Field Type Description url String Link to open a remote-control session 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/#/login?user=xxxx&password=yyyy&context=remote&mode=single"