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.
haixin 180ab3e0a2 Change the default value of description of type show 1 month ago
contrib/ci Add CLI commands for Manage-Unmanage of Share Servers 4 months ago
doc Replace git.openstack.org URLs with opendev.org URLs 2 months ago
etc Implement functionality for functional tests using tempest-lib 4 years ago
manilaclient Change the default value of description of type show 1 month ago
playbooks/legacy/manilaclient-dsvm-neutron-functional OpenDev Migration Patch 2 months ago
rally-jobs Add rally job manifests 1 year ago
releasenotes Change the default value of description of type show 1 month ago
tools Avoid tox_install.sh for constraints support 1 year ago
.gitignore Drop 'clidoc' from sphinx extensions 10 months ago
.gitreview OpenDev Migration Patch 2 months ago
.stestr.conf Switch to use stestr instead of testr 1 year ago
.zuul.yaml OpenDev Migration Patch 2 months ago
CONTRIBUTING.rst Replace http with https 2 years ago
HACKING TrivialFix for HACKING file 1 year ago
LICENSE setup.py fixed 5 years ago
README.rst Replace git.openstack.org URLs with opendev.org URLs 2 months ago
lower-constraints.txt Drop 'clidoc' from sphinx extensions 10 months ago
requirements.txt Remove docutils requirement 4 months ago
run_tests.sh Remove nonexistent directory "tests" from pep8 scanning 4 years ago
setup.cfg Dropping the py35 testing 3 months ago
setup.py Updated from global requirements 2 years ago
test-requirements.txt Switch to use stestr instead of testr 1 year ago
tox.ini Replace git.openstack.org URLs with opendev.org URLs 2 months ago

README.rst

Team and repository tags

image

Python bindings to the OpenStack Manila API

Latest Version

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.

Contents:

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=http://example.com:5000/v2.0/

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 http://example.com:5000/v2.0/
>>> from manilaclient.v1 import client
>>> nt = client.Client(USER, PASS, TENANT, AUTH_URL, service_type="share")
>>> nt.shares.list()
[...]