summaryrefslogtreecommitdiff
path: root/api-ref/source/os-services.inc
diff options
context:
space:
mode:
authorSean Dague <sean@dague.net>2017-08-10 09:34:13 -0400
committermelanie witt <melwittt@gmail.com>2018-08-17 01:41:31 +0000
commit8835198b8d09e9a69ea83741fdb1579a98019b51 (patch)
treee63549f370d370802c16fc47e35b127759c60a99 /api-ref/source/os-services.inc
parentdf3dd2b5c7f63ca69c9fb5d95ab3c496f729b0d0 (diff)
downloadnova-8835198b8d09e9a69ea83741fdb1579a98019b51.tar.gz
Update api-guide and api-ref to be clear about forced-down
Closes-Bug: #1691871 Related-Bug: #1784826 Change-Id: Ifc6f1549d88a1b7d9f6e25c962c8a15dd8e180fb
Diffstat (limited to 'api-ref/source/os-services.inc')
-rw-r--r--api-ref/source/os-services.inc11
1 files changed, 10 insertions, 1 deletions
diff --git a/api-ref/source/os-services.inc b/api-ref/source/os-services.inc
index 0f2c5cbc27..43659864b7 100644
--- a/api-ref/source/os-services.inc
+++ b/api-ref/source/os-services.inc
@@ -195,7 +195,16 @@ Update Forced Down
.. rest_method:: PUT /os-services/force-down
-Set or unset ``forced_down`` flag for the service.
+Set or unset ``forced_down`` flag for the service. ``forced_down`` is a manual
+override to tell nova that the service in question has been fenced manually by
+the operations team (either hard powered off, or network unplugged). That
+signals that it is safe to proceed with ``evacuate`` or other operations that
+nova has safety checks to prevent for hosts that are up.
+
+.. warning::
+
+ Setting a service forced down without completely fencing it will likely
+ result in the corruption of VMs on that host.
Action ``force-down`` available as of microversion 2.11.