Atom feed of this document

 Image metadata

You can associate metadata with an image using the --property key=value argument to glance image-create or glance image-update.For example:

$ glance image-update img-uuid --property architecture=arm --property hypervisor_type=qemu

If the following properties are set on an image, and the ImagePropertiesFilter scheduler filter is enabled (which it is by default), then the scheduler will only consider compute hosts that satisfy these properties:


The CPU architecture that must be supported by the hypervisor, e.g. x86_64, arm, ppc64. Run uname -m to get the architecture of a machine. We strongly recommend using the architecture data vocabulary defined by the libosinfo project for this purpose. Recognized values for this field are:


The hypervisor type. Allowed values include: xen, qemu, kvm, lxc, uml, vmware, hyperv, powervm.


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


Fully virtualized. This is the mode used by QEMU and KVM.


Xen 3.0 paravirtualized.


User Mode Linux paravirtualized.


Executables in containers. This is the mode used by LXC.

The following metadata properties are specific to the XenAPI driver:


A boolean option. If true, the root partition on the disk will be automatically resized before the instance boots. This value is only taken into account by the Compute service when using a Xen-based hypervisor with the XenAPI driver. The Compute service will only attempt to resize if there is a single partition on the image, and only if the partition is in ext3 or ext4 format.


The operating system installed on the image, e.g. linux, windows. The XenAPI driver contains logic that will take different actions depending on the value of the os_type parameter of the image. For example, for images where os_type=windows, it will create a FAT32-based swap partition instead of a Linux swap partition, and it will limit the injected hostname to less than 16 characters.

The following metadata properties are specific to the VMware API driver:


Indicates the virtual SCSI or IDE controller used by the hypervisor. Allowed values: lsiLogic, busLogic, ide


A VMware GuestID which describes the operating system installed in the image. This will be passed to the hypervisor when creating a virtual machine. See for a list of valid values. If this is not specified, it will default to otherGuest.


Currently unused, set it to 1.

In order to assist end-users in utilizing images, you may wish to put additional common metadata on Glance images. By community agreement, the following metadata keys may be used across Glance installations for the purposes described below.


For snapshot images, this is the UUID of the server used to create this image.


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


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


The operating system version as specified by the distributor.


The value of this property is the common name of the operating system distribution in all-lowercase. For this purpose, we use the same data vocabulary as the libosinfo project. Following are the recognized values for this property. In the interest of interoperability, please use only a recognized value for this field. The deprecated values are listed to assist you in searching for the recognized value. Allowed values are:


This is: Arch Linux

Do not use: archlinux, or org.archlinux


This is: Community Enterprise Operating System

Do not use: org.centos CentOS


This is: Debian

Do not use: Debian, or org.debian


This is: Fedora

Do not use: Fedora, org.fedora, or org.fedoraproject


This is: FreeBSD

Do not use: org.freebsd, freeBSD, or FreeBSD


This is: Gentoo Linux

Do not use: Gentoo, or org.gentoo


This is: Mandrakelinux (MandrakeSoft)

Do not use: mandrakelinux, or MandrakeLinux


This is: Mandriva Linux

Do not use: mandrivalinux


This is: Mandriva Enterprise Server

Do not use: mandrivaent, or mandrivaES


This is: Microsoft Disc Operating System

Do not use: ms-dos


This is: NetBSD

Do not use: NetBSD, or org.netbsd


This is: Novell NetWare

Do not use: novell, or NetWare


This is: OpenBSD

Do not use: OpenBSD, or org.openbsd


Do not use: OpenSolaris,or org.opensolaris


This is: openSUSE

Do not use: suse, SuSE, or org.opensuse


This is: Red Hat Enterprise Linux

Do not use: redhat, RedHat, or com.redhat


This is: SUSE Linux Enterprise Desktop

Do not use: com.suse


This is: Ubuntu

Do not use: Ubuntu, com.ubuntu, org.ubuntu, or canonical


This is: Microsoft Windows

Do not use:, or windoze

Log a bug against this page

loading table of contents...