diff options
| author | Huanxuan Ao <huanxuan.ao@easystack.cn> | 2016-11-16 20:55:21 +0800 |
|---|---|---|
| committer | Huanxuan Ao <huanxuan.ao@easystack.cn> | 2016-11-19 09:20:15 +0800 |
| commit | 3907137f5824e359bcdcfcdd8ab3d15a83d10bca (patch) | |
| tree | 1233a5516eff68326d81da08007bedae84e9e4c5 /doc/source | |
| parent | f4536e708dff37edcaf79ea85c9f68206315edea (diff) | |
| download | python-openstackclient-3907137f5824e359bcdcfcdd8ab3d15a83d10bca.tar.gz | |
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
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/command-objects/consistency-group-snapshot.rst | 96 | ||||
| -rw-r--r-- | doc/source/commands.rst | 1 |
2 files changed, 97 insertions, 0 deletions
diff --git a/doc/source/command-objects/consistency-group-snapshot.rst b/doc/source/command-objects/consistency-group-snapshot.rst new file mode 100644 index 00000000..b7b1423e --- /dev/null +++ b/doc/source/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 + + os 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: +.. option:: <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 + + os 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 + + os 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 + + os 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) diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 6a4d9990..d8fb48bd 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -81,6 +81,7 @@ referring to both Compute and Volume quotas. * ``compute service``: (**Compute**) a cloud Compute process running on a host * ``configuration``: (**Internal**) OpenStack client configuration * ``consistency group``: (**Volume**) a consistency group of volumes +* ``consistency group snapshot``: (**Volume**) a point-in-time copy of a consistency group * ``console log``: (**Compute**) server console text dump * ``console url``: (**Compute**) server remote console URL * ``consumer``: (**Identity**) OAuth-based delegatee |
