The Image Class

The Image class inherits from Resource.

class openstack.image.v2.image.Image(_synchronized=False, **attrs)

The base resource

Parameters:_synchronized (bool) – This is not intended to be used directly. See new() and existing().
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.

architecture = None

The CPU architecture that must be supported by the hypervisor.

hypervisor_type = None

The hypervisor type. Note that qemu is used for both QEMU and KVM hypervisor types.

instance_type_rxtx_factor = None

Optional property allows created servers to have a different bandwidth cap than that defined in the network they are attached to.

instance_uuid = None

create this image.

needs_config_drive = None

Specifies whether the image needs a config drive. mandatory or optional (default if property is not used).

kernel_id = None

The ID of an image stored in the Image service that should be used as the kernel when booting an AMI-style image.

os_distro = None

The common name of the operating system distribution in lowercase

os_version = None

The operating system version as specified by the distributor.

needs_secure_boot = None

Secure Boot is a security standard. When the instance starts, Secure Boot first examines software such as firmware and OS by their signature and only allows them to run if the signatures are valid.

ramdisk_id = None

The ID of image stored in the Image service that should be used as the ramdisk when booting an AMI-style image.

vm_mode = None

The virtual machine mode. This represents the host/guest ABI (application binary interface) used for the virtual machine.

hw_cpu_sockets = None

The preferred number of sockets to expose to the guest.

hw_cpu_cores = None

The preferred number of cores to expose to the guest.

hw_cpu_threads = None

The preferred number of threads to expose to the guest.

hw_disk_bus = None

Specifies the type of disk controller to attach disk devices to. One of scsi, virtio, uml, xen, ide, or usb.

hw_rng_model = None

Adds a random-number generator device to the image’s instances.

hw_machine_type = None

For libvirt: Enables booting an ARM system using the specified machine type. For Hyper-V: Specifies whether the Hyper-V instance will be a generation 1 or generation 2 VM.

hw_scsi_model = None

Enables the use of VirtIO SCSI (virtio-scsi) to provide block device access for compute instances; by default, instances use VirtIO Block (virtio-blk).

hw_serial_port_count = None

Specifies the count of serial ports that should be provided.

hw_video_model = None

The video image driver used.

hw_video_ram = None

Maximum RAM for the video image.

hw_watchdog_action = None

Enables a virtual hardware watchdog device that carries out the specified action if the server hangs.

os_command_line = None

The kernel command line to be used by the libvirt driver, instead of the default.

hw_vif_model = None

Specifies the model of virtual network interface device to use.

is_hw_vif_multiqueue_enabled = None

If true, this enables the virtio-net multiqueue feature. In this case, the driver sets the number of queues equal to the number of guest vCPUs. This makes the network performance scale across a number of vCPUs.

is_hw_boot_menu_enabled = None

If true, enables the BIOS bootmenu.

vmware_adaptertype = None

The virtual SCSI or IDE controller used by the hypervisor.

vmware_ostype = None

A VMware GuestID which describes the operating system installed in the image.

has_auto_disk_config = None

If true, the root partition on the disk is automatically resized before the instance boots.

os_type = None

The operating system installed on the image.


Deactivate an image

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


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 data into an existing image

download(session, stream=False)

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.