summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/volume-transfer-request.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/volume-transfer-request.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/volume-transfer-request.rst')
-rw-r--r--doc/source/cli/command-objects/volume-transfer-request.rst96
1 files changed, 96 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/volume-transfer-request.rst b/doc/source/cli/command-objects/volume-transfer-request.rst
new file mode 100644
index 00000000..23cd3d3e
--- /dev/null
+++ b/doc/source/cli/command-objects/volume-transfer-request.rst
@@ -0,0 +1,96 @@
+=======================
+volume transfer request
+=======================
+
+Block Storage v1, v2
+
+volume transfer request accept
+------------------------------
+
+Accept volume transfer request
+
+.. program:: volume transfer request accept
+.. code:: bash
+
+ openstack volume transfer request accept
+ --auth-key <key>
+ <transfer-request-id>
+
+.. option:: --auth-key <key>
+
+ Volume transfer request authentication key
+
+.. _volume_transfer_request_accept:
+.. describe:: <transfer-request-id>
+
+ Volume transfer request to accept (ID only)
+
+ Non-admin users are only able to specify the transfer request by ID.
+
+volume transfer request create
+------------------------------
+
+Create volume transfer request
+
+.. program:: volume transfer request create
+.. code:: bash
+
+ openstack volume transfer request create
+ [--name <name>]
+ <volume>
+
+.. option:: --name <name>
+
+ New transfer request name (default to None)
+
+.. _volume_transfer_request_create-volume:
+.. describe:: <volume>
+
+ Volume to transfer (name or ID)
+
+volume transfer request delete
+------------------------------
+
+Delete volume transfer request(s)
+
+.. program:: volume transfer request delete
+.. code:: bash
+
+ openstack volume transfer request delete
+ <transfer-request> [<transfer-request> ...]
+
+.. _volume_transfer_request_delete-transfer-request:
+.. describe:: <transfer-request>
+
+ Volume transfer request(s) to delete (name or ID)
+
+volume transfer request list
+----------------------------
+
+Lists all volume transfer requests
+
+.. program:: volume transfer request list
+.. code:: bash
+
+ openstack volume transfer request list
+ --all-projects
+
+.. option:: --all-projects
+
+ Include all projects (admin only)
+
+volume transfer request show
+----------------------------
+
+Show volume transfer request details
+
+.. program:: volume transfer request show
+.. code:: bash
+
+ openstack volume transfer request show
+ <transfer-request>
+
+.. _volume_transfer_request_show-transfer-request:
+.. describe:: <transfer-request>
+
+ Volume transfer request to display (name or ID)