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 openstack image set and openstack image create commands. For example:
$ openstack image set IMG-UUID --property architecture=x86_64
Note
Behavior set using image properties overrides behavior set using flavors. For more information, refer to the Manage images in the OpenStack Administrator Guide.
| 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. Note that qemu is used for both QEMU and KVM
hypervisor types. |
hyperv, ironic, lxc, qemu, uml, vmware, or
xen. |
| All | instance_type_rxtx_factor |
Optional property allows created servers to have a different bandwidth
cap than that defined in the network they are attached to. This factor
is multiplied by the rxtx_base property of the network. The
rxtx_base property defaults to 1.0, which is the same as the
attached network. This parameter is only available for Xen or NSX based
systems. |
Float (default value is 1.0) |
| All | instance_uuid |
For snapshot images, this is the UUID of the server used to create this image. | Valid server UUID |
| All | img_config_drive |
Specifies whether the image needs a config drive. | mandatory or optional (default if property is not used). |
| 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. |
|
| All | os_version |
The operating system version as specified by the distributor. | Valid version number (for example, 11.10). |
| All | os_secure_boot |
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. For Hyper-V: Images must be prepared as Generation 2 VMs. Instance must
also contain |
|
| 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. |
|
| libvirt API driver | hw_cpu_sockets |
The preferred number of sockets to expose to the guest. | Integer. |
| libvirt API driver | hw_cpu_cores |
The preferred number of cores to expose to the guest. | Integer. |
| libvirt API driver | hw_cpu_threads |
The preferred number of threads to expose to the guest. | Integer. |
| libvirt API driver | hw_disk_bus |
Specifies the type of disk controller to attach disk devices to. | One of scsi, virtio, uml, xen, ide, or usb. |
| 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:
rng_dev_path=/dev/hwrng
|
virtio, or other supported device. |
| libvirt API driver, Hyper-V driver | hw_machine_type |
For libvirt: 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 For Hyper-V: Specifies whether the Hyper-V instance will be a generation 1 or generation 2 VM. By default, if the property is not provided, the instances will be generation 1 VMs. If the image is specific for generation 2 VMs but the property is not provided accordingly, the instance will fail to boot. |
For libvirt: Valid types can be viewed by using the
virsh capabilities command (machine types are displayed in
the For hyper-V: Acceptable values are either |
| libvirt API driver, XenAPI driver | os_type |
The operating system installed on the image. The libvirt API driver
and 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. |
| libvirt API driver | hw_scsi_model |
Enables the use of VirtIO SCSI (virtio-scsi) to provide block
device access for compute instances; by default, instances use VirtIO
Block (virtio-blk). VirtIO SCSI is a para-virtualized SCSI
controller device that provides improved scalability and performance,
and supports advanced SCSI hardware. |
virtio-scsi |
| libvirt API driver | hw_serial_port_count |
Specifies the count of serial ports that should be provided. If
hw:serial_port_count is not set in the flavor's extra_specs, then
any count is permitted. If hw:serial_port_count is set, then this
provides the default serial port count. It is permitted to override the
default serial port count, but only with a lower value. |
Integer |
| 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. |
|
| 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). |
|
| libvirt API driver and VMware API driver | hw_vif_model |
Specifies the model of virtual network interface device to use. |
|
| libvirt API driver | hw_vif_multiqueue_enabled |
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. |
true | false |
| libvirt API driver | hw_boot_menu |
If true, enables the BIOS bootmenu. In cases where both the image
metadata and Extra Spec are set, the Extra Spec setting is used. This
allows for flexibility in setting/overriding the default behavior as
needed. |
true or false |
| VMware API driver | vmware_adaptertype |
The virtual SCSI or IDE controller used by the hypervisor. | lsiLogic, lsiLogicsas, busLogic, ide, or
paraVirtual. |
| 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 or false |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.