openstack.image.v2.image

openstack.image.v2.image

The Image Class

The Image class inherits from Resource.

class openstack.image.v2.image.Image(synchronized=False, **attrs)
checksum = None

Hash of the image data used. The Image service uses this value for verification.

container_format = None

The container format refers to whether the VM image is in a file format that also contains metadata about the actual VM. Container formats include OVF and Amazon AMI. In addition, a VM image might not have a container format - instead, the image is just a blob of unstructured data.

created_at = None

The date and time when the image was created.

disk_format = None

Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk. The disk format of a VM image is the format of the underlying disk image. Virtual appliance vendors have different formats for laying out the information contained in a VM disk image.

is_protected = None

Defines whether the image can be deleted. Type: bool

min_disk = None

The minimum disk size in GB that is required to boot the image.

min_ram = None

The minimum amount of RAM in MB that is required to boot the image.

name = None

The name of the image.

owner_id = None

The ID of the owner, or project, of the image.

properties = None

Properties, if any, that are associated with the image.

size = None

The size of the image data, in bytes.

store = None

When present, Glance will attempt to store the disk image data in the backing store indicated by the value of the header. When not present, Glance will store the disk image data in the backing store that is marked default. Valid values are: file, s3, rbd, swift, cinder, gridfs, sheepdog, or vsphere.

status = None

The image status.

tags = None

Tags, if any, that are associated with the image.

updated_at = None

The date and time when the image was updated.

virtual_size = None

The virtual size of the image.

visibility = None

The image visibility.

file = None

The URL for the virtual machine image file.

locations = None

A list of URLs to access the image file in external store. This list appears if the show_multiple_locations option is set to true in the Image service’s configuration file.

direct_url = None

The URL to access the image file kept in external store. It appears when you set the show_image_direct_url option to true in the Image service’s configuration file.

path = None

An image property.

value = None

Value of image property used in add or replace operations expressed in JSON notation. For example, you must enclose strings in quotation marks, and you do not enclose numeric values in quotation marks.

url = None

The URL to access the image file kept in external store.

metadata = None

The location metadata.

deactivate(session)

Deactivate an image

Note: Only administrative users can view image locations for deactivated images.

reactivate(session)

Reactivate an image

Note: The image must exist in order to be reactivated.

add_tag(session, tag)

Add a tag to an image

remove_tag(session, tag)

Remove a tag from an image

upload(session)

Upload data into an existing image

download(session)

Download the data contained in an image

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.