python-manilaclient/doc/source/user/shell.rst
Goutham Pacha Ravi ba9a388786 Deprecate "manila" CLI client
This has been a long time coming; we have finally
reached full feature parity and new features have
only been permitted in the openstack CLI plugin for
a couple of releases now.

We're signalling a major version bump for the package
with this change.

Implements: bp/openstack-client-support
Change-Id: I0a72883f1cd8a5ab9df9c349b6876248fe9edee3
2023-08-23 22:10:03 +00:00

1.7 KiB

The 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 to help with this transition.

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