summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorzhangbailin <zhangbailin@inspur.com>2020-03-12 18:44:36 +0800
committerzhangbailin <zhangbailin@inspur.com>2020-04-09 08:52:05 +0800
commit4d6c70d25df99a4f28f263cd3160c74ccf1343e3 (patch)
tree64ab8962905dee361f94d2b417081d1e77e5971b /doc
parentea092b29880e71f0ba2d8e1eb93a9cf73edee2a2 (diff)
downloadpython-novaclient-4d6c70d25df99a4f28f263cd3160c74ccf1343e3.tar.gz
Microversion 2.85: Change volume-update CLI
This commit add a new CLI ``nova volume-update [--[no-]delete-on-termination] <server> <src_volume> <dest_volume>`` to update 'delete_on_termination' for an attached volume, that the user can decide whether to delete attached volumes when destroying the server. Depends-On: https://review.opendev.org/#/c/711194/ Change-Id: I1fc64fb6e6611c92c6b72265e1bf4b32e9c45f0a Blueprint: destroy-instance-with-datavolume
Diffstat (limited to 'doc')
-rw-r--r--doc/source/cli/nova.rst29
1 files changed, 21 insertions, 8 deletions
diff --git a/doc/source/cli/nova.rst b/doc/source/cli/nova.rst
index 26c2ce2a..6db1cd0c 100644
--- a/doc/source/cli/nova.rst
+++ b/doc/source/cli/nova.rst
@@ -558,10 +558,12 @@ nova usage
Detach a volume from a server.
``volume-update``
- Update the attachment on the server. Migrates
- the data from an attached volume to the
- specified available volume and swaps out the
- active attachment to the new volume.
+ Update the attachment on the server. Migrates the data from an
+ attached volume to the specified available volume and swaps out
+ the active attachment to the new volume.
+ Since microversion 2.85, support for updating the
+ ``delete_on_termination`` delete flag, which allows changing the
+ behavior of volume deletion on instance deletion.
``x509-create-cert``
**DEPRECATED** Create x509 cert for a user in
@@ -3896,7 +3898,7 @@ Attach a volume to a server.
Tag for the attached volume. (Supported by API versions '2.49' - '2.latest')
``--delete-on-termination``
- Specify if the attached volume sholud be deleted when the server is
+ Specify if the attached volume should be deleted when the server is
destroyed. By default the attached volume is not deleted when the server is
destroyed. (Supported by API versions '2.79' - '2.latest')
@@ -3942,7 +3944,8 @@ nova volume-update
.. code-block:: console
- usage: nova volume-update <server> <src_volid> <dest_volid>
+ usage: nova volume-update [--[no-]delete-on-termination]
+ <server> <src_volume> <dest_volume>
Update the attachment on the server. Migrates the data from an attached volume
to the specified available volume and swaps out the active attachment to the
@@ -3953,12 +3956,22 @@ new volume.
``<server>``
Name or ID of server.
-``<src_volid>``
+``<src_volume>``
ID of the source (original) volume.
-``<dest_volid>``
+``<dest_volume>``
ID of the destination volume.
+**Optional arguments:**
+
+``--delete-on-termination``
+ Specify that the volume should be deleted when the server is destroyed.
+ (Supported by API versions '2.85' - '2.latest')
+
+``--no-delete-on-termination``
+ Specify that the attached volume should not be deleted when
+ the server is destroyed. (Supported by API versions '2.85' - '2.latest')
+
.. _nova_bash-completion:
nova bash-completion