summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/snapshot.rst
diff options
context:
space:
mode:
authorHuanxuan Ao <huanxuan.ao@easystack.cn>2016-09-25 15:44:03 +0800
committerHuanxuan Ao <huanxuan.ao@easystack.cn>2016-09-26 02:42:47 +0000
commit3ebc7520a6ecdf6260757daf7ad913a1bff4e342 (patch)
tree8166244d969003e1ab483bbbbc164cdf86cafbb5 /doc/source/command-objects/snapshot.rst
parent559215d59d40a35c3a741af99116878c6024078f (diff)
downloadpython-openstackclient-3ebc7520a6ecdf6260757daf7ad913a1bff4e342.tar.gz
Add warning message for --state option of set command in volume
There are some set commands can set object state, it maybe a danger behavor for users, so add explanation and warning in the help message of the "--state" option to talk users be caution when using (cinderclient have done this too) Change-Id: I6a902887ea98879999c9972f36b1b7ef332173c3
Diffstat (limited to 'doc/source/command-objects/snapshot.rst')
-rw-r--r--doc/source/command-objects/snapshot.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst
index ce2d9c8e..a2709adb 100644
--- a/doc/source/command-objects/snapshot.rst
+++ b/doc/source/command-objects/snapshot.rst
@@ -123,8 +123,9 @@ Set snapshot properties
.. option:: --state <state>
New snapshot state.
- Valid values are "available", "error", "creating",
- "deleting", and "error_deleting".
+ ("available", "error", "creating", "deleting", or "error_deleting") (admin only)
+ (This option simply changes the state of the snapshot in the database with
+ no regard to actual status, exercise caution when using)
*Volume version 2 only*