starlingx/config
Code Issues Proposed changes

Add new system host-kernel-show/modify apis

Browse Source 
This updates provides the sysinv rest api
documentation for
- system host-kernel-show <controller>
- system host-kernel-modify <controller> [standard|lowlatency]

Test plan:

PASS - build rst documentation using tox

Story: 2010731
Task: 48365

Change-Id: I550b7a83b1d06d2ba117ee4e2e586ba368b73592
Signed-off-by: Kyale, Eliud <Eliud.Kyale@windriver.com>
This commit is contained in:
Kyale, Eliud 2024-06-26 08:24:55 -04:00
parent 9c9201113f
commit 288b8c830e
1 changed files with 108 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
api-ref/source/api-ref-sysinv-v1-config.rst
View File

@ -12623,4 +12623,111 @@ forbidden (403), badMethod (405)
"region_name": "f558ce1b-de27-4132-8ca6-ac7f34ae8d21",
}
This operation does not accept a request body.
This operation does not accept a request body.
-------------------------
Host Kernels
-------------------------
These APIs allow the display and modification of the host's kernel
********************
Display Host Kernel
********************
.. rest_method:: GET /v1/ihosts/{ihost_uuid}/kernel
**Normal response codes**
200
**Error response codes**
computeFault (400, 500, ...), serviceUnavailable (503),
unauthorized (401), forbidden (403), itemNotFound (404)
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"ihost_uuid", "URI", "csapi:UUID", "The unique identifier of the host"
This operation does not accept a request body.
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"ihost_uuid", "URI", "csapi:UUID", "The unique identifier of the host"
"hostname", "plain", "xsd:string", "The host name"
"kernel_provisioned", "plain", "xsd:string", "The provisioned kernel"
"kernel_running", "plain", "xsd:string", "The running kernel"
::
{
"ihost_uuid": "e551b1f0-ab6d-43a9-8eb1-05c39025a161",
"hostname": "controller-0",
"kernel_provisioned": "standard",
"kernel_running": "standard",
}
This operation does not accept a request body.
********************
Modify Host Kernel
********************
.. rest_method:: PATCH /v1/ihosts/{ihost_uuid}/kernel
**Normal response codes**
200
**Error response codes**
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
unauthorized (401), forbidden (403), itemNotFound (404)
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"ihost_uuid", "URI", "csapi:UUID", "The unique identifier of the host"
"path", "URI", "xsd:string", "``/kernel_provisioned`` (always)"
"value", "plain", "xsd:string", "New Kernel [lowlatency|standard]"
"op", "plain", "xsd:string", "Type of operation: ``replace`` (always)"
::
[
{
"path": "/kernel_provisioned",
"value": "lowlatency",
"op": "replace"
}
]
Will reply with updated kernel value
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"ihost_uuid", "URI", "csapi:UUID", "The unique identifier of the host"
"hostname", "plain", "xsd:string", "The host name"
"kernel_provisioned", "plain", "xsd:string", "The provisioned kernel"
"kernel_running", "plain", "xsd:string", "The running kernel"
::
{
"ihost_uuid": "e551b1f0-ab6d-43a9-8eb1-05c39025a161",
"hostname": "controller-0",
"kernel_provisioned": "lowlatency",
"kernel_running": "standard"
}