summaryrefslogtreecommitdiff
path: root/api-ref/source
diff options
context:
space:
mode:
Diffstat (limited to 'api-ref/source')
-rw-r--r--api-ref/source/baremetal-api-v1-node-management.inc5
-rw-r--r--api-ref/source/parameters.yaml8
2 files changed, 13 insertions, 0 deletions
diff --git a/api-ref/source/baremetal-api-v1-node-management.inc b/api-ref/source/baremetal-api-v1-node-management.inc
index cae2c0689..0d543a669 100644
--- a/api-ref/source/baremetal-api-v1-node-management.inc
+++ b/api-ref/source/baremetal-api-v1-node-management.inc
@@ -363,6 +363,10 @@ detailed documentation of the Ironic State Machine is available
``deploy_steps`` can be provided when settings the node's provision target
state to ``active`` or ``rebuild``.
+.. versionadded:: 1.70
+ ``disable_ramdisk`` can be provided to avoid booting the ramdisk during
+ manual cleaning.
+
Normal response code: 202
Error codes:
@@ -382,6 +386,7 @@ Request
- clean_steps: clean_steps
- deploy_steps: deploy_steps
- rescue_password: rescue_password
+ - disable_ramdisk: disable_ramdisk
**Example request to deploy a Node, using a configdrive served via local webserver:**
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 62d3f2ec4..2db02f853 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -780,6 +780,14 @@ description:
in: body
required: true
type: string
+disable_ramdisk:
+ description: |
+ If set to ``true``, the ironic-python-agent ramdisk will not be booted for
+ cleaning. Only clean steps explicitly marked as not requiring ramdisk can
+ be executed in this mode. Only allowed for manual cleaning.
+ in: body
+ required: false
+ type: boolean
driver_info:
description: |
All the metadata required by the driver to manage this Node. List of fields