Go to file
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
2023-08-23 22:10:03 +00:00
2022-07-06 19:17:31 +00:00
2017-07-31 19:57:48 -04:00
2021-07-27 14:21:47 +00:00
2019-04-19 19:44:14 +00:00
2021-07-27 08:46:08 -03:00
2021-07-14 10:26:30 +01:00
2013-09-03 14:37:34 +03:00
2019-09-13 14:00:46 -04:00
2023-07-07 16:25:38 -03:00
2020-04-04 11:30:07 +02:00
2023-01-04 09:58:16 -08:00

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()
[...]
Description
Python bindings for Manila
Readme 27 MiB
Languages
Python 100%