diff --git a/doc/common/section_cli_nova_startstop.xml b/doc/common/section_cli_nova_startstop.xml index fb2c99a220..ae2ee857ba 100644 --- a/doc/common/section_cli_nova_startstop.xml +++ b/doc/common/section_cli_nova_startstop.xml @@ -41,4 +41,34 @@ +
+ Shelve and unshelve an instance + Shelving is useful if you have an instance that you are not using, but would like retain in + your list of servers. For example, you can stop an instance at the end of a work week, and + resume work again at the start of the next week. All associated data and resources are kept; + however, anything still in memory is not retained. If a shelved instance is no longer needed, + it can also be entirely removed. + You can complete the following shelving tasks: + + Shelve an instance + Shuts down the instance, and stores it together with associated data and resources (a snapshot + is taken if not volume backed). Anything in memory is lost. Use the following + command: + $ nova shelve SERVERNAME + + + Unshelve an instance + Restores the instance: + $ nova unshelve SERVERNAME + + + Remove a shelved instance + Removes the instance from the server; data and resource associations are deleted. If an + instance is no longer needed, you can move that instance off the hypervisor in order to + minimize resource usage: + $ nova shelve-offload SERVERNAME + + + +