1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
The :program:`manila` shell utility
=========================================
.. important::
This shell client is deprecated as of version ``5.0.0``. A future
version of python-manilaclient may not ship this legacy shell client. If
you rely on it, it is highly recommended that you begin using the
openstack CLI client right away. Refer to the `mapping guide
<../cli/decoder.html>`_ to help with this transition.
.. program:: manila
.. highlight:: bash
The :program:`manila` shell utility interacts with the OpenStack Manila API
from the command line. It supports the entirety of the OpenStack Manila API.
You'll need to provide :program:`manila` with your OpenStack username and API
key. You can do this with the `--os-username`, `--os-password` and
`--os-tenant-name` options, but it's easier to just set them as environment
variables by setting two environment variables:
.. envvar:: OS_USERNAME or MANILA_USERNAME
Your OpenStack Manila username.
.. envvar:: OS_PASSWORD or MANILA_PASSWORD
Your password.
.. envvar:: OS_TENANT_NAME or MANILA_PROJECT_ID
Project for work.
.. envvar:: OS_AUTH_URL or MANILA_URL
The OpenStack API server URL.
.. envvar:: OS_SHARE_API_VERSION
The OpenStack Shared Filesystems API version.
For example, in Bash you'd use::
export OS_USERNAME=foo
export OS_PASSWORD=bar
export OS_TENANT_NAME=foobarproject
export OS_AUTH_URL=http://...
export OS_SHARE_API_VERSION=2
From there, all shell commands take the form::
manila <command> [arguments...]
Run :program:`manila help` to get a full list of all possible commands,
and run :program:`manila help <command>` to get detailed help for that
command.
.. program-output:: manila --help
|
