Setting Serial Port Login for an ECS

Function

This API is used to set serial port login for an ECS.

Constraints

This API is only supported in the following regions: AF-Cairo, AF-Johannesburg, and ME-Riyadh.
The setting takes effect only after an ECS is restarted.

Debugging

You can debug this API in API Explorer.

URI

PUT /v1/{project_id}/cloudservers/{server_id}/serial-console-options

Table 1 describes the parameters in the URI.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Definition Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
server_id	Yes	Definition Specifies the ECS ID. Constraints N/A Range N/A Default Value N/A

Request

Table 2 describes the request parameters.

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
serial_console_options	No	Object	Definition Sets the ECS serial port login. For details, see Table 3. Constraints N/A Range N/A Default Value N/A

**Table 3** **serial_console_options** field description
Parameter	Mandatory	Type	Description
enabled	No	Boolean	Definition Specifies whether the ECS supports login through a serial port. Constraints N/A Range true: Login through a serial port is supported. false: Login through a serial port is not supported. Default Value false

Response

None.

Example Request

PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/serial-console-options

{
    "serial_console_options": {
        "enabled": true
    }
}