openstack/python-manilaclient
Code Issues Proposed changes
e91b9e6467
python-manilaclient/doc/source/index.rst
Valeriy Ponomaryov fc658dd932 Update manila docs 
After manila's fork from cinder, its docs were not
updated well.

Partially implements: blueprint manila-documentation

Change-Id: Idcf611ff08a9c7fdad1c87714444579eac85e479
2014-06-17 11:01:29 -04:00

1.3 KiB
Raw Blame History

Python API

In order to use the python api directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so:

>>> from manilaclient import client
>>> manila = client.Client('1', $OS_USER_NAME, $OS_PASSWORD, $OS_TENANT_NAME, $OS_AUTH_URL)
>>> manila.shares.list()
[]
>>> share = manila.shares.create(share_proto="nfs", size=1, share_network_id="some_share_network_id")
>>> share.id
ce06d0a8-5c1b-4e2c-81d2-39eca6bbfb70
>>> manila.shares.list()
[<Share: ce06d0a8-5c1b-4e2c-81d2-39eca6bbfb70>]
>>>share.delete

Command-line Tool

In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding configuration options (--os-username, --os-password, --os-tenant-id, and --os-auth-url) or set them in environment variables:

export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v2.0

Once you've configured your authentication parameters, you can run manila help to see a complete listing of available commands.

Release Notes

No releases.