openstack/python-openstackclient
Code Issues Proposed changes
fe82f4b281
python-openstackclient/doc/source/command-objects/consistency-group-snapshot.rst

97 lines
2.4 KiB
ReStructuredText
Raw Normal View History

Add commands for "consistency group snapshot" Add commands: consistency group snapshot create consistency group snapshot delete consistency group snapshot list consistency group snapshot show in volume v2 (v2 only) Change-Id: Ib4115f8ff00fb5aa8194588223032657eb1346b5 Closes-Bug: #1642238 Implements: bp cinder-command-support
2016-11-16 20:55:21 +08:00
==========================
consistency group snapshot
==========================
Block Storage v2
consistency group snapshot create
---------------------------------
Create new consistency group snapshot.
.. program:: consistency group snapshot create
.. code:: bash
change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack consistency group snapshot create
Add commands for "consistency group snapshot" Add commands: consistency group snapshot create consistency group snapshot delete consistency group snapshot list consistency group snapshot show in volume v2 (v2 only) Change-Id: Ib4115f8ff00fb5aa8194588223032657eb1346b5 Closes-Bug: #1642238 Implements: bp cinder-command-support
2016-11-16 20:55:21 +08:00
[--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:
doc: Correct Sphinx warnings - Fix option-describe typos - Correct option and envvar markup, for commands that are using the reference form instead of the definition form or are marking up option arguments as options - Avoid duplicate commands - Fix some invalid docstrings - Fix some invalid indentation - Disable the murano plugin, which has invalid docs - Correct issues with- and track the network-topology spec - Include API modules in docs Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
2017-03-20 16:19:27 +00:00
.. describe:: <snapshot-name>
Add commands for "consistency group snapshot" Add commands: consistency group snapshot create consistency group snapshot delete consistency group snapshot list consistency group snapshot show in volume v2 (v2 only) Change-Id: Ib4115f8ff00fb5aa8194588223032657eb1346b5 Closes-Bug: #1642238 Implements: bp cinder-command-support
2016-11-16 20:55:21 +08:00
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
change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack consistency group snapshot delete
Add commands for "consistency group snapshot" Add commands: consistency group snapshot create consistency group snapshot delete consistency group snapshot list consistency group snapshot show in volume v2 (v2 only) Change-Id: Ib4115f8ff00fb5aa8194588223032657eb1346b5 Closes-Bug: #1642238 Implements: bp cinder-command-support
2016-11-16 20:55:21 +08:00
<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
change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack consistency group snapshot list
Add commands for "consistency group snapshot" Add commands: consistency group snapshot create consistency group snapshot delete consistency group snapshot list consistency group snapshot show in volume v2 (v2 only) Change-Id: Ib4115f8ff00fb5aa8194588223032657eb1346b5 Closes-Bug: #1642238 Implements: bp cinder-command-support
2016-11-16 20:55:21 +08:00
[--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
change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
2016-12-20 09:03:29 +08:00
openstack consistency group snapshot show
Add commands for "consistency group snapshot" Add commands: consistency group snapshot create consistency group snapshot delete consistency group snapshot list consistency group snapshot show in volume v2 (v2 only) Change-Id: Ib4115f8ff00fb5aa8194588223032657eb1346b5 Closes-Bug: #1642238 Implements: bp cinder-command-support
2016-11-16 20:55:21 +08:00
<consistency-group-snapshot>
.. _consistency_group_snapshot_show-consistency-group-snapshot:
.. describe:: <consistency-group-snapshot>
Consistency group snapshot to display (name or ID)
Copy Permalink