openstack/deb-python-manilaclient
Code Issues Proposed changes
3229914644
deb-python-manilaclient/doc/source/shell.rst
Stephen Finucane e19b787dd4 Use Sphinx 1.5 warning-is-error 
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Enable this.

Change-Id: I8ea73cff6dc539c9f9db2f550ad8088812467d1b
2017-04-19 10:41:19 +01:00

1.4 KiB
Raw Blame History

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=1

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.