• Bare Metal Server

bms
  1. Help Center
  2. Bare Metal Server
  3. API Reference
  4. API
  5. BMS Status Management (Native OpenStack APIs)
  6. Restarting a BMS (Native OpenStack API)

Restarting a BMS (Native OpenStack API)

Function

This interface is used to restart a single BMS.

Constraints

Currently, only forcible restart is supported.

URI

POST /v2.1/{project_id}/servers/{server_id}/action

Table 1 lists the parameters.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

server_id

Yes

Specifies the BMS ID.

Request Message

  • Request parameters

    Parameter

    Type

    Mandatory

    Description

    reboot

    Dictionary data structure [1]

    Yes

    Specifies the operation of restarting the BMS.

    [1] reboot field data structure description

    Parameter

    Type

    Mandatory

    Description

    type

    String

    Yes

    Specifies the type of the restart operation.

    • SOFT: soft restart
    • HARD: forcible restart
      NOTE:

      Currently, value SOFT is invalid. All BMS restart operations are forcible restart.

  • Example request
    {
        "reboot": {
            "type": "HARD"
        }
    }

Response Message

N/A

Returned Values

See section Common Returned Values.