admin scripts
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

244 lines
13 KiB

  1. Values:
  2. vncpasswd=NAME Password for VNC console on HVM domain.
  3. vncviewer=no|yes Spawn a vncviewer listening for a vnc server in the
  4. domain.
  5. The address of the vncviewer is passed to the domain
  6. on the kernel command line using
  7. 'VNC_SERVER=<host>:<port>'. The port used by vnc is
  8. 5500 + DISPLAY. A display value with a free port is
  9. chosen if possible.
  10. Only valid when vnc=1.
  11. vncconsole=no|yes Spawn a vncviewer process for the domain's graphical
  12. console.
  13. Only valid when vnc=1.
  14. name=NAME Domain name. Must be unique.
  15. bootloader=FILE Path to bootloader.
  16. bootargs=NAME Arguments to pass to boot loader
  17. bootentry=NAME DEPRECATED. Entry to boot via boot loader. Use
  18. bootargs.
  19. kernel=FILE Path to kernel image.
  20. ramdisk=FILE Path to ramdisk.
  21. features=FEATURES Features to enable in guest kernel
  22. builder=FUNCTION Function to use to build the domain.
  23. memory=MEMORY Domain memory in MB.
  24. maxmem=MEMORY Maximum domain memory in MB.
  25. shadow_memory=MEMORY Domain shadow memory in MB.
  26. cpu=CPU CPU to run the VCPU0 on.
  27. cpus=CPUS CPUS to run the domain on.
  28. rtc_timeoffset=RTC_TIMEOFFSET
  29. Set RTC offset.
  30. pae=PAE Disable or enable PAE of HVM domain.
  31. timer_mode=TIMER_MODE
  32. Timer mode (0=delay virtual time when ticks are
  33. missed;
  34. 1=virtual time is always wallclock time.
  35. acpi=ACPI Disable or enable ACPI of HVM domain.
  36. apic=APIC Disable or enable APIC mode.
  37. vcpus=VCPUS # of Virtual CPUS in domain.
  38. vcpu_avail=VCPUS Bitmask for virtual CPUs to make available
  39. immediately.
  40. vhpt=VHPT Log2 of domain VHPT size for IA64.
  41. cpu_cap=CAP Set the maximum amount of cpu.
  42. CAP is a percentage that fixes the maximum amount of
  43. cpu.
  44. cpu_weight=WEIGHT Set the cpu time ratio to be allocated to the domain.
  45. restart=onreboot|always|never
  46. Deprecated. Use on_poweroff, on_reboot, and on_crash
  47. instead.
  48. Whether the domain should be restarted on exit.
  49. - onreboot: restart on exit with shutdown code reboot
  50. - always: always restart on exit, ignore exit code
  51. - never: never restart on exit, ignore exit code
  52. on_poweroff=destroy|restart|preserve|rename-restart
  53. Behaviour when a domain exits with reason 'poweroff'.
  54. - destroy: the domain is cleaned up as normal;
  55. - restart: a new domain is started in place of the
  56. old one;
  57. - preserve: no clean-up is done until the domain is
  58. manually
  59. destroyed (using xm destroy, for example);
  60. - rename-restart: the old domain is not cleaned up,
  61. but is
  62. renamed and a new domain started in its place.
  63. on_reboot=destroy|restart|preserve|rename-restart
  64. Behaviour when a domain exits with reason 'reboot'.
  65. - destroy: the domain is cleaned up as normal;
  66. - restart: a new domain is started in place of the
  67. old one;
  68. - preserve: no clean-up is done until the domain is
  69. manually
  70. destroyed (using xm destroy, for example);
  71. - rename-restart: the old domain is not cleaned up,
  72. but is
  73. renamed and a new domain started in its place.
  74. on_crash=destroy|restart|preserve|rename-restart
  75. Behaviour when a domain exits with reason 'crash'.
  76. - destroy: the domain is cleaned up as normal;
  77. - restart: a new domain is started in place of the
  78. old one;
  79. - preserve: no clean-up is done until the domain is
  80. manually
  81. destroyed (using xm destroy, for example);
  82. - rename-restart: the old domain is not cleaned up,
  83. but is
  84. renamed and a new domain started in its place.
  85. blkif=no|yes Make the domain a block device backend.
  86. netif=no|yes Make the domain a network interface backend.
  87. tpmif=no|yes Make the domain a TPM interface backend.
  88. disk=phy:DEV,VDEV,MODE[,DOM]
  89. Add a disk device to a domain. The physical device is
  90. DEV,
  91. which is exported to the domain as VDEV. The disk is
  92. read-only if MODE
  93. is 'r', read-write if MODE is 'w'. If DOM is
  94. specified it defines the
  95. backend driver domain to use for the disk.
  96. The option may be repeated to add more than one disk.
  97. pci=BUS:DEV.FUNC Add a PCI device to a domain, using given params (in
  98. hex).
  99. For example 'pci=c0:02.1a'.
  100. The option may be repeated to add more than one pci
  101. device.
  102. ioports=FROM[-TO] Add a legacy I/O range to a domain, using given
  103. params (in hex).
  104. For example 'ioports=02f8-02ff'.
  105. The option may be repeated to add more than one i/o
  106. range.
  107. irq=IRQ Add an IRQ (interrupt line) to a domain.
  108. For example 'irq=7'.
  109. This option may be repeated to add more than one IRQ.
  110. vfb=type={vnc,sdl},vncunused=1,vncdisplay=N,vnclisten=ADDR,display=DISPLAY,xauthority=XAUTHORITY,vncpasswd=PASSWORD
  111. Make the domain a framebuffer backend.
  112. The backend type should be either sdl or vnc.
  113. For type=vnc, connect an external vncviewer. The
  114. server will listen
  115. on ADDR (default 127.0.0.1) on port N+5900. N
  116. defaults to the
  117. domain id. If vncunused=1, the server will try to
  118. find an arbitrary
  119. unused port above 5900. vncpasswd overrides the XenD
  120. configured
  121. default password.
  122. For type=sdl, a viewer will be started automatically
  123. using the
  124. given DISPLAY and XAUTHORITY, which default to the
  125. current user's
  126. ones.
  127. vif=type=TYPE,mac=MAC,bridge=BRIDGE,ip=IPADDR,script=SCRIPT,backend=DOM,vifname=NAME,rate=RATE,model=MODEL,accel=ACCEL
  128. Add a network interface with the given MAC address
  129. and bridge.
  130. The vif is configured by calling the given
  131. configuration script.
  132. If type is not specified, default is netfront.
  133. If mac is not specified a random MAC address is used.
  134. If not specified then the network backend chooses
  135. it's own MAC address.
  136. If bridge is not specified the first bridge found is
  137. used.
  138. If script is not specified the default script is
  139. used.
  140. If backend is not specified the default backend
  141. driver domain is used.
  142. If vifname is not specified the backend virtual
  143. interface will have name vifD.N
  144. where D is the domain id and N is the interface id.
  145. If rate is not specified the default rate is used.
  146. If model is not specified the default model is used.
  147. If accel is not specified an accelerator plugin
  148. module is not used.
  149. This option may be repeated to add more than one vif.
  150. Specifying vifs will increase the number of
  151. interfaces as needed.
  152. vtpm=instance=INSTANCE,backend=DOM,type=TYPE
  153. Add a TPM interface. On the backend side use the
  154. given
  155. instance as virtual TPM instance. The given number is
  156. merely the
  157. preferred instance number. The hotplug script will
  158. determine
  159. which instance number will actually be assigned to
  160. the domain.
  161. The associtation between virtual machine and the TPM
  162. instance
  163. number can be found in /etc/xen/vtpm.db. Use the
  164. backend in the
  165. given domain.
  166. The type parameter can be used to select a specific
  167. driver type
  168. that the VM can use. To prevent a fully virtualized
  169. domain (HVM)
  170. from being able to access an emulated device model,
  171. you may specify
  172. 'paravirtualized' here.
  173. access_control=policy=POLICY,label=LABEL
  174. Add a security label and the security policy
  175. reference that defines it.
  176. The local ssid reference is calculated when
  177. starting/resuming the domain. At
  178. this time, the policy is checked against the active
  179. policy as well. This way,
  180. migrating through save/restore is covered and local
  181. labels are automatically
  182. created correctly on the system where a domain is
  183. started / resumed.
  184. nics=NUM DEPRECATED. Use empty vif entries instead.
  185. Set the number of network interfaces.
  186. Use the vif option to define interface parameters,
  187. otherwise
  188. defaults are used. Specifying vifs will increase the
  189. number of interfaces as needed.
  190. root=DEVICE Set the root= parameter on the kernel command line.
  191. Use a device, e.g. /dev/sda1, or /dev/nfs for NFS
  192. root.
  193. extra=ARGS Set extra arguments to append to the kernel command
  194. line.
  195. ip=IPADDR Set the kernel IP interface address.
  196. gateway=IPADDR Set the kernel IP gateway.
  197. netmask=MASK Set the kernel IP netmask.
  198. hostname=NAME Set the kernel IP hostname.
  199. interface=INTF Set the kernel IP interface name.
  200. dhcp=off|dhcp Set the kernel dhcp option.
  201. nfs_server=IPADDR Set the address of the NFS server for NFS root.
  202. nfs_root=PATH Set the path of the root NFS directory.
  203. device_model=FILE Path to device model program.
  204. fda=FILE Path to fda
  205. fdb=FILE Path to fdb
  206. serial=FILE Path to serial or pty or vc
  207. monitor=no|yes Should the device model use monitor?
  208. localtime=no|yes Is RTC set to localtime?
  209. keymap=FILE Set keyboard layout used
  210. usb=no|yes Emulate USB devices?
  211. usbdevice=NAME Name of USB device to add?
  212. guest_os_type=NAME Guest OS type running in HVM
  213. stdvga=no|yes Use std vga or cirrhus logic graphics
  214. isa=no|yes Simulate an ISA only system?
  215. boot=a|b|c|d Default boot device
  216. nographic=no|yes Should device models use graphics?
  217. soundhw=audiodev Should device models enable audio device?
  218. vnc Should the device model use VNC?
  219. vncdisplay VNC display to use
  220. vnclisten Address for VNC server to listen on.
  221. vncunused Try to find an unused port for the VNC server.
  222. Only valid when vnc=1.
  223. sdl Should the device model use SDL?
  224. display=DISPLAY X11 display to use
  225. xauthority=XAUTHORITY
  226. X11 Authority to use
  227. uuid xenstore UUID (universally unique identifier) to use.
  228. One
  229. will be randomly generated if this option is not set,
  230. just like MAC
  231. addresses for virtual network interfaces. This must
  232. be a unique
  233. value across the entire cluster.
  234. on_xend_start=ignore|start
  235. Action to perform when xend starts
  236. on_xend_stop=ignore|shutdown|suspend
  237. Behaviour when Xend stops:
  238. - ignore: Domain continues to run;
  239. - shutdown: Domain is shutdown;
  240. - suspend: Domain is suspended;