Add Inject NMI to api-ref

This patch updates api-ref documentation with Inject NMI (Non-Masking
Interrupts) that were added in API microversion 1.29.

Partial-Bug: #1526226
Change-Id: I5003abcfd9a79751f40964c5bd5cb0bd550ba89d
This commit is contained in:
Naohiro Tamura 2017-01-23 14:56:18 +09:00
parent eae8e07132
commit 3a91dafb1a
4 changed files with 36 additions and 3 deletions

View File

@ -11,7 +11,7 @@ fi
OS_AUTH_TOKEN=$(openstack token issue | grep ' id ' | awk '{print $4}') OS_AUTH_TOKEN=$(openstack token issue | grep ' id ' | awk '{print $4}')
IRONIC_URL="http://127.0.0.1:6385" IRONIC_URL="http://127.0.0.1:6385"
IRONIC_API_VERSION="1.28" IRONIC_API_VERSION="1.29"
export OS_AUTH_TOKEN IRONIC_URL export OS_AUTH_TOKEN IRONIC_URL
@ -238,6 +238,8 @@ GET v1/nodes/$NID/management/boot_device/supported > node-get-supported-boot-dev
PUT v1/nodes/$NID/management/boot_device node-set-boot-device.json PUT v1/nodes/$NID/management/boot_device node-set-boot-device.json
GET v1/nodes/$NID/management/boot_device > node-get-boot-device-response.json GET v1/nodes/$NID/management/boot_device > node-get-boot-device-response.json
PUT v1/nodes/$NID/management/inject_nmi node-inject-nmi.json
############################# #############################
# NODES VIF ATTACH/DETACH API # NODES VIF ATTACH/DETACH API

View File

@ -223,6 +223,36 @@ Response
.. literalinclude:: samples/node-get-supported-boot-devices-response.json .. literalinclude:: samples/node-get-supported-boot-devices-response.json
Inject NMI (Non-Masking Interrupts)
===================================
.. rest_method:: PUT /v1/nodes/{node_ident}/management/inject_nmi
Inject NMI (Non-Masking Interrupts) for the given Node. This feature
can be used for hardware diagnostics, and actual support depends on a
driver.
Normal response code: 204 (No content)
Error codes:
- 400 (Invalid)
- 403 (Forbidden)
- 404 (NotFound)
- 406 (NotAcceptable)
- 409 (NodeLocked, ClientError)
Request
-------
.. rest_parameters:: parameters.yaml
- node_ident: node_ident
**Request to inject NMI to a node has to be empty dictionary:**
.. literalinclude:: samples/node-inject-nmi.json
Node State Summary Node State Summary
================== ==================

View File

@ -9,7 +9,7 @@
], ],
"min_version": "1.1", "min_version": "1.1",
"status": "CURRENT", "status": "CURRENT",
"version": "1.28" "version": "1.29"
}, },
"description": "Ironic is an OpenStack project which aims to provision baremetal machines.", "description": "Ironic is an OpenStack project which aims to provision baremetal machines.",
"name": "OpenStack Ironic API", "name": "OpenStack Ironic API",
@ -24,7 +24,7 @@
], ],
"min_version": "1.1", "min_version": "1.1",
"status": "CURRENT", "status": "CURRENT",
"version": "1.28" "version": "1.29"
} }
] ]
} }

View File

@ -0,0 +1 @@
{}