openstack/nova - nova - OpenDev: Free Software Needs Free Tools

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. -*- rst -*-

api-ref: servers-action-shelve.inc -Fixed headers to match method names. -Verified methods and content. -Verified parameters in parameters.yaml. -Removed empty response sections and added a line between request param table and example. -Todo: verify the example string for each action (null). Change-Id: I611cef4949856ceb9be19af670401cb90a4eddbf

2016年05月10日 11:11:45 -04:00

Shelve Server (shelve Action)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

=============================

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: POST /servers/{server_id}/action

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Shelves a server.

Specify the ``shelve`` action in the request body.

All associated data and resources are kept but anything still in memory is not retained. To restore a shelved instance, use the ``unshelve`` action. To remove a shelved instance, use the ``shelveOffload`` action.

Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Preconditions**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

The server status must be ``ACTIVE``, ``SHUTOFF``, ``PAUSED``, or ``SUSPENDED``.

If the server is locked, you must have administrator privileges to shelve the server.

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Asynchronous Postconditions**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

After you successfully shelve a server, its status changes to ``SHELVED`` and the image status is ``ACTIVE``. The server instance data appears on the compute node that the Compute service manages.

If you boot the server from volumes or set the ``shelved_offload_time`` option to 0, the Compute service automatically deletes the instance on compute nodes and changes the server status to ``SHELVED_OFFLOADED``.

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Troubleshooting**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

If the server status does not change to ``SHELVED`` or ``SHELVED_OFFLOADED``, the shelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.

Normal response codes: 202

Complete method verification of os-shevle Correct the error status responses for os-shelve's methods Part of bp:api-ref-in-rst Change-Id: Id917c0a8bfde655ef4ca875eed5d54e82778b040

2016年05月09日 11:05:24 +08:00

Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

api-ref: Fix parameters in servers-action-shelve.inc The server_id should be a path parameter instead of a body parameter. TrivialFix Change-Id: Ic43b8cbbad580c77d02bebb2296e4cb8ed9acc80

2016年05月18日 11:12:02 +09:00

- server_id: server_id_path

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

- shelve: shelve

api-ref: servers-action-shelve.inc -Fixed headers to match method names. -Verified methods and content. -Verified parameters in parameters.yaml. -Removed empty response sections and added a line between request param table and example. -Todo: verify the example string for each action (null). Change-Id: I611cef4949856ceb9be19af670401cb90a4eddbf

2016年05月10日 11:11:45 -04:00

|

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Example Shelve server (shelve Action)**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

modify duplicate // to / in doc Part of bp:api-ref-in-rst Change-Id: I1da87f0e8f0a6b45d60be58af2d13c8a236469d3

2016年03月24日 05:01:06 +08:00

.. literalinclude:: ../../doc/api_samples/os-shelve/os-shelve.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

api-ref: servers-action-shelve.inc -Fixed headers to match method names. -Verified methods and content. -Verified parameters in parameters.yaml. -Removed empty response sections and added a line between request param table and example. -Todo: verify the example string for each action (null). Change-Id: I611cef4949856ceb9be19af670401cb90a4eddbf

2016年05月10日 11:11:45 -04:00

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

If successful, this method does not return content in the response body.

api-ref: servers-action-shelve.inc -Fixed headers to match method names. -Verified methods and content. -Verified parameters in parameters.yaml. -Removed empty response sections and added a line between request param table and example. -Todo: verify the example string for each action (null). Change-Id: I611cef4949856ceb9be19af670401cb90a4eddbf

2016年05月10日 11:11:45 -04:00

Shelf-Offload (Remove) Server (shelveOffload Action)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

====================================================

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: POST /servers/{server_id}/action

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Shelf-offloads, or removes, a shelved server.

Specify the ``shelveOffload`` action in the request body.

Data and resource associations are deleted. If an instance is no longer needed, you can remove that instance from the hypervisor to minimize resource usage.

Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Preconditions**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

The server status must be ``SHELVED``.

If the server is locked, you must have administrator privileges to shelve-offload the server.

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Asynchronous Postconditions**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

After you successfully shelve-offload a server, its status changes to ``SHELVED_OFFLOADED``. The server instance data appears on the compute node.

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Troubleshooting**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

If the server status does not change to ``SHELVED_OFFLOADED``, the shelve-offload operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.

Normal response codes: 202

Complete method verification of os-shevle Correct the error status responses for os-shelve's methods Part of bp:api-ref-in-rst Change-Id: Id917c0a8bfde655ef4ca875eed5d54e82778b040

2016年05月09日 11:05:24 +08:00

Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Request

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

-------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

.. rest_parameters:: parameters.yaml

api-ref: Fix parameters in servers-action-shelve.inc The server_id should be a path parameter instead of a body parameter. TrivialFix Change-Id: Ic43b8cbbad580c77d02bebb2296e4cb8ed9acc80

2016年05月18日 11:12:02 +09:00

- server_id: server_id_path

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

- shelveOffload: shelveOffload

api-ref: servers-action-shelve.inc -Fixed headers to match method names. -Verified methods and content. -Verified parameters in parameters.yaml. -Removed empty response sections and added a line between request param table and example. -Todo: verify the example string for each action (null). Change-Id: I611cef4949856ceb9be19af670401cb90a4eddbf

2016年05月10日 11:11:45 -04:00

|

**Example Shelf-Offload server (shelveOffload Action)**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Fix api ref for os-cells, os-cloudpipe and server-action-shelve This patch fix API ref for correct sample files and status code for below APIs - os-cells - os-cloudpipe - server-action-shelve Part of bp:api-ref-in-rst Change-Id: I6292f78742d7bb50882e186c97e7966721037ba4

2016年04月19日 20:47:03 +08:00

.. literalinclude:: ../../doc/api_samples/os-shelve/os-shelve-offload.json

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

:language: javascript

api-ref: servers-action-shelve.inc -Fixed headers to match method names. -Verified methods and content. -Verified parameters in parameters.yaml. -Removed empty response sections and added a line between request param table and example. -Todo: verify the example string for each action (null). Change-Id: I611cef4949856ceb9be19af670401cb90a4eddbf

2016年05月10日 11:11:45 -04:00

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Response

move sphinx h3 to '-' instead of '^' In the sphinx document h3 is supposed to be '-' not '^': =, for sections -, for subsections ^, for subsubsections We have to enforce consistency here because we're processing included files which all have to agree, otherwise it's a sphinx error. Part of bp:api-ref-in-rst Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

2016年04月14日 13:10:59 -04:00

--------

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

If successful, this method does not return content in the response body.

api-ref: servers-action-shelve.inc -Fixed headers to match method names. -Verified methods and content. -Verified parameters in parameters.yaml. -Removed empty response sections and added a line between request param table and example. -Todo: verify the example string for each action (null). Change-Id: I611cef4949856ceb9be19af670401cb90a4eddbf

2016年05月10日 11:11:45 -04:00

Unshelve (Restore) Shelved Server (unshelve Action)

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

===================================================

remove /v2.1/{tenant_id} from all urls As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

2016年06月02日 08:50:03 -04:00

.. rest_method:: POST /servers/{server_id}/action

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Unshelves, or restores, a shelved server.

Specify the ``unshelve`` action in the request body.

Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Preconditions**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

Allow unshelve to a specific host (REST API part) This adds support to the REST API, in a new microversion, for specifying a destination host to unshelve server action when the server is shelved offloaded. This patch also supports the ability to unpin the availability_zone of an instance that is bound to it. Note that the functional test changes are due to those tests using the "latest" microversion 2.91. Implements: blueprint unshelve-to-host Change-Id: I9e95428c208582741e6cd99bd3260d6742fcc6b7

2022年06月13日 15:22:43 +02:00

Unshelving a server without parameters requires its status to be ``SHELVED`` or ``SHELVED_OFFLOADED``.

Unshelving a server with availability_zone and/or host parameters requires its status to be only ``SHELVED_OFFLOADED`` otherwise HTTP 409 conflict response is returned.

If a server is locked, you must have administrator privileges to unshelve the server.

As of ``microversion 2.91``, you can unshelve to a specific compute node if you have PROJECT_ADMIN privileges.

This microversion also gives the ability to pin a server to an availability_zone and to unpin a server

from any availability_zone.

When a server is pinned to an availability_zone, the server move operations will keep the server in that

availability_zone. However, when the server is not pinned to any availability_zone, the move operations can

move the server to nodes in different availability_zones.

The behavior according to unshelve parameters will follow the below table.

+----------+---------------------------+----------+--------------------------------+

| Boot | AZ (1) | Host (1) | Result |

+==========+===========================+==========+================================+

| No AZ | No AZ or AZ=null | No | Free scheduling (2) |

+----------+---------------------------+----------+--------------------------------+

| | | | Server remains unpinned. |

+----------+---------------------------+----------+--------------------------------+

| No AZ | AZ="AZ1" | No | Schedule to any host in "AZ1". |

| | | | Server is pined to "AZ1". |

+----------+---------------------------+----------+--------------------------------+

| | | | then schedule to Host1, |

| | | | otherwise reject the request. |

| | | | Server is pined to "AZ1". |

+----------+---------------------------+----------+--------------------------------+

| AZ1 | No AZ | No | Schedule to any host in "AZ1". |

| | | | Server remains pined to "AZ1". |

+----------+---------------------------+----------+--------------------------------+

| AZ1 | AZ=null | No | Free scheduling (2). |

| | | | Server is unpinned. |

+----------+---------------------------+----------+--------------------------------+

| AZ1 | No AZ | Host1 | Verify Host1 is in "AZ1", |

| | | | then schedule to Host1, |

| | | | otherwise reject the request. |

| | | | Server remains pined to "AZ1". |

+----------+---------------------------+----------+--------------------------------+

| AZ1 | AZ=null | Host1 | Schedule to Host1. |

| | | | Server is unpinned. |

+----------+---------------------------+----------+--------------------------------+

| AZ1 | AZ="AZ2" | No | Schedule to any host in "AZ2". |

| | | | Server is pined to "AZ2". |

+----------+---------------------------+----------+--------------------------------+

| AZ1 | AZ="AZ2" | Host1 | Verify Host1 is in "AZ2" then |

| | | | schedule to Host1, |

| | | | otherwise reject the request. |

| | | | Server is pined to "AZ2". |

+----------+---------------------------+----------+--------------------------------+

(1) Unshelve body parameters

(2) Schedule to any host available.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Asynchronous Postconditions**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

api-ref: fix unshelve asynchronous postconditions typo This section is talking about unshelve, so the asynchronous postconditions section should be talking about unshelve. Change-Id: I44bf3fbfc60225dcdb9d3d9c018f66cf49f8cbdc

2017年06月19日 09:24:52 -04:00

After you successfully unshelve a server, its status changes to ``ACTIVE``.

The server appears on the compute node.

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

The shelved image is deleted from the list of images returned by an API call.

API Ref: update server_id params - Update server_id params to be of type path. - Cleaned up os-getConsoleOutput action string. - Made empty response body description more consistent. Review and change as needed. Implements: bp/api-ref-in-rst-ocata Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

2016年10月10日 14:50:17 -04:00

**Troubleshooting**

Import RST files for documentation This is the results of the RST conversion from WADL. It creates a single index plus a bunch of included files which represent sections of the API document. This is the starting point for fixing the documentation. Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26

2016年04月12日 09:03:46 -04:00

If the server status does not change to ``ACTIVE``, the unshelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.