a8cfa5abc1
When we added evacuate to STOPPED in microversion 2.95 in d732ee38a1c596ab2720de51e91f83d6dbc727cf, we never updated our api-ref. This patch just adds a sentence explaining how evacuate behaves starting in 2.95. Related: bp/allowing-target-state-for-evacuate Change-Id: I1ed7211bcdd85547d3c7d8d396b6efab36b835c6
68 lines
1.8 KiB
ReStructuredText
68 lines
1.8 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
Evacuate Server (evacuate Action)
|
|
=================================
|
|
|
|
.. rest_method:: POST /servers/{server_id}/action
|
|
|
|
Evacuates a server from a failed host to a new host.
|
|
|
|
- Specify the ``evacuate`` action in the request body.
|
|
- In the request body, if ``onSharedStorage`` is set, then do not set ``adminPass``.
|
|
- The target host should not be the same as the instance host.
|
|
|
|
**Preconditions**
|
|
|
|
- The failed host must be fenced and no longer running the original server.
|
|
- The failed host must be reported as down or marked as forced down using
|
|
`Update Forced Down`_.
|
|
|
|
Starting from API version 2.68, the ``force`` parameter is no longer accepted
|
|
as this could not be meaningfully supported by servers with complex resource
|
|
allocations.
|
|
|
|
Starting from API version 2.95, the server will remain stopped on the
|
|
destination until it is manually started. If the server should end in the same
|
|
power state on the destination as it had on the source before the evacuation,
|
|
older microversions can be used.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
itemNotFound(404), conflict(409)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- server_id: server_id_path
|
|
- evacuate: evacuate
|
|
- host: host
|
|
- adminPass: adminPass_evacuate_request
|
|
- onSharedStorage: on_shared_storage
|
|
- force: force_evacuate
|
|
|
|
|
|
|
|
|
**Example Evacuate Server (evacuate Action)**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-req.json
|
|
:language: javascript
|
|
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- adminPass: adminPass_evacuate
|
|
|
|
.. note:: API does not return any Response for Microversion 2.14 or greater.
|
|
|
|
|
|
**Example Evacuate Server (evacuate Action)**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-resp.json
|
|
:language: javascript
|