Image objects are the base for which containers are built. Many of the methods of images are asynchronous, as they required reading and writing large files.

Manager methods

Images can be queried through the following client manager methods:

  • all() - Retrieve all images.
  • get() - Get a specific image, by its fingerprint.
  • get_by_alias() - Ger a specific image using its alias.

And create through the following methods, there’s also a copy method on an image:

  • create(data, public=False, wait=True) - Create a new image. The first argument is the binary data of the image itself. If the image is public, set public to True.
  • create_from_simplestreams(server, alias, public=False, auto_update=False, wait=False) - Create an image from simplestreams.
  • create_from_url(url, public=False, auto_update=False, wait=False) - Create an image from a url.

Image attributes

For more information about the specifics of these attributes, please see the LXD documentation.

  • aliases - A list of aliases for this image
  • auto_update - Whether the image should auto-update
  • architecture - The target architecture for the image
  • cached - Whether the image is cached
  • created_at - The date and time the image was created
  • expires_at - The date and time the image expires
  • filename - The name of the image file
  • fingerprint - The image fingerprint, a sha2 hash of the image data itself. This unique key identifies the image.
  • last_used_at - The last time the image was used
  • properties - The configuration of image itself
  • public - Whether the image is public or not
  • size - The size of the image
  • uploaded_at - The date and time the image was uploaded
  • update_source - A dict of update informations

Image methods

  • export - Export the image. Returns a file object with the contents of the image. Note: Prior to pylxd 2.1.1, this method returned a bytestring with data; as it was not unbuffered, the API was severely limited.
  • add_alias - Add an alias to the image.
  • delete_alias - Remove an alias.
  • copy - Copy the image to another LXD client.
  • delete - Deletes the image.


Image operations follow the same protocol from the client`s images manager (i.e. get, all, and create). Images are keyed on a sha-1 fingerprint of the image itself. To get an image…

>>> image = client.images.get(
...     'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855')
>>> image
<image.Image at 0x7f95d8af72b0>

Once you have an image, you can operate on it as before:

>>> image.public
>>> image.public = True

To create a new Image, you’ll open an image file, and pass that to create. If the image is to be public, public=True. As this is an asynchonous operation, you may also want to wait=True.

>>> image_data = open('an_image.tar.gz', 'rb').read()
>>> image = client.images.create(image_data, public=True, wait=True)
>>> image.fingerprint

Finally, delete an image. As this is an asynchonous operation, you may also want to wait=True.

>>> image = client.images.get(
...     'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855')
>>> image.delete(wait=True)