update auto-generated options
authorDietmar Maurer <dietmar@proxmox.com>
Fri, 15 Apr 2016 14:49:00 +0000 (16:49 +0200)
committerDietmar Maurer <dietmar@proxmox.com>
Fri, 15 Apr 2016 14:49:00 +0000 (16:49 +0200)
datacenter.cfg.5-opts.adoc
pveceph.1-synopsis.adoc
pvesm.1-synopsis.adoc
qm.1-synopsis.adoc
qm.conf.5-opts.adoc
vm.conf.5-opts.adoc [deleted file]
vzdump.1-synopsis.adoc
vzdump.conf.5-opts.adoc

index 4cc4073..4e3ae5c 100644 (file)
@@ -12,7 +12,9 @@ Specify email address to send notification from (default is root@$hostname)
 
 Set the fencing mode of the HA cluster. Hardware mode needs a valid
 configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two
-modes are used.  NOTE: 'hardware' and 'both' are EXPERIMENTAL & WIP
+modes are used.
++
+WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP
 
 `http_proxy`: `http://.*` ::
 
index 7bc02a8..3579c6f 100644 (file)
@@ -115,7 +115,9 @@ Use specific network for all ceph related traffic
 `-pg_bits` `integer (6 - 14)` (default=`6`)::
 
 Placement group bits, used to specify the default number of placement
-groups (Note: 'osd pool default pg num' does not work for deafult pools)
+groups.
++
+NOTE: 'osd pool default pg num' does not work for default pools.
 
 `-size` `integer (1 - 3)` (default=`2`)::
 
index 0899a5d..f4b17cc 100644 (file)
@@ -34,8 +34,10 @@ target group for comstar views
 
 `-content` `string` ::
 
-Allowed content types. Note: value 'rootdir' is used for Containers, and
-value 'images' for KVM-Qemu VM's.
+Allowed content types.
++
+NOTE: the value 'rootdir' is used for Containers, and value 'images' for
+VMs.
 
 `-disable` `boolean` ::
 
@@ -47,7 +49,7 @@ NFS export path.
 
 `-format` `string` ::
 
-Default Image format.
+Default image format.
 
 `-iscsiprovider` `string` ::
 
@@ -318,8 +320,10 @@ target group for comstar views
 
 `-content` `string` ::
 
-Allowed content types. Note: value 'rootdir' is used for Containers, and
-value 'images' for KVM-Qemu VM's.
+Allowed content types.
++
+NOTE: the value 'rootdir' is used for Containers, and value 'images' for
+VMs.
 
 `-delete` `string` ::
 
@@ -336,7 +340,7 @@ Flag to disable the storage.
 
 `-format` `string` ::
 
-Default Image format.
+Default image format.
 
 `-krbd` `boolean` ::
 
index 45c2206..8995cb4 100644 (file)
@@ -88,10 +88,11 @@ The backup file.
 
 `-args` `string` ::
 
-NOTE: this option is for experts only. It allows you to pass arbitrary
-arguments to kvm, for example:
+Arbitrary arguments passed to kvm, for example:
 +
 args: -no-reboot -no-hpet
++
+NOTE: this option is for experts only.
 
 `-autostart` `boolean` (default=`0`)::
 
@@ -698,10 +699,11 @@ Enable/disable Qemu GuestAgent.
 
 `-args` `string` ::
 
-NOTE: this option is for experts only. It allows you to pass arbitrary
-arguments to kvm, for example:
+Arbitrary arguments passed to kvm, for example:
 +
 args: -no-reboot -no-hpet
++
+NOTE: this option is for experts only.
 
 `-autostart` `boolean` (default=`0`)::
 
index e4440a7..58ab887 100644 (file)
@@ -8,10 +8,11 @@ Enable/disable Qemu GuestAgent.
 
 `args`: `string` ::
 
-NOTE: this option is for experts only. It allows you to pass arbitrary
-arguments to kvm, for example:
+Arbitrary arguments passed to kvm, for example:
 +
 args: -no-reboot -no-hpet
++
+NOTE: this option is for experts only.
 
 `autostart`: `boolean` (default=`0`)::
 
diff --git a/vm.conf.5-opts.adoc b/vm.conf.5-opts.adoc
deleted file mode 100644 (file)
index e4440a7..0000000
+++ /dev/null
@@ -1,330 +0,0 @@
-`acpi`: `boolean` (default=`1`)::
-
-Enable/disable ACPI.
-
-`agent`: `boolean` (default=`0`)::
-
-Enable/disable Qemu GuestAgent.
-
-`args`: `string` ::
-
-NOTE: this option is for experts only. It allows you to pass arbitrary
-arguments to kvm, for example:
-+
-args: -no-reboot -no-hpet
-
-`autostart`: `boolean` (default=`0`)::
-
-Automatic restart after crash (currently ignored).
-
-`balloon`: `integer (0 - N)` ::
-
-Amount of target RAM for the VM in MB. Using zero disables the ballon
-driver.
-
-`bios`: `(ovmf | seabios)` (default=`seabios`)::
-
-Select BIOS implementation.
-
-`boot`: `[acdn]{1,4}` (default=`cdn`)::
-
-Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
-
-`bootdisk`: `(ide|sata|scsi|virtio)\d+` ::
-
-Enable booting from specified disk.
-
-`cdrom`: `volume` ::
-
-This is an alias for option -ide2
-
-`cores`: `integer (1 - N)` (default=`1`)::
-
-The number of cores per socket.
-
-`cpu`: `[cputype=]<cputype> [,hidden=<1|0>]` ::
-
-Emulated CPU type.
-
-`cpulimit`: `number (0 - 128)` (default=`0`)::
-
-Limit of CPU usage.
-+
-NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0'
-indicates no CPU limit.
-
-`cpuunits`: `integer (0 - 500000)` (default=`1000`)::
-
-CPU weight for a VM. Argument is used in the kernel fair scheduler. The
-larger the number is, the more CPU time this VM gets. Number is relative to
-weights of all the other running VMs.
-+
-NOTE: You can disable fair-scheduler configuration by setting this to 0.
-
-`description`: `string` ::
-
-Description for the VM. Only used on the configuration web interface. This
-is saved as comment inside the configuration file.
-
-`freeze`: `boolean` ::
-
-Freeze CPU at startup (use 'c' monitor command to start execution).
-
-`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` ::
-
-Map host pci devices. HOSTPCIDEVICE syntax is:
-+
-'bus:dev.func' (hexadecimal numbers)
-+
-You can us the 'lspci' command to list existing pci devices.
-+
-The 'rombar' option determines whether or not the device's ROM will be
-visible in the guest's memory map (default is 'on').
-+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.
-
-`hotplug`: `string` (default=`network,disk,usb`)::
-
-Selectively enable hotplug features. This is a comma separated list of
-hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to
-disable hotplug completely. Value '1' is an alias for the default
-'network,disk,usb'.
-
-`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
-
-Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
-
-`keyboard`: `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`)::
-
-Keybord layout for vnc server. Default is read from the datacenter
-configuration file.
-
-`kvm`: `boolean` (default=`1`)::
-
-Enable/disable KVM hardware virtualization.
-
-`localtime`: `boolean` ::
-
-Set the real time clock to local time. This is enabled by default if ostype
-indicates a Microsoft OS.
-
-`lock`: `(backup | migrate | rollback | snapshot)` ::
-
-Lock/unlock the VM.
-
-`machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
-
-Specific the Qemu machine type.
-
-`memory`: `integer (16 - N)` (default=`512`)::
-
-Amount of RAM for the VM in MB. This is the maximum available memory when
-you use the balloon device.
-
-`migrate_downtime`: `number (0 - N)` (default=`0.1`)::
-
-Set maximum tolerated downtime (in seconds) for migrations.
-
-`migrate_speed`: `integer (0 - N)` (default=`0`)::
-
-Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
-
-`name`: `string` ::
-
-Set a name for the VM. Only used on the configuration web interface.
-
-`net[n]`: `string` ::
-
-Specify network devices.
-+
-MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551
-i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3
-+
-XX:XX:XX:XX:XX:XX should be an unique MAC address. This is
-automatically generated if not specified.
-+
-The bridge parameter can be used to automatically add the interface to a
-bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
-+
-Option 'rate' is used to limit traffic bandwidth from and to this
-interface. It is specified as floating point number, unit is 'Megabytes per
-second'.
-+
-If you specify no bridge, we create a kvm 'user' (NATed) network device,
-which provides DHCP and DNS services. The following addresses are used:
-+
-10.0.2.2   Gateway
-10.0.2.3   DNS Server
-10.0.2.4   SMB Server
-+
-The DHCP server assign addresses to the guest starting from 10.0.2.15.
-
-`numa`: `boolean` (default=`0`)::
-
-Enable/disable NUMA.
-
-`numa[n]`: `cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<mb>] [,policy=<preferred|bind|interleave>]` ::
-
-numa topology
-
-`onboot`: `boolean` (default=`0`)::
-
-Specifies whether a VM will be started during system bootup.
-
-`ostype`: `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` ::
-
-Used to enable special optimization/features for specific
-operating systems:
-+
-other  => unspecified OS
-wxp    => Microsoft Windows XP
-w2k    => Microsoft Windows 2000
-w2k3   => Microsoft Windows 2003
-w2k8   => Microsoft Windows 2008
-wvista => Microsoft Windows Vista
-win7   => Microsoft Windows 7
-win8   => Microsoft Windows 8/2012
-l24    => Linux 2.4 Kernel
-l26    => Linux 2.6/3.X Kernel
-solaris => solaris/opensolaris/openindiania kernel
-+
-other|l24|l26|solaris                      ... no special behaviour
-wxp|w2k|w2k3|w2k8|wvista|win7|win8  ... use --localtime switch
-
-`parallel[n]`: `/dev/parport\d+|/dev/usb/lp\d+` ::
-
-Map host parallel devices (n is 0 to 2).
-+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.
-
-`protection`: `boolean` (default=`0`)::
-
-Sets the protection flag of the VM. This will prevent the remove operation.
-
-`reboot`: `boolean` (default=`1`)::
-
-Allow reboot. If set to '0' the VM exit on reboot.
-
-`sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
-
-Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
-
-`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<nbqueues>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
-
-Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
-
-`scsihw`: `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
-
-scsi controller model
-
-`serial[n]`: `(/dev/.+|socket)` ::
-
-Create a serial device inside the VM (n is 0 to 3), and pass through a host
-serial device (i.e. /dev/ttyS0), or create a unix socket on the host side
-(use 'qm terminal' to open a terminal connection).
-+
-NOTE: If you pass through a host serial device, it is no longer possible to
-migrate such machines - use with special care.
-+
-Experimental: user reported problems with this option.
-
-`shares`: `integer (0 - 50000)` (default=`1000`)::
-
-Amount of memory shares for auto-ballooning. The larger the number is, the
-more memory this VM gets. Number is relative to weights of all other
-running VMs. Using zero disables auto-ballooning
-
-`smbios[n]`: `[family=<str>] [,manufacturer=<name>] [,product=<name>] [,serial=<str>] [,sku=<str>] [,uuid=<UUID>] [,version=<str>]` ::
-
-Specify SMBIOS type 1 fields.
-
-`smp`: `integer (1 - N)` (default=`1`)::
-
-The number of CPUs. Please use option -sockets instead.
-
-`sockets`: `integer (1 - N)` (default=`1`)::
-
-The number of CPU sockets.
-
-`startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
-
-Set the initial date of the real time clock. Valid format for date are:
-'now' or '2006-06-17T16:01:21' or '2006-06-17'.
-
-`startup`: `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-
-Startup and shutdown behavior. Order is a non-negative number defining the
-general startup order. Shutdown in done with reverse ordering. Additionally
-you can set the 'up' or 'down' delay in seconds, which specifies a delay to
-wait before the next VM is started or stopped.
-
-`tablet`: `boolean` (default=`1`)::
-
-Enable/disable the USB tablet device. This device is usually needed to
-allow absolute mouse positioning with VNC. Else the mouse runs out of sync
-with normal VNC clients. If you're running lots of console-only guests on
-one host, you may consider disabling this to save some context switches.
-This is turned off by default if you use spice (-vga=qxl).
-
-`tdf`: `boolean` (default=`0`)::
-
-Enable/disable time drift fix.
-
-`template`: `boolean` (default=`0`)::
-
-Enable/disable Template.
-
-`unused[n]`: `string` ::
-
-Reference to unused volumes.
-
-`usb[n]`: `[host=]<HOSTUSBDEVICE|spice> [,usb3=<yes|no>]` ::
-
-Configure an USB device (n is 0 to 4). This can be used to
-pass-through usb devices to the guest. HOSTUSBDEVICE syntax is:
-+
-'bus-port(.port)*' (decimal numbers) or
-'vendor_id:product_id' (hexadeciaml numbers) or
-'spice'
-+
-You can use the 'lsusb -t' command to list existing usb devices.
-+
-NOTE: This option allows direct access to host hardware. So it is no longer
-possible to migrate such machines - use with special care.
-+
-The value 'spice' can be used to add a usb redirection devices for spice.
-+
-The 'usb3' option determines whether the device is a USB3 device or not
-(this does currently not work reliably with spice redirection and is then
-ignored).
-
-`vcpus`: `integer (1 - N)` (default=`0`)::
-
-Number of hotplugged vcpus.
-
-`vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
-
-Select the VGA type. If you want to use high resolution modes (>=
-1280x1024x16) then you should use the options 'std' or 'vmware'. Default is
-'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option
-enables the SPICE display sever. For win* OS you can select how many
-independent displays you want, Linux guests can add displays them self. You
-can also run without any graphic card, using a serial device as terminal.
-
-`virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<on|off>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<count>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<drive format>] [,heads=<count>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<off|on>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<count>] [,serial=<serial>] [,snapshot=<on|off>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
-
-Use volume as VIRTIO hard disk (n is 0 to 15).
-
-`watchdog`: `[action=<reset|shutdown|poweroff|pause|debug|none>] [,[model=]<i6300esb|ib700>]` ::
-
-Create a virtual hardware watchdog device. Once enabled (by a guest
-action), the watchdog must be periodically polled by an agent inside the
-guest or else the watchdog will reset the guest (or execute the respective
-action specified)
-
index 53e73ea..d492483 100644 (file)
@@ -6,17 +6,17 @@ Create backup.
 
 `<vmid>` `string` ::
 
-The ID of the VM you want to backup.
+The ID of the guest system you want to backup.
 
 `-all` `boolean` (default=`0`)::
 
-Backup all known VMs on this host.
+Backup all known guest systems on this host.
 
 `-bwlimit` `integer (0 - N)` (default=`0`)::
 
 Limit I/O bandwidth (KBytes per second).
 
-`-compress` `(0 | 1 | gzip | lzo)` (default=`lzo`)::
+`-compress` `(0 | 1 | gzip | lzo)` (default=`0`)::
 
 Compress dump file.
 
@@ -26,11 +26,11 @@ Store resulting files to specified directory.
 
 `-exclude` `string` ::
 
-exclude specified VMs (assumes --all)
+Exclude specified guest systems (assumes --all)
 
 `-exclude-path` `string` ::
 
-exclude certain files/directories (shell globs).
+Exclude certain files/directories (shell globs).
 
 `-ionice` `integer (0 - 8)` (default=`7`)::
 
@@ -46,11 +46,12 @@ Specify when to send an email
 
 `-mailto` `string` ::
 
-no description available
+Comma-separated list of email addresses that should receive email
+notifications.
 
 `-maxfiles` `integer (1 - N)` (default=`1`)::
 
-Maximal number of backup files per VM.
+Maximal number of backup files per guest system.
 
 `-mode` `(snapshot | stop | suspend)` (default=`snapshot`)::
 
@@ -62,7 +63,7 @@ Only run if executed on this node.
 
 `-pigz` `integer` (default=`0`)::
 
-Uses pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as
+Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as
 thread count.
 
 `-quiet` `boolean` (default=`0`)::
@@ -79,11 +80,11 @@ Use specified hook script.
 
 `-size` `integer (500 - N)` (default=`1024`)::
 
-LVM snapshot size in MB.
+Unused, will be removed in a future release.
 
 `-stdexcludes` `boolean` (default=`1`)::
 
-Exclude temorary files and logs.
+Exclude temporary files and logs.
 
 `-stdout` `boolean` ::
 
@@ -95,7 +96,7 @@ Stop runnig backup jobs on this host.
 
 `-stopwait` `integer (0 - N)` (default=`10`)::
 
-Maximal time to wait until a VM is stopped (minutes).
+Maximal time to wait until a guest system is stopped (minutes).
 
 `-storage` `string` ::
 
index 2e72b23..dffa15b 100644 (file)
@@ -28,7 +28,8 @@ Specify when to send an email
 
 `mailto`: `string` ::
 
-no description available
+Comma-separated list of email addresses that should receive email
+notifications.
 
 `maxfiles`: `integer (1 - N)` (default=`1`)::