f00f769da5
* add image property examples for v1 and v2 * add standard sphinx doc build helper Change-Id: I2f8dff884d9f22cc582aabcbbbbaea6d6fe725c0
90 lines
1.8 KiB
ReStructuredText
90 lines
1.8 KiB
ReStructuredText
Python API v2
|
|
=============
|
|
|
|
To create a client::
|
|
|
|
from keystoneclient.auth.identity import v2 as identity
|
|
from keystoneclient import session
|
|
from glanceclient import Client
|
|
|
|
auth = identity.Password(auth_url=AUTH_URL,
|
|
username=USERNAME,
|
|
password=PASSWORD,
|
|
tenant_name=PROJECT_ID)
|
|
|
|
sess = session.Session(auth=auth)
|
|
token = auth.get_token(sess)
|
|
|
|
glance = Client('2', endpoint=OS_IMAGE_ENDPOINT, token=token)
|
|
|
|
|
|
Create
|
|
------
|
|
Create a new image::
|
|
|
|
image = glance.images.create(name="myNewImage")
|
|
glance.images.upload(image.id, open('/tmp/myimage.iso', 'rb'))
|
|
|
|
Show
|
|
----
|
|
Describe a specific image::
|
|
|
|
glance.images.get(image.id)
|
|
|
|
Update
|
|
------
|
|
Update a specific image::
|
|
|
|
# update with a list of image attribute names and their new values
|
|
glance.images.update(image.id, name="myNewImageName")
|
|
|
|
Custom Properties
|
|
-----------------
|
|
Set a custom property on an image::
|
|
|
|
# set an arbitrary property on an image
|
|
glance.images.update(image.id, my_custom_property='value')
|
|
|
|
Remove a custom property from an image::
|
|
|
|
# remove the custom property 'my_custom_property'
|
|
glance.images.update(image.id, remove_props=['my_custom_property'])
|
|
|
|
Delete
|
|
------
|
|
Delete specified image(s)::
|
|
|
|
glance.images.delete(image.id)
|
|
|
|
List
|
|
----
|
|
List images you can access::
|
|
|
|
for image in glance.images.list():
|
|
print image
|
|
|
|
Download
|
|
--------
|
|
Download a specific image::
|
|
|
|
d = glance.images.data(image.id)
|
|
|
|
Share an Image
|
|
--------------
|
|
Share a specific image with a tenant::
|
|
|
|
glance.image_members.create(image_id, member_id)
|
|
|
|
Remove a Share
|
|
--------------
|
|
Remove a shared image from a tenant::
|
|
|
|
glance.image_members.delete(image_id, member_id)
|
|
|
|
List Sharings
|
|
-------------
|
|
Describe sharing permissions by image or tenant::
|
|
|
|
glance.image_members.list(image_id)
|
|
|