summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/consistency-group-snapshot.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/consistency-group-snapshot.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/consistency-group-snapshot.rst')
-rw-r--r--doc/source/cli/command-objects/consistency-group-snapshot.rst96
1 files changed, 96 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/consistency-group-snapshot.rst b/doc/source/cli/command-objects/consistency-group-snapshot.rst
new file mode 100644
index 00000000..29d50656
--- /dev/null
+++ b/doc/source/cli/command-objects/consistency-group-snapshot.rst
@@ -0,0 +1,96 @@
+==========================
+consistency group snapshot
+==========================
+
+Block Storage v2
+
+consistency group snapshot create
+---------------------------------
+
+Create new consistency group snapshot.
+
+.. program:: consistency group snapshot create
+.. code:: bash
+
+ openstack consistency group snapshot create
+ [--consistency-group <consistency-group>]
+ [--description <description>]
+ [<snapshot-name>]
+
+.. option:: --consistency-group <consistency-group>
+
+ Consistency group to snapshot (name or ID)
+ (default to be the same as <snapshot-name>)
+
+.. option:: --description <description>
+
+ Description of this consistency group snapshot
+
+.. _consistency_group_snapshot_create-snapshot-name:
+.. describe:: <snapshot-name>
+
+ Name of new consistency group snapshot (default to None)
+
+consistency group snapshot delete
+---------------------------------
+
+Delete consistency group snapshot(s)
+
+.. program:: consistency group snapshot delete
+.. code:: bash
+
+ openstack consistency group snapshot delete
+ <consistency-group-snapshot> [<consistency-group-snapshot> ...]
+
+.. _consistency_group_snapshot_delete-consistency-group-snapshot:
+.. describe:: <consistency-group-snapshot>
+
+ Consistency group snapshot(s) to delete (name or ID)
+
+consistency group snapshot list
+-------------------------------
+
+List consistency group snapshots.
+
+.. program:: consistency group snapshot list
+.. code:: bash
+
+ openstack consistency group snapshot list
+ [--all-projects]
+ [--long]
+ [--status <status>]
+ [--consistency-group <consistency-group>]
+
+.. option:: --all-projects
+
+ Show detail for all projects. Admin only.
+ (defaults to False)
+
+.. option:: --long
+
+ List additional fields in output
+
+.. option:: --status <status>
+
+ Filters results by a status
+ ("available", "error", "creating", "deleting" or "error_deleting")
+
+.. option:: --consistency-group <consistency-group>
+
+ Filters results by a consistency group (name or ID)
+
+consistency group snapshot show
+-------------------------------
+
+Display consistency group snapshot details.
+
+.. program:: consistency group snapshot show
+.. code:: bash
+
+ openstack consistency group snapshot show
+ <consistency-group-snapshot>
+
+.. _consistency_group_snapshot_show-consistency-group-snapshot:
+.. describe:: <consistency-group-snapshot>
+
+ Consistency group snapshot to display (name or ID)