Files
python-manilaclient/doc/source/user/shell.rst
Goutham Pacha Ravi d146a345c7 Drop 'clidoc' from sphinx extensions
Replace it with program-output from
sphinxcontrib-programoutput

Depends-On: https://review.openstack.org/595480
Change-Id: I9b14af568996cc1aaefaeb4d94fe36163c6cbbf2
2018-08-23 19:21:34 -07:00

1.4 KiB

The manila shell utility

manila

The 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 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:

OS_USERNAME or MANILA_USERNAME

Your OpenStack Manila username.

OS_PASSWORD or MANILA_PASSWORD

Your password.

OS_TENANT_NAME or MANILA_PROJECT_ID

Project for work.

OS_AUTH_URL or MANILA_URL

The OpenStack API server URL.

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 manila help to get a full list of all possible commands, and run manila help <command> to get detailed help for that command.

manila --help