Help Center/ Bare Metal Server/ API Reference/ BMS APIs/ BMS Status Management/ Obtaining the Address for Remotely Logging In to a BMS
Updated on 2024-10-22 GMT+08:00

Obtaining the Address for Remotely Logging In to a BMS

Function

This API is used to obtain the address for remotely logging in to a BMS.

Constraints

Windows BMSs do not support remote login.

URI

POST /v1/{project_id}/baremetalservers/{server_id}/remote_console

Table 1 lists the URI parameters.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

server_id

Yes

Specifies the BMS ID.

You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Discarded).

Request Parameters

Parameter

Mandatory

Type

Description

remote_console

Yes

Object

Specifies the action to obtain the address for remotely logging in to a BMS. For details, see Table 2.

Table 2 remote_console field data structure description

Parameter

Mandatory

Type

Description

protocol

Yes

String

Specifies the remote login protocol. Set it to serial.

type

Yes

String

Specifies the remote login mode. Set it to serial.

Example Request

Obtaining the address for remotely logging in to a BMS (ID: cf2a8b97-b5c6-47ef-9714-eb27adf26e5b) with the login type and protocol set to serial
1
POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/remote_console
{
    "remote_console": {
        "protocol": "serial",
        "type": "serial"
    }
}

Response Parameters

Parameter

Type

Description

remote_console

Object

Specifies the action to obtain the address for remotely logging in to a BMS. For details, see Table 3.

Table 3 remote_console field data structure description

Parameter

Type

Description

type

String

Specifies the remote login mode.

protocol

String

Specifies the remote login protocol.

url

String

Specifies the remote login URL.

Example Response

{
   "remote_console": {
        "type": "serial",
        "protocol": "serial",
        "url": "https://console.domainname.com:443/serial/pod05ironic.region-01/?token=2a794f06-15ec-4f3d-a55b-06aca8e3dcbc"
    }
}

Returned Values

Normal values

Returned Values

Description

200

The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.