diff options
| author | Eric Harney <eharney@redhat.com> | 2019-06-10 13:07:37 -0400 |
|---|---|---|
| committer | Eric Harney <eharney@redhat.com> | 2019-08-28 11:57:02 -0400 |
| commit | d1b044b82a9d632e5769b377abe4f7f653cb94d4 (patch) | |
| tree | 7437a4bd9586a04f91bf3ba174b0358d573c7b62 /doc/source/user | |
| parent | a9d9d347788f6a604d3dc7bbd43393efb73d8553 (diff) | |
| download | python-cinderclient-d1b044b82a9d632e5769b377abe4f7f653cb94d4.tar.gz | |
Autonegotiate API version for shell
If OS_VOLUME_API_VERSION is not set, use the highest
supported by both the client and the server.
If OS_VOLUME_API_VERSION exceeds that supported by the server,
use the highest supported by both the client and the server.
A warning message is printed for the user indicating that this
happened.
(This is similar to the behavior of the manila CLI, and is
mostly code from manilaclient tweaked to work in cinderclient.)
Change-Id: Ie1403eca2a191f62169e60c0cde1622575327387
Diffstat (limited to 'doc/source/user')
| -rw-r--r-- | doc/source/user/shell.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/source/user/shell.rst b/doc/source/user/shell.rst index 0d03b01..50d8feb 100644 --- a/doc/source/user/shell.rst +++ b/doc/source/user/shell.rst @@ -40,6 +40,14 @@ For example, in Bash you'd use:: export OS_AUTH_URL=http://auth.example.com:5000/v3 export OS_VOLUME_API_VERSION=3 +If OS_VOLUME_API_VERSION is not set, the highest version +supported by the server will be used. + +If OS_VOLUME_API_VERSION exceeds the highest version +supported by the server, the highest version supported by +both the client and server will be used. A warning +message is printed when this occurs. + From there, all shell commands take the form:: cinder <command> [arguments...] |