diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-13 15:55:33 -0400 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2017-06-23 11:54:32 +0200 |
| commit | 9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch) | |
| tree | 9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/command-objects/consistency-group.rst | |
| parent | 19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff) | |
| download | python-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/command-objects/consistency-group.rst')
| -rw-r--r-- | doc/source/command-objects/consistency-group.rst | 173 |
1 files changed, 0 insertions, 173 deletions
diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst deleted file mode 100644 index 57082c6d..00000000 --- a/doc/source/command-objects/consistency-group.rst +++ /dev/null @@ -1,173 +0,0 @@ -================= -consistency group -================= - -Block Storage v2 - -consistency group add volume ----------------------------- - -Add volume(s) to consistency group. - -.. program:: consistency group add volume -.. code:: bash - - openstack consistency group add volume - <consistency-group> - <volume> [<volume> ...] - -.. _consistency_group_add_volume: -.. describe:: <consistency-group> - - Consistency group to contain <volume> (name or ID) - -.. describe:: <volume> - - Volume(s) to add to <consistency-group> (name or ID) - (repeat option to add multiple volumes) - -consistency group create ------------------------- - -Create new consistency group. - -.. program:: consistency group create -.. code:: bash - - openstack consistency group create - --volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot> - [--description <description>] - [--availability-zone <availability-zone>] - [<name>] - -.. option:: --volume-type <volume-type> - - Volume type of this consistency group (name or ID) - -.. option:: --consistency-group-source <consistency-group> - - Existing consistency group (name or ID) - -.. option:: --consistency-group-snapshot <consistency-group-snapshot> - - Existing consistency group snapshot (name or ID) - -.. option:: --description <description> - - Description of this consistency group - -.. option:: --availability-zone <availability-zone> - - Availability zone for this consistency group - (not available if creating consistency group from source) - -.. _consistency_group_create-name: -.. describe:: <name> - - Name of new consistency group (default to None) - -consistency group delete ------------------------- - -Delete consistency group(s). - -.. program:: consistency group delete -.. code:: bash - - openstack consistency group delete - [--force] - <consistency-group> [<consistency-group> ...] - -.. option:: --force - - Allow delete in state other than error or available - -.. _consistency_group_delete-consistency-group: -.. describe:: <consistency-group> - - Consistency group(s) to delete (name or ID) - -consistency group list ----------------------- - -List consistency groups. - -.. program:: consistency group list -.. code:: bash - - openstack consistency group list - [--all-projects] - [--long] - -.. option:: --all-projects - - Show detail for all projects. Admin only. - (defaults to False) - -.. option:: --long - - List additional fields in output - -consistency group remove volume -------------------------------- - -Remove volume(s) from consistency group. - -.. program:: consistency group remove volume -.. code:: bash - - openstack consistency group remove volume - <consistency-group> - <volume> [<volume> ...] - -.. _consistency_group_remove_volume: -.. describe:: <consistency-group> - - Consistency group containing <volume> (name or ID) - -.. describe:: <volume> - - Volume(s) to remove from <consistency-group> (name or ID) - (repeat option to remove multiple volumes) - -consistency group set ---------------------- - -Set consistency group properties. - -.. program:: consistency group set -.. code:: bash - - openstack consistency group set - [--name <name>] - [--description <description>] - <consistency-group> - -.. option:: --name <name> - - New consistency group name - -.. option:: --description <description> - - New consistency group description - -.. _consistency_group_set-consistency-group: -.. describe:: <consistency-group> - - Consistency group to modify (name or ID) - -consistency group show ----------------------- - -Display consistency group details. - -.. program:: consistency group show -.. code:: bash - - openstack consistency group show - <consistency-group> - -.. _consistency_group_show-consistency-group: -.. describe:: <consistency-group> - - Consistency group to display (name or ID) |
