]> xenbits.xensource.com Git - xenclient/toolstack.git/commitdiff
update readme to have possible config parameters listed in nice tables.
authorVincent Hanquez <vincent.hanquez@eu.citrix.com>
Tue, 11 Aug 2009 12:42:01 +0000 (13:42 +0100)
committerVincent Hanquez <vincent.hanquez@eu.citrix.com>
Tue, 11 Aug 2009 12:45:29 +0000 (13:45 +0100)
xenvm/xenvm.readme

index f25e687d4ce039b59fc0bf36164ca3001eefc3dd..942a82f2696a2a8cc0aacfe7fe4399c073b7349f 100644 (file)
@@ -13,78 +13,117 @@ cycle.
 you can put the following parameters in your config file:
 
 (common options)
-hvm = true|false -- specify if it's an hvm guest
-paused = true|false -- specify if the domain start paused
-startup = started|paused|shutdown|restore <file> -- specify what to do with the domain at startup of xenvm, supersed the previous option
-debug = true|false -- logs all operations to /tmp/xenvm-debug-%uuid
-uuid = uuidstring -- specify the domain uuid (default to autogenerating one)
-on_crash = preserve|reboot|destroy -- specify the action to be taken after notifying a crash
-on_halt = preserve|reboot|destroy -- specify the action to be taken after notifying a halt
-on_reboot = preserve|reboot|destroy -- specify the action to be taken after notifying a reboot
-kernel = string -- specify where to find the kernel to boot
-                   you can leave that empty for hvm, it will default
-                  to hvmloader
-memory = int -- specify the memory given to the guest in megabytes
-vcpus = int -- number of vcpus available to the guest
-
-disk = physpath:phystype:virtpath:mode:devtype
-       -> physpath = path to the physical device (/dev/vg/test)
-       -> phystype = phy | qcow | aio | file | vhd
-       -> virtpath = hd(a-d) | sd(a-.) | xvd(a-p)
-       -> mode = r | w
-       -> devtype = cdrom | disk
-
-nic = comma,separated,key,value,pair
-
-       key supported : bridge and mac
-       leaving empty configuration string after the first equal will
-       create default values.
-
-       example:
-               "nic = bridge=xen-br0,mac=ab:de:fe:dc:ba:ab"
-               "nic = mac=ab:de:fe:dc:ba:ab"
-               "nic = "
-vif = synonym to previous option
-pci = devid,domain:bus:device.function -- specify a pci device
-
-serial = dev -- redirect serial to device or network tcp:ip:port
-       example:
-               "serial = pty"
-               "serial = tcp:1.2.3.4:1234"
++====================+======+=======================================================+
+| key name           | type | description                                           |
++====================+======+=======================================================+
+| hvm                | s    | command line given to the kernel                      |
++--------------------+------+-------------------------------------------------------+
+| startup            | s    | specify what to do with the domain at startup         |
+|                    |      | possibles value: started, paused, shutdown or         |
+|                    |      | restore <file>                                        |
++--------------------+------+-------------------------------------------------------+
+| debug              | b    | logs all operations to /tmp/xenvm-debug-%uuid         |
++--------------------+------+-------------------------------------------------------+
+| uuid               | s    | specify the domain uuid (default to autogeneration)   |
++--------------------+------+-------------------------------------------------------+
+| on_crash           | s    | specify the action to be taken after notifying a      |
+| on_halt            | s    | crash/halt/reboot. possible values:                   |
+| on_reboot          | s    | preserve, reboot, destroy                             |
++--------------------+------+-------------------------------------------------------+
+| kernel             | s    | specify where to find the kernel to boot              |
+|                    |      | (can be empty for hvm. default to hvmloader)          |
++--------------------+------+-------------------------------------------------------+
+| memory             | i    | specify the memory given to the guest in megabytes    |
++--------------------+------+-------------------------------------------------------+
+| vcpus              | i    | number of vcpus available to the guest                |
++--------------------+------+-------------------------------------------------------+
+| disk               | s    | add a virtual disk.                                   |
+|                    |      | format: physpath:phystype:virtpath:mode:devtype       |
+|                    |      | - physpath: path to the disk image, raw device, ..    |
+|                    |      | - phystype:  phy | qcow | aio | file | vhd            |
+|                    |      | - virtpath: hd(a-d) | sd(a-.) | xvd(a-p)              |
+|                    |      | - mode: r | w                                         |
+|                    |      | - devtype = cdrom | disk                              |
++--------------------+------+-------------------------------------------------------+
+| nic                | s    | add a virtual nic.                                    |
+|                    |      | format: key=value,key=value,... (can be empty)        |
+|                    |      | supported key: bridge, mac, id                        |
+|                    |      | examples:                                             |
+|                    |      | "nic = bridge=xen-br0,mac=ab:de:fe:dc:ba:ab"          |
+|                    |      | "nic = mac=ab:de:fe:dc:ba:ab"                         |
+|                    |      | "nic = "                                              |
++--------------------+------+-------------------------------------------------------+
+| pci                | s    | add a pci device.                                     |
+|                    |      | format: devid,bind,domain:bus:device.function         |
+|                    |      |                                                       |
++--------------------+------+-------------------------------------------------------+
+| serial             | s    | redirect serial to device or network tcp:ip:port      |
+|                    |      | ex: "pty" or "tcp:1.2.3.4:1234"                       |
++--------------------+------+-------------------------------------------------------+
 
 
 (the following are just useful for pv)
-cmdline = string -- command line given to the kernel
-initrd = string -- specify the initrd use, leave empty for none
++====================+======+=======================================================+
+| key name           | type | description                                           |
++====================+======+=======================================================+
+| cmdline            | s    | command line given to the kernel                      |
++--------------------+------+-------------------------------------------------------+
+| initrd             | s    | specify the initrd use, leave empty for none          |
++--------------------+------+-------------------------------------------------------+
+
 
 (the following are just useful for hvm)
-pae = true|false -- specify the guest is using pae
-acpi = true|false -- specify the guest is using acpi
-apic = true|false -- specify the guest is using apic
-nx = true|false -- specify the guest is using nx
-smbios-pt = true|false -- specify the guest is using smbios pass-through
-smbios-oem-types-pt = comma seperated oem type numbers -- specify the smbios oem type numbers to pass-through
-acpi-pt = true|false -- specify the guest is using acpi pass-through
-diskinfo-pt = true|false -- specify the guest is using SCSI disk info pass-through
-
-boot = string -- specify the qemu boot string
-vnc = int -- specify the vnc port to use
-vnc_keymap = string -- specify the vnc keymap to use
-extra-hvm = string1=string2 -- specify extra arguments passthrough to qemu as -string1 string2
-power-management = int -- specify the power management passthrough mode
-                          Value of 1 implies pass-through mode (limited scope)
-                          Value of 2 implies non pass-through mode (when in doubt use this)
-oem-features = int -- specify whether or not to pass through oem features.  Note:  At the moment
-                      any integer value can be passed but this is likely to change in future 
-                      especially if we decide to pass through a subset of oem features and let
-                      user configure that subset.
-timer-mode = int -- specify the timer mode used.
-timeoffset = string -- specify the time offset (i.e. timezone) used.
-pci-msitranslate = int -- specify whether or not to use MSI-INTx translation for guest.
-pci-power-management = int -- specify whether or not to enable Dx power management for 
-                              passthrough devices.
-inject-sci = int -- specify whether or not to inject SCIs like lid close, power button press to guest.
-                    Default is to not inject SCIs.
+
++====================+======+=======================================================+
+| key name           | type | description                                           |
++====================+======+=======================================================+
+| pae                | b    | specify that the guest is using PAE                   |
++--------------------+------+-------------------------------------------------------+
+| acpi               | b    | specify that the guest is using ACPI                  |
++--------------------+------+-------------------------------------------------------+
+| apic               | b    | specify that the guest is using APIC                  |
++--------------------+------+-------------------------------------------------------+
+| nx                 | b    | specify that the guest is using NX                    |
++--------------------+------+-------------------------------------------------------+
+| smbios-pt          | b    | specify that the guest is using smbios pass-through   |
++--------------------+------+-------------------------------------------------------+
+| smbios-oem-type-pt | i,   | tables number to passthrough                          |
++--------------------+------+-------------------------------------------------------+
+| acpi-pt            | b    | specify that the guest is using ACPI pass-through     |
++--------------------+------+-------------------------------------------------------+
+| diskinfo-pt        | b    | specify the guest is using SCSI diskinfo pass-through |
++--------------------+------+-------------------------------------------------------+
+| boot               | s    | specify the qemu boot string                          |
++--------------------+------+-------------------------------------------------------+
+| vnc                | i    | specify the vnc port to use                           |
++--------------------+------+-------------------------------------------------------+
+| vnc_keymap         | s    | specify the vnc keymap to use                         |
++--------------------+------+-------------------------------------------------------+
+| extra-hvm          | k=v, | specify extra arguments passthrough to qemu as -k v   |
++--------------------+------+-------------------------------------------------------+
+| power-management   | i    | specify the power management passthrough mode         |
+|                    |      | - 1 : pass-through mode (limited scope)               |
+|                    |      | - 2 : non pass-through mode (in doubt use this)       |
++--------------------+------+-------------------------------------------------------+
+| oem-features       | i    | specify whether or not to pass through oem features.  |
+|                    |      | Note: At the moment any integer value can be passed   |
+|                    |      | but this is likely to change in future especially if  |
+|                    |      | we decide to pass through a subset of oem features    |
+|                    |      | and let user configure that subset.                   |
++--------------------+------+-------------------------------------------------------+
+| timer-mode         | i    | specify the timer mode used.                          |
++--------------------+------+-------------------------------------------------------+
+| timeoffset         | s    | specify the time offset (i.e. timezone) used.         |
++--------------------+------+-------------------------------------------------------+
+| pci-msitranslate   | i    | specify whether to use MSI-INTx translation for guest.|
++--------------------+------+-------------------------------------------------------+
+|pci-power-management| i    | specify whether or not to enable Dx power management  |
+|                    |      | for passthrough devices.                              |
++--------------------+------+-------------------------------------------------------+
+| inject-sci         | i    | specify whether or not to inject SCIs like lid close, |
+|                    |      | power button press to guest. (Default: no injection)  |
++--------------------+------+-------------------------------------------------------+
+
 
 = Sending command to the monitor