summaryrefslogtreecommitdiff
path: root/doc/source/user/shell.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/user/shell.rst')
-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...]