Python bindings for Manila
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul 346c608535 Merge "Add a waiter to share extend/shrink" 3 months ago
doc [OSC] Implement Share Adopt & Abandon Commands 4 months ago
etc Implement functionality for functional tests using tempest-lib 7 years ago
manilaclient Merge "Add a waiter to share extend/shrink" 3 months ago
playbooks/python-manilaclient-functional Migrate functional job to native zuulv3 10 months ago
rally-jobs Add rally job manifests 4 years ago
releasenotes Add a waiter to share extend/shrink 3 months ago
roles/populate-manilaclient-config Add commands for share server migration 7 months ago
tools TrivialFix: Remove unnecessary future imports 11 months ago
zuul.d Add Python3 wallaby unit tests 7 months ago
.gitignore Drop 'clidoc' from sphinx extensions 3 years ago
.gitreview OpenDev Migration Patch 2 years ago
.stestr.conf Switch to use stestr instead of testr 3 years ago
CONTRIBUTING.rst [ussuri][goal] Change contributor guide 12 months ago
HACKING TrivialFix for HACKING file 4 years ago
LICENSE fixed 8 years ago
README.rst Add PDF documentation build 2 years ago
bindep.txt Remove python2 installation from bindep 6 months ago
lower-constraints.txt [goal] Migrate testing to ubuntu focal 7 months ago
requirements.txt Cleanup py27 support 1 year ago Remove nonexistent directory "tests" from pep8 scanning 6 years ago
setup.cfg [OSC] Implement the second part of share snapshots commands 3 months ago Cleanup py27 support 1 year ago
test-requirements.txt Use unittest.mock instead of third party lib 10 months ago
tox.ini Replace deprecated UPPER_CONSTRAINTS_FILE variable 5 months ago


Team and repository tags


Python bindings to the OpenStack Manila API

This is a client for the OpenStack Manila API. There's a Python API (the manilaclient module), and a command-line script (manila). Each implements 100% of the OpenStack Manila API.

See the OpenStack CLI guide for information on how to use the manila command-line tool. You may also want to look at the OpenStack API documentation.

The project is hosted on Launchpad, where bugs can be filed. The code is hosted on Github. Patches must be submitted using Gerrit, not Github pull requests.

This code is a fork of Cinderclient of Grizzly release and then it was developed separately. Cinderclient code is a fork of Jacobian's python-cloudservers If you need API support for the Rackspace API solely or the BSD license, you should use that repository. python-manilaclient is licensed under the Apache License like the rest of OpenStack.


Command-line API

Installing this package gets you a shell command, manila, that you can use to interact with any Rackspace compatible API (including OpenStack).

You'll need to provide your OpenStack username and password. You can do this with the --os-username, --os-password and --os-tenant-name params, but it's easier to just set them as environment variables:

export OS_USERNAME=foouser
export OS_PASSWORD=barpass
export OS_TENANT_NAME=fooproject

You will also need to define the authentication url either with param --os-auth-url or as an environment variable:

export OS_AUTH_URL=

Since Keystone can return multiple regions in the Service Catalog, you can specify the one you want with --os-region-name (or export OS_REGION_NAME). It defaults to the first in the list returned.

You'll find complete documentation on the shell by running manila help, see manila help COMMAND for help on a specific command.

Python API

There's also a complete Python API, but it has not yet been documented.

Quick-start using keystone:

# use v2.0 auth with
>>> from manilaclient.v1 import client
>>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="share")
>>> nt.shares.list()