Atom feed of this document
  
 

 Chapter 6. Image Service property keys

The following keys, together with the components to which they are specific, can be used with the property option for both the glance image-update and glance image-create commands. For example:

$ glance image-update IMG-UUID --property architecture=x86_64
[Note]Note

Behavior set using image properties overrides behavior set using flavors. For more information, refer to OpenStack Cloud Administrator Guide

Table 6.1. Property keys
Specific to Key Description Supported values
All architecture The CPU architecture that must be supported by the hypervisor. For example, x86_64, arm, or 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.
All hypervisor_type The hypervisor type. xen, qemu, kvm, lxc, uml, vmware, or hyperv
All instance_uuid For snapshot images, this is the UUID of the server used to create this image. Valid server UUID
All kernel_id The ID of an image stored in the Image Service that should be used as the kernel when booting an AMI-style image. Valid image ID
All os_distro The common name of the operating system distribution in lowercase (uses the same data vocabulary as the libosinfo project). Specify only a recognized value for this field. Deprecated values are listed to assist you in searching for the recognized value.
  • arch—Arch Linux. Do not use archlinux or org.archlinux

  • centos—Community Enterprise Operating System. Do not use org.centos or CentOS

  • debian—Debian. Do not use Debian or org.debian

  • fedora—Fedora. Do not use Fedora, org.fedora, or org.fedoraproject

  • freebsd—FreeBSD. Do not use org.freebsd, freeBSD, or FreeBSD

  • gentoo—Gentoo Linux. Do not use Gentoo or org.gentoo

  • mandrake—Mandrakelinux (MandrakeSoft) distribution. Do not use mandrakelinux or MandrakeLinux

  • mandriva—Mandriva Linux. Do not use mandrivalinux

  • mes—Mandriva Enterprise Server. Do not use mandrivaent or mandrivaES

  • msdos—Microsoft Disc Operating System. Do not use ms-dos

  • netbsd—NetBSD. Do not use NetBSD or org.netbsd

  • netware—Novell NetWare. Do not use novell or NetWare

  • openbsd—OpenBSD. Do not use OpenBSD or org.openbsd

  • opensolaris—OpenSolaris. Do not use OpenSolaris or org.opensolaris

  • opensuse—openSUSE. Do not use suse, SuSE, or org.opensuse

  • rhel—Red Hat Enterprise Linux. Do not use redhat, RedHat, or com.redhat

  • sled—SUSE Linux Enterprise Desktop. Do not use com.suse

  • ubuntu—Ubuntu. Do not use Ubuntu, com.ubuntu, org.ubuntu, or canonical

  • windows—Microsoft Windows. Do not use com.microsoft.server or windoze

All os_version The operating system version as specified by the distributor. Version number (for example, "11.10")
All ramdisk_id The ID of image stored in the Image Service that should be used as the ramdisk when booting an AMI-style image. Valid image ID
All vm_mode The virtual machine mode. This represents the host/guest ABI (application binary interface) used for the virtual machine.
  • hvm—Fully virtualized. This is the mode used by QEMU and KVM.

  • xen—Xen 3.0 paravirtualized.

  • uml—User Mode Linux paravirtualized.

  • exe—Executables in containers. This is the mode used by LXC.

libvirt API driver hw_rng_model Adds a random-number generator device to the image's instances. The cloud administrator can enable and control device behavior by configuring the instance's flavor. By default, the generator device is disabled. virtio
libvirt API driver hw_machine_type Enables booting an ARM system using the specified machine type. By default, if an ARM image is used and its type is not specified, Compute uses vexpress-a15 (for ARMv7) or virt (for AArch64) machine types. Libvirt machine type. Valid types can be viewed by using the virsh capabilities command (machine types are displayed in the machine tag).
libvirt API driver hw_video_model The video image driver used. vga, cirrus, vmvga, xen, or qxl
libvirt API driver hw_video_ram Maximum RAM for the video image. Used only if a hw_video:ram_max_mb value has been set in the flavor's extra_specs and that value is higher than the value set in hw_video_ram. Integer in MB (for example, '64')
libvirt API driver hw_watchdog_action Enables a virtual hardware watchdog device that carries out the specified action if the server hangs. The watchdog uses the i6300esb device (emulating a PCI Intel 6300ESB). If hw_watchdog_action is not specified, the watchdog is disabled.
  • disabled—(default) The device is not attached. Allows the user to disable the watchdog for the image, even if it has been enabled using the image's flavor.

  • reset—Forcefully reset the guest.

  • poweroff—Forcefully power off the guest.

  • pause—Pause the guest.

  • none—Only enable the watchdog; do nothing if the server hangs.

libvirt API driver os_command_line The kernel command line to be used by the libvirt driver, instead of the default. For linux containers (LXC), the value is used as arguments for initialization. This key is valid only for Amazon kernel, ramdisk, or machine images (aki, ari, or ami).
VMware API driver vmware_adaptertype The virtual SCSI or IDE controller used by the hypervisor. lsiLogic, busLogic, or ide
VMware API driver vmware_ostype A VMware GuestID which describes the operating system installed in the image. This value is passed to the hypervisor when creating a virtual machine. If not specified, the key defaults to otherGuest. See thinkvirt.com.
VMware API driver vmware_image_version Currently unused. 1
XenAPI driver auto_disk_config If true, the root partition on the disk is 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. true | false
XenAPI driver os_type The operating system installed on the image. The XenAPI driver contains logic that takes different actions depending on the value of the os_type parameter of the image. For example, for os_type=windows images, it creates a FAT32-based swap partition instead of a Linux swap partition, and it limits the injected host name to less than 16 characters. linux or windows
Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page

loading table of contents...