Update UEFI

Overview

This API updates UEFI setting of specified Baremetal server. This request will be accepted only when the task_state is None.

Classification

  • Update

API Operation Object

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

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

HTTP Request Header

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

HTTP Request Body

Format

{
  "uefi": "<uefi>"
}

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
uefi Request UEFI UEFI setting 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
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

  • None

Sample Request and Response

Sample API Request

Request URI

https://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/servers/c880a4b5-0230-4925-a8f5-16fb48249275/uefi

Request Header

PUT v2/b322a85578de48beba0f92acce57869b/servers/c880a4b5-0230-4925-a8f5-16fb48249275/uefi 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

{
  "uefi": {
    "setting": {
      "hoge": {
         "value": "Disabled"
       },
      "fuga": {
         "value": "Enabled"
       }
     }
  }
}

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

  • None