api-ref: servers-action-evacuate.inc

-Verify evacuate action method, examples, params.
-Update parameters.yaml with request
 parameter, on_shared_storage. Added
 field max_version, required == true.
 Update adminPass_evacuate_rebuild
 with max_version field for response.
-Updated headers with action name.

Change-Id: I974b23b6e26cea01c3d41e22cc83c421ca2ebca0

api-ref/source/parameters.yaml

@@ -646,7 +646,18 @@ adminPass:
   type: string
 adminPass_evacuate_rebuild:
   description: |
-    An administrative password to access the evacuated or rebuild instance. To set the administrative
+    An administrative password to access the evacuated or rebuilt instance. To set the administrative
+    password, set the ``enable_instance_password`` configuration option to ``True``.
+    If you set this option to ``False`` and you try to set the administrative password,
+    the API does not set the password and the response shows a ``null`` value for
+    the ``adminPass`` parameter.
+  in: body
+  required: false
+  type: string
+  max_version: 2.14
+adminPass_evacuate_rebuild_request:
+  description: |
+    An administrative password to access the evacuated or rebuilt instance. To set the administrative
     password, set the ``enable_instance_password`` configuration option to ``True``.
     If you set this option to ``False`` and you try to set the administrative password,
     the API does not set the password and the response shows a ``null`` value for
@@ -1710,6 +1721,13 @@ next:
   in: body
   required: false
   type: string
+on_shared_storage:
+  description: |
+    Server on shared storage.
+  in: body
+  required: true
+  type: boolean
+  max_version: 2.14
 os:
   description: |
     The name of the operating system.

api-ref/source/servers-action-evacuate.inc

@@ -1,17 +1,15 @@
 .. -*- rst -*-
-.. needs:method_verification
-.. needs:parameter_verification
-.. needs:example_verification
-.. needs:body_verification
 
-Evacuate Server (Evacuate Action)
+Evacuate Server (evacuate Action)
 =================================
 
 .. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action
 
-Evacuates a server from a failed host to a new one.
+Evacuates a server from a failed host to a new host.
 
-Specify the ``evacuate`` action in the request body.
+- 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.
 
 Normal response codes: 200
 
@@ -27,18 +25,27 @@ Request
   - server_id: server_id
   - evacuate: evacuate
   - host: host
-  - adminPass: adminPass_evacuate_rebuild
+  - adminPass: adminPass_evacuate_rebuild_request
+  - onSharedStorage: on_shared_storage
 
-**Example Evacuate Server (Evacuate Action): JSON request**
+|
+
+**Example Evacuate Server (evacuate Action):**
 
 .. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-req.json
    :language: javascript
 
+
 Response
 --------
 
-**Example Evacuate Server (Evacuate Action): JSON request**
+.. rest_parameters:: parameters.yaml
+
+  - adminPass: adminPass_evacuate_rebuild
+
+|
+
+**Example Evacuate Server (evacuate Action):**
 
 .. literalinclude:: ../../doc/api_samples/os-evacuate/server-evacuate-resp.json
    :language: javascript
-