Jump to contentJump to page navigation: previous page [access key p]/next page [access key n]

Name

domain — Top Xend VM Guest SXP Configuration Element

Synopsis

(domain { bootloader | bootloader_args | cpus |cpu_time | description | device | features | image | maxmem | memory | name | online_vcpus | on_crash | on_poweroff | on_reboot | on_xend_start | on_xend_stop | shadow_memory | start_time | status | store_mfn | uuid | vcpus })

The top level element of each VM Guest configuration is (domain). It needs several subelements to store all needed data.

bootloader

Define the program that is used to boot the VM Guest. Paravirtualized SUSE Linux Enterprise 11 systems use /usr/bin/pygrub by default. Example:

(bootloader /usr/bin/pygrub)

bootloader_args

Provide additional parameters to the boot loader program. Example:

(bootloader_args -q)

cpus

Defines which CPUs are available to a VM Guest. The settings may be changed with xm vcpu-pin. Example:

(cpus ((1 2) (1 2)))

cpu_time

Time in nanoseconds the VM Guest already used. Example:

(cpu_time 59.157413326)

description

Extra description for a VM Guest.

(description 'HVM guest')

device

(device { console | pci | vbd | vfb | vif | vkbd | vusb })

All devices that are presented to the VM Guest start with the element device

console

(console { location | protocol | uuid })

Defines the console that can be accessed with xm console id.

location

Defines the connection information for the console of the given VM Guest. A vfb device will look like:

(location 'localhost:5901')

protocol

The interface to use for the console protocol. This may be one of these:

vt100

Standard vt100 terminal.

rfb

Remote Frame Buffer protocol (for VNC).

rdp

Remote Desktop protocol.

uuid

Unique identifier for this device. Example:

(uuid 7892de3d-2713-a48f-c3ba-54a7574e283b)

pci

(pci { dev | uuid })

Defines the device of a PCI device that is dedicated to the given VM Guest. The PCI device number is organized as [[[[domain]:]bus]:][slot][.[func]].

dev

(dev { bus | domain | func | slot | uuid | vslt })

Defines the path to the PCI device that is dedicated to the given VM Guest.

bus

A PCI device with device number 03:02.1 has the bus number 0x03

(bus 0x03)
domain

Most computers have only one PCI domain. This is then 0x0. To check the domain numbers of the PCI devices, use lspci -D.

(domain 0x0)
func

A PCI device with device number 03:02.1 has the function number

(func 0x1)
slot

A PCI device with device number 03:02.1 has the function number

(slot 0x02)
uuid

Unique identifier for this device. Example:

(uuid d33733fe-e36f-fa42-75d0-fe8c8bc3b4b7)
vslt

Defines the virtual slot for the PCI device in the VM Guest system.

(vslt 0x0)

uuid

Unique identifier for this device. Example:

(uuid 9bef35d3-17c6-ac75-ac28-1aecb1cb509d)

vbd

(vbd { backend | bootable | dev | mode | protocol | uname | uuid | VDI })

Defines a virtual block device.

backend

All paravirtualized virtual devices are implemented by a split device driver. This expression defines the domain that holds the back-end device that the front-end device of the current VM Guest should connect to. Example:

(backend 0)

bootable

Defines if this block device is bootable. Example:

(bootable 1)

dev

Defines the device name of the virtual block device in the VM Guest. Example:

(dev xvda:disk)

mode

Defines if the device is writable. Example:

(mode w)

protocol

Defines the I/O protocol to use for the VM Guest. Example:

(protocol x86_64-abi)

uname

Defines where the virtual block device really stores its data. See also Section 7.1, “Mapping Physical Storage to Virtual Disks”. Example:

(uname file:/var/lib/xen/images/sles11/disk1)

uuid

Unique identifier for the current virtual block device. Example:

(uuid 7892de3d-2713-a48f-c3ba-54a7574e283b)

VDI

Defines if the current virtual block device is a virtual disk image (VDI). This is a read-only setting. Example:

(VDI)

vfb

(vfb { keymap | location | type | uuid | vncunused | xauthority })

The Virtual Frame Buffer (VFB) defines a graphical interface and input device to the VM Guest.

keymap

Defines the language to use for the input. Example:

(keymap en)

location

Defines where to access the virtual frame buffer device when using VNC. By default, the server will listen to localhost and port number 5900+N where N is the ID of the VM Guest. Example:

(location localhost:5900)

type

Defines whether to use VNC or SDL. VNC will only provide a server that has to be connected from a client. SDL provides a display that is started on creation of the VM Guest. Example:

(type vnc)

uuid

Unique identifier for the current virtual frame buffer device. Example:

(uuid 39eb88bb-9ce6-d329-73fd-811681e6b536)

vncunused

If not set to 0, this option enables the VNC server on the first unused port above 5900.

(vncunused 1)

xauthority

When using SDL, the specified file is used to define access rights. If not set, the value from the XAUTHORITY environment variable is used. Example:

(xauthority /root/.Xauthority)

vif

(vif { backend | bridge | mac | model | script | uuid })

The virtual interface definition is used to create and set up virtual network devices. To list, add, or remove network interfaces during runtime, you can use xm with the commands network-list, network-attach, and network-detach.

backend

Defines the back-end domain that is used for paravirtualized network interfaces. Example:

(backend 0)

bridge

Defines the bridge where the virtual network interface should connect to. Example:

(bridge br0)

mac

Defines the mac address of the virtual network interface. The mac addresses reserved for Xen virtual network interfaces look like 00:16:3E:xx:xx:xx. Example:

(mac 00:16:3e:32:e7:81)

model

When using emulated IO, this defines the network interface that should be presented to the VM Guest. See also Section 6.2, “Network Devices for Guest Systems”. Example:

(model rtl8139)

script

Defines the script to use to bring the network interface up or down. Example:

(script /etc/xen/scripts/vif-bridge)

uuid

Unique identifier for the current virtual network device. Example:

(uuid cc0d3351-6206-0f7c-d95f-3cecffec793f)

vkbd

(vkbd { backend })

Defines a virtual keyboard and mouse device. This is needed for paravirtualized VM Guest systems and must be defined before vfb devices.

backend

Defines the backend domain that is used for paravirtualized keyboard interfaces. Example:

(backend 0)

vusb

(vusb { backend | num-ports | usb-ver | port-? })

Defines a virtual USB controller for the VM Guest. This is needed before any USB device can be assigned to the guest.

backend

Defines the back-end domain that is used for USB devices. Example:

(backend 0)

num-ports

Defines the number of ports that the virtual USB host controller provides for the VM Guest. Example:

(num-ports 8)

usb-ver

Define which USB revision should be used. Note, that unlike the real USB revision numbers, this is only an integer. Example:

(usb-ver 2)

port-?

Starting with port-1, depending on num-ports there are several port-? sections available. If a USB device is assigned to the VM Guest, the respective device number is added to the port number. Example:

(port-1 4-2)

image

(image { linux | HVM })

This is the container for the main machine configuration. The actual image type is either Linux or HVM for fully virtualized guests. HVM is only available if your computer supports VMX and also activates this feature during boot.

linux

(linux { args | device_model | kernel | notes })

The linux image definition is used for paravirtualized Linux installations.

args

When booting a kernel from the image definition, args defines extra boot parameters for the kernel. Example:

(args ' sax2=1')

device_model

The device model used by the VM Guest. This defaults to qemu-dm. Example:

(device_model /usr/lib/xen/bin/qemu-dm)

kernel

Defines the path to the kernel image this VM Guest should boot. Defaults to no image. Example:

(kernel /boot/vmlinuz)

notes

Displays several settings and features available to the current VM Guest.

hvm

(hvm { acpi | apic | boot | device_model | extid | guest_os_type | hap | hpet | isa | kernel | keymap | loader | localtime | monitor | nographic | notes | pae | pci | rtc_timeoffset | serial | stdvga | timer_mode | usb | usbdevice | vnc | vncunused | xauthority })

The HVM image definition is used for all fully virtualized installations.

acpi

Defines if ACPI (Advanced Configuration and Power Interface) functionality should be available to the VM Guest. Example:

(acpi 1)

apic

Defines if ACPI (Advanced Programmable Interrupt Controller) functionality should be available to the VM Guest. Example:

(apic 1)

boot

Defines the drive letter to boot from. Example:

(boot c)

device_model

The device model used by the VM Guest. This defaults to qemu-dm. Example:

(device_model /usr/lib/xen/bin/qemu-dm)

extid

Defines whether a guest should use Hyper-V extensions. Only applies to guests types that support Hyper-V. Example:

(extid 1)

guest_os_type

Defines the guest operating system type. Allowed values are default, linux, and windows. Currently, this has only an effect on Itanium systems. Example:

(guest_os_type default)

hap

Defines if hardware assisted paging should be enabled. Enabled with value 1, disabled with value 0. Example:

(hap 1)

hpet

Defines if the emulated multimedia timer hpet should be activated. Enabled with value 1, disabled with value 0. Example:

(hpet 0)

isa

Defines if an ISA-only system should be emulated. Example:

(isa 0)

kernel

Defines the path to the kernel image this VM Guest should boot. Defaults to no image. Example:

(kernel )

keymap

Defines the language to use for the input. Example:

(keymap de)

loader

Defines the path to the HVM boot loader. Example:

(loader /usr/lib/xen/boot/hvmloader)

localtime

Defines if the emulated RTC uses the local time. Example:

(localtime 1)

monitor

Defines if the device model (for example, qemu-dm) should use monitor. Use CtrlAlt2 in the VNC viewer to connect to the monitor. Example:

(monitor 0)

nographic

Defines if the device model should disable the graphics support. Example:

(nographic 0)

notes

Displays several settings and features available to the current VM Guest. Example:

(notes (SUSPEND_CANCEL 1))

pae

Enable or disable PAE (Physical Address Extension) of the HVM VM Guest. Example:

(pae 1)

pci

(pci Bus:Slot.Function

Add a given PCI device to a VM Guest. This must be supported by the hardware and can be added multiple times. Example:

(pci 03:02.1)

rtc_timeoffset

Defines the offset between local time and hardware clock. Example:

(rtc_timeoffset 3600)

serial

Defines Domain0 serial device that will be connected to the hvm VM Guest. To connect /dev/ttyS0 of Domain0 to the HVM VM Guest, use:

(serial /dev/ttyS0)

stdvga

Defines if a standard vga (cirrus logic) device should be used. Example:

(stdvga 0)

timer_mode

Defines if the timer should be delayed when ticks are missed or if the real time should always be used. 0 delays the virtual time, 1 always uses the real time.

(timer_mode 0)

usb

Defines if USB devices should be emulated. Example:

(usb 1)

usbdevice

Adds the specified USB device to the VM Guest.

(usbdevice tablet)

vnc

Defines if VNC should be enabled for graphics. Example:

(vnc 1)

vncunused

If not set to 0, this option enables the VNC server on the first unused port above 5900.

(vncunused 1)

xauthority

When using SDL, the specified file is used to define access rights. If not set, the value from the XAUTHORITY environment variable is used. Example:

(xauthority /root/.Xauthority)

maxmem

Defines how much memory in MB can be assigned to the VM Guest while running. Example:

(maxmem 1024)

memory

Defines the initial amount of memory in MB of the VM Guest. Example:

(memory 512)

name

The name of the VM Guest as it appears in different managing utilities. Example:

(name sles11)

online_vcpus

Number of CPUs that are currently available to the VM Guest. Example:

(online_vcpus 2)

on_crash

(on_crash { coredump-destroy | coredump-restart | destroy | preserve | rename-restart | restart })

Defines the behavior after a domain exits because of a crash.

coredump-destroy

Dumps the core of the VM Guest before destroying it. Example:

(on_crash coredump-destroy)

coredump-restart

Dumps the core of the VM Guest before restarting it. Example:

(on_crash coredump-restart)

destroy

The VM Guest is cleaned up. Example:

(on_crash destroy)

preserve

In order to clean up a VM Guest with preserve status, it has to be destroyed manually. Example:

(on_crash preserve)

rename-restart

The old VM Guest is renamed and a new domain is started with the old name. Example:

(on_crash rename-restart)

restart

The old VM Guest is not cleaned up. Instead, a new VM Guest is started. Example:

(on_crash restart)

on_poweroff

(on_poweroff { destroy | preserve | rename-restart | rename })

Defines the behavior after a domain exits because of a restart. For details about the available parameters, see the section called “on_crash.

on_reboot

(on_reboot { destroy | preserve | rename-restart | rename })

Defines the behavior after a domain exits because of a reboot. For details about the available parameters, see the section called “on_crash.

on_xend_start

(on_xend_start { destroy | preserve | rename-restart | rename | start })

Defines the behavior when Xend starts. For details about the available parameters, see the section called “on_crash.

on_xend_stop

(on_xen_stop { destroy | preserve | rename-restart | rename | shutdown })

Defines the behavior when Xend stops. For details about the available parameters, see the section called “on_crash.

shadow_memory

Define how much shadow pagetable memory in MB is available for the VM Guest. This is needed for fully virtualized VM Guest systems. Example:

(shadow_memory 10)

start_time

Time in seconds when the VM Guest was started. Example:

(start_time 1236325777.38)

status

Lists the current state of the VM Guest.

0

The VM Guest is stopped.

1

The VM Guest is suspended.

2

The VM Guest is running.

Example:

(status 0)

store_mfn

Number of shared pages for the current VM Guest. Example:

(store_mfn 262141)

uuid

Unique identifier for this VM Guest. Example:

(uuid 7892de3d-2713-a48f-c3ba-54a7574e283b)

vcpus

Number of virtually available CPUs in the current VM Guest. Example:

(vcpus 2)
Print this page