diff options
| author | Cenne <cennedee+opendev@protonmail.com> | 2021-06-18 12:20:40 +0200 |
|---|---|---|
| committer | Cenne <cennedee+opendev@protonmail.com> | 2021-07-08 15:04:15 +0200 |
| commit | 46ff51487accf8881e468b975f4479c85daa8163 (patch) | |
| tree | 078719bea6b15bf757b129de559d6492e2ca495c /api-ref | |
| parent | 415464db4a2309d77295fd7b2bef8e1a97351699 (diff) | |
| download | ironic-46ff51487accf8881e468b975f4479c85daa8163.tar.gz | |
Add `boot_mode` and `secure_boot` to node object and expose in api
* add fields to Node object
* expose them at endpoint `/v1/nodes/{node_ident}/states`
* update states on powersync / entering managed state.
* tests
* update api endpoint info in api-ref
Story: 2008567
Task: 41709
Change-Id: Iddd1421a6fa37d69da56658a2fefa5bc8cfd15e4
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/baremetal-api-v1-node-management.inc | 7 | ||||
| -rw-r--r-- | api-ref/source/parameters.yaml | 10 | ||||
| -rw-r--r-- | api-ref/source/samples/node-get-state-response.json | 2 |
3 files changed, 18 insertions, 1 deletions
diff --git a/api-ref/source/baremetal-api-v1-node-management.inc b/api-ref/source/baremetal-api-v1-node-management.inc index 96f3e833a..0f2f3e175 100644 --- a/api-ref/source/baremetal-api-v1-node-management.inc +++ b/api-ref/source/baremetal-api-v1-node-management.inc @@ -264,7 +264,10 @@ Node State Summary .. rest_method:: GET /v1/nodes/{node_ident}/states -Get a summary of the Node's current power, provision, raid, and console status. +Get a summary of the Node's current power, provision, boot mode, raid, and console status. + +.. versionadded:: 1.75 + Introduced ``boot_mode`` and ``secure_boot`` fields. Normal response code: 200 @@ -289,6 +292,8 @@ Response - console_enabled: console_enabled - raid_config: raid_config - target_raid_config: target_raid_config + - boot_mode: boot_mode + - secure_boot: secure_boot **Example node state:** diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index ef9b1b975..65c9d029d 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -601,6 +601,11 @@ boot_interface: in: body required: true type: string +boot_mode: + description: | + The current boot mode state (uefi/bios) + in: body + type: string candidate_nodes: description: | A list of UUIDs of the nodes that are candidates for this allocation. @@ -1848,6 +1853,11 @@ retired_reason: in: body required: false type: string +secure_boot: + description: | + Indicates whether node is currently booted with secure_boot turned on. + in: body + type: boolean standalone_ports_supported: description: | Indicates whether ports that are members of this portgroup can be diff --git a/api-ref/source/samples/node-get-state-response.json b/api-ref/source/samples/node-get-state-response.json index 009552beb..8b23c08ca 100644 --- a/api-ref/source/samples/node-get-state-response.json +++ b/api-ref/source/samples/node-get-state-response.json @@ -1,10 +1,12 @@ { + "boot_mode": "uefi", "console_enabled": false, "last_error": null, "power_state": "power off", "provision_state": "available", "provision_updated_at": "2016-08-18T22:28:49.946416+00:00", "raid_config": {}, + "secure_boot": true, "target_power_state": null, "target_provision_state": null, "target_raid_config": {} |