summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorzhiyong.dai <zhiyong.dai@easystack.cn>2017-01-02 17:55:32 +0800
committerDean Troyer <dtroyer@gmail.com>2017-01-25 17:32:58 -0600
commit26d50be79a401322f4e74b94c066257ddf0f287c (patch)
treeaeae1d1b5d451458e806b7a32ee4816c14afa17a /doc/source/command-objects
parentd5745eaaa79491728da656baee0451b861723cce (diff)
downloadpython-openstackclient-26d50be79a401322f4e74b94c066257ddf0f287c.tar.gz
Support "--no-property" option in volume snapshot set
Supporting "--no-property" option will apply user a convenient way to clean all properties of volume snapshot in a short command, and this kind of behavior is the recommended way to devref. The patch adds "--no-property" option in "volume snapshot set" command, and update related test cases and devref document. Change-Id: I5f10cc2b5814553699920c4343995b2e11416e4e Implements: blueprint allow-overwrite-set-options
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/volume-snapshot.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/source/command-objects/volume-snapshot.rst b/doc/source/command-objects/volume-snapshot.rst
index 37a5088a..8aed1d83 100644
--- a/doc/source/command-objects/volume-snapshot.rst
+++ b/doc/source/command-objects/volume-snapshot.rst
@@ -133,6 +133,7 @@ Set volume snapshot properties
openstack volume snapshot set
[--name <name>]
[--description <description>]
+ [--no-property]
[--property <key=value> [...] ]
[--state <state>]
<snapshot>
@@ -145,6 +146,12 @@ Set volume snapshot properties
New snapshot description
+.. option:: --no-property
+
+ Remove all properties from :ref:`\<snapshot\> <volume_snapshot_set-snapshot>`
+ (specify both :option:`--no-property` and :option:`--property` to
+ remove the current properties before setting new properties.)
+
.. option:: --property <key=value>
Property to add or modify for this snapshot (repeat option to set multiple properties)