summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2019-09-04 23:41:36 +0000
committerGerrit Code Review <review@openstack.org>2019-09-04 23:41:36 +0000
commit4bd9000eddfa559ab831df92b7108d15a4b15c87 (patch)
treec84fb51d0de203d2463992f40037830c4de10538 /doc
parent6f761f6bf0764e4b42a56dbd73c24adf6be038e2 (diff)
parentd1b044b82a9d632e5769b377abe4f7f653cb94d4 (diff)
downloadpython-cinderclient-4bd9000eddfa559ab831df92b7108d15a4b15c87.tar.gz
Merge "Autonegotiate API version for shell"
Diffstat (limited to 'doc')
-rw-r--r--doc/source/user/shell.rst8
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...]