From e315fcbec9d385c12e21168795afd7f748083fc6 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Mon, 9 Oct 2017 17:05:24 -0400 Subject: [PATCH] api-ref: fix server status values in GET /servers docs The server status values exposed out of the API and used for filtering when listing instances comes from the values in nova.api.openstack.common._STATE_MAP. Some of the values listed in the docs were incorrectly using variable names from the code, which don't necessarily match the actual value exposed out of the API. The compute API server concepts guide actually had this all correct, so this just updates the API reference. Change-Id: I30b6f27c6e7fc9365c203b620b311785f8b4b489 Closes-Bug: #1722403 --- api-ref/source/servers.inc | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/api-ref/source/servers.inc b/api-ref/source/servers.inc index 3e1eb0aa8e..0a43f43b70 100644 --- a/api-ref/source/servers.inc +++ b/api-ref/source/servers.inc @@ -107,7 +107,7 @@ servers request. The server status is returned in the response body. The possible server status values are: - ``ACTIVE``. The server is active. -- ``BUILDING``. The server has not finished the original build process. +- ``BUILD``. The server has not finished the original build process. - ``DELETED``. The server is permanently deleted. - ``ERROR``. The server is in error. - ``HARD_REBOOT``. The server is hard rebooting. This is equivalent to @@ -120,17 +120,21 @@ body. The possible server status values are: - ``REBOOT``. The server is in a soft reboot state. A reboot command was passed to the operating system. - ``REBUILD``. The server is currently being rebuilt from an image. -- ``RESCUED``. The server is in rescue mode. A rescue image is running +- ``RESCUE``. The server is in rescue mode. A rescue image is running with the original server image attached. -- ``RESIZED``. Server is performing the differential copy of data that +- ``RESIZE``. Server is performing the differential copy of data that changed during its initial copy. Server is down for this stage. - ``REVERT_RESIZE``. The resize or migration of a server failed for some reason. The destination server is being cleaned up and the original source server is restarting. +- ``SHELVED``: The server is in shelved state. Depending on the shelve offload + time, the server will be automatically shelved offloaded. +- ``SHELVED_OFFLOADED``: The shelved server is offloaded (removed from the + compute host) and it needs unshelved action to be used again. +- ``SHUTOFF``. The server is powered off and the disk image still + persists. - ``SOFT_DELETED``. The server is marked as deleted but the disk images are still available to restore. -- ``STOPPED``. The server is powered off and the disk image still - persists. - ``SUSPENDED``. The server is suspended, either by request or necessity. This status appears for only the XenServer/XCP, KVM, and ESXi hypervisors. Administrative users can suspend an instance if it