From 23ee2fd8f060ed312a84eb03c99494e8af2ffb6f Mon Sep 17 00:00:00 2001
From: Huanxuan Ao <huanxuan.ao@easystack.cn>
Date: Wed, 14 Sep 2016 14:54:29 +0800
Subject: Refactor "snapshot" commands

1.change the command name ``snapshot create/delete/list/
show/set/unset`` to ``volume snapshot create/delete/list/
show/set/unset``.

2.change the optional parameter "--name <name>" to a
positional parameter "<snapshot-name>"; Change the
positional parameter "<volume>" to a optional
parameter "--volume <volume>"

Change-Id: If03276ecdf6f0d96893d5ecf91c2aaa64929cff3
Implements: bp backup-snapshot-renamed-for-volume-resource
Co-Authored-By: Sheel Rana <ranasheel2000@gmail.com>
---
 doc/source/command-objects/snapshot.rst        |   6 +
 doc/source/command-objects/volume-snapshot.rst | 171 +++++++++++++++++++++++++
 2 files changed, 177 insertions(+)
 create mode 100644 doc/source/command-objects/volume-snapshot.rst

(limited to 'doc/source/command-objects')

diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst
index a2709adb..e75693ca 100644
--- a/doc/source/command-objects/snapshot.rst
+++ b/doc/source/command-objects/snapshot.rst
@@ -8,6 +8,7 @@ snapshot create
 ---------------
 
 Create new snapshot
+(Deprecated, please use ``volume snapshot create`` instead)
 
 .. program:: snapshot create
 .. code:: bash
@@ -46,6 +47,7 @@ snapshot delete
 ---------------
 
 Delete snapshot(s)
+(Deprecated, please use ``volume snapshot delete`` instead)
 
 .. program:: snapshot delete
 .. code:: bash
@@ -62,6 +64,7 @@ snapshot list
 -------------
 
 List snapshots
+(Deprecated, please use ``volume snapshot list`` instead)
 
 .. program:: snapshot list
 .. code:: bash
@@ -96,6 +99,7 @@ snapshot set
 ------------
 
 Set snapshot properties
+(Deprecated, please use ``volume snapshot set`` instead)
 
 .. program:: snapshot set
 .. code:: bash
@@ -137,6 +141,7 @@ snapshot show
 -------------
 
 Display snapshot details
+(Deprecated, please use ``volume snapshot show`` instead)
 
 .. program:: snapshot show
 .. code:: bash
@@ -153,6 +158,7 @@ snapshot unset
 --------------
 
 Unset snapshot properties
+(Deprecated, please use ``volume snapshot unset`` instead)
 
 .. program:: snapshot unset
 .. code:: bash
diff --git a/doc/source/command-objects/volume-snapshot.rst b/doc/source/command-objects/volume-snapshot.rst
new file mode 100644
index 00000000..b84601f4
--- /dev/null
+++ b/doc/source/command-objects/volume-snapshot.rst
@@ -0,0 +1,171 @@
+===============
+volume snapshot
+===============
+
+Block Storage v1, v2
+
+volume snapshot create
+----------------------
+
+Create new volume snapshot
+
+.. program:: volume snapshot create
+.. code:: bash
+
+    os volume snapshot create
+        [--volume <volume>]
+        [--description <description>]
+        [--force]
+        [--property <key=value> [...] ]
+        <snapshot-name>
+
+.. option:: --volume <volume>
+
+    Volume to snapshot (name or ID) (default is <snapshot-name>)
+
+.. option:: --description <description>
+
+    Description of the snapshot
+
+.. option:: --force
+
+    Create a snapshot attached to an instance. Default is False
+
+.. option:: --property <key=value>
+
+    Set a property to this snapshot (repeat option to set multiple properties)
+
+    *Volume version 2 only*
+
+.. _volume_snapshot_create-snapshot-name:
+.. describe:: <snapshot-name>
+
+    Name of the new snapshot (default to None)
+
+volume snapshot delete
+----------------------
+
+Delete volume snapshot(s)
+
+.. program:: volume snapshot delete
+.. code:: bash
+
+    os volume snapshot delete
+        <snapshot> [<snapshot> ...]
+
+.. _volume_snapshot_delete-snapshot:
+.. describe:: <snapshot>
+
+    Snapshot(s) to delete (name or ID)
+
+volume snapshot list
+--------------------
+
+List volume snapshots
+
+.. program:: volume snapshot list
+.. code:: bash
+
+    os volume snapshot list
+        [--all-projects]
+        [--long]
+        [--limit <limit>]
+        [--marker <marker>]
+
+.. option:: --all-projects
+
+    Include all projects (admin only)
+
+.. option:: --long
+
+    List additional fields in output
+
+.. option:: --limit <limit>
+
+    Maximum number of snapshots to display
+
+    *Volume version 2 only*
+
+.. option:: --marker <marker>
+
+    The last snapshot ID of the previous page
+
+    *Volume version 2 only*
+
+volume snapshot set
+-------------------
+
+Set volume snapshot properties
+
+.. program:: volume snapshot set
+.. code:: bash
+
+    os volume snapshot set
+        [--name <name>]
+        [--description <description>]
+        [--property <key=value> [...] ]
+        [--state <state>]
+        <snapshot>
+
+.. option:: --name <name>
+
+    New snapshot name
+
+.. option:: --description <description>
+
+    New snapshot description
+
+.. option:: --property <key=value>
+
+    Property to add or modify for this snapshot (repeat option to set multiple properties)
+
+.. option:: --state <state>
+
+    New snapshot state.
+    ("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*
+
+.. _volume_snapshot_set-snapshot:
+.. describe:: <snapshot>
+
+    Snapshot to modify (name or ID)
+
+volume snapshot show
+--------------------
+
+Display volume snapshot details
+
+.. program:: volume snapshot show
+.. code:: bash
+
+    os volume snapshot show
+        <snapshot>
+
+.. _volume_snapshot_show-snapshot:
+.. describe:: <snapshot>
+
+    Snapshot to display (name or ID)
+
+volume snapshot unset
+---------------------
+
+Unset volume snapshot properties
+
+.. program:: volume snapshot unset
+.. code:: bash
+
+    os volume snapshot unset
+        [--property <key>]
+        <snapshot>
+
+.. option:: --property <key>
+
+    Property to remove from snapshot (repeat option to remove multiple properties)
+
+.. _volume_snapshot_unset-snapshot:
+.. describe:: <snapshot>
+
+    Snapshot to modify (name or ID)
-- 
cgit v1.2.1