Get Management Console

Overview

Gets information to access the remote console of Baremetal Server. This request will be accepted only when the task_state is None.
This API response console parameters are used at Remote Console Access - Get Started. To access your Baremetal Server, you have to create VPN user and connect to VPN.

Classification

  • Get

API Operation Object

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{api_endpoint}/v2/{tenant_id}/servers/{server_id}/action

HTTP Request Header

Accept: application/json
Content-Type: application/json
X-Auth-Token: <token>

HTTP Request Body

Format

{
  "os-getManagementConsole": "<os-getManagementConsole>"
}

Request Parameter

Input Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
tenant_id URL UUID ID for the tenant. required - Terminate 403, 404
server_id URL UUID ID for the server. required - Terminate 404
token Header Authentication token string Keystone authentication token. required - Terminate 401
os-getManagementConsole Request datatype_managementconsole This attribute always has null on Baremetal Server. required - Terminate 400

Response

HTTP Response Header

Format

HTTP/1.1 200 OK
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
200 normal end
400 specified parameter is invalid
401 unauthorized
403 tenant is not available
404 not found a specified item
405 request URL or method is invalid
409 conflict server action requests. Request will be accepted only when the task_state is None.
415 bad media type
500 compute fault. If an error other than above has occurred, the response code is always 500.

HTTP Response Body

Format

{
  "console": {
    "type": "<type>",
    "url": "<url>",
    "user_id": "<user_id>",
    "password": "<password>"
  }
}

Response Parameter

Response Parameters
item format   description
console Console   Show remote console information. Parameters of this datatype are used at Remote Console Access API .

Sample Request and Response

Sample API Request

Request URI

https://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/servers/8c063778-a196-4671-87ed-06aabea3d480/action

Request Header

POST /v2/b322a85578de48beba0f92acce57869b/servers/8c063778-a196-4671-87ed-06aabea3d480/action HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Accept: application/json
Content-Type: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588

Request Body

{
  "os-getManagementConsole": null
}

Sample API Response

Response Header

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-length>
Date: Thu, 17 Jul 2014 04:21:06 GMT

Response Body

{
  "console": {
    "type": "IPMI",
    "url": "http://127.0.0.1:8080/ipmi/client.xhml?id=<token>",
    "user_id": "270dd02f-2abf-48bd-813a-f8a4470da7f7",
    "password": "fake_password"
  }
}