python-openstackclient/doc/source/command-objects/volume-transfer-request.rst
Dean Troyer 709eac73fb Fix volume transfers request commands
* Fix volume transfer request accept to actually not crash when
  trying to call Volume API.
* Fix volume transfer request accept syntax to have only one
  positional argument, which is the ID of the resource in the command
* Change the output column order in volume transfer request list to
  have ID followed by Name then the remaining columns.

Closes-bug: 1633582
Change-Id: I5cc005f039d171cc70859f60e7fe649b09ead229
2017-03-27 12:31:42 -05:00

97 lines
2.0 KiB
ReStructuredText

=======================
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)