6785f07e7b
This patch introduces a new directory layout in doc/source in conformance with the OpenStack manuals project migration spec [1], moves the existing content in manila/doc/source into the new directories, and adjusts index files accordingly. This is the first step in the migration process as outlined in the spec. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Closes-Bug: #1706181 Change-Id: I8964d066bb838fabbe94239ac108bff884c6ff76 Depends-On: I72be6303f9be77c0461eaacbc61bad8372546fb5 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
27 lines
823 B
ReStructuredText
27 lines
823 B
ReStructuredText
The :program:`manilaclient` Python API
|
|
======================================
|
|
|
|
.. module:: manilaclient
|
|
:synopsis: A client for the OpenStack Manila API.
|
|
|
|
.. currentmodule:: manilaclient
|
|
|
|
Usage
|
|
-----
|
|
|
|
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
|
|
|