From 52e44c5018d7fd18ae192ab4456542702c6e9979 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Fabian=20Gr=C3=BCnbichler?= Date: Fri, 27 Jan 2017 11:25:55 +0100 Subject: [PATCH] update generated docs --- api-viewer/apidata.js | 74 +++++++++++++++++++++++++++++++++++++---- ha-groups-opts.adoc | 16 +++++++++ ha-resources-opts.adoc | 40 ++++++++++++++++++++++ pveceph.1-synopsis.adoc | 2 +- qm.1-synopsis.adoc | 30 ++++++++++++++--- qm.conf.5-opts.adoc | 14 ++++++-- 6 files changed, 162 insertions(+), 14 deletions(-) create mode 100644 ha-groups-opts.adoc create mode 100644 ha-resources-opts.adoc diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index dd6cc7a..bdb18c2 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -5649,7 +5649,7 @@ var pveapi = [ "format" : "pve-qm-hostpci", "optional" : 1, "type" : "string", - "typetext" : "[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]", + "typetext" : "[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { @@ -6794,6 +6794,12 @@ var pveapi = [ "optional" : 1, "type" : "integer" }, + "scsiblock" : { + "default" : 0, + "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host", + "optional" : 1, + "type" : "boolean" + }, "secs" : { "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, @@ -6846,7 +6852,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "scsihw" : { "default" : "lsi", @@ -7515,7 +7521,7 @@ var pveapi = [ "format" : "pve-qm-hostpci", "optional" : 1, "type" : "string", - "typetext" : "[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]", + "typetext" : "[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { @@ -8660,6 +8666,12 @@ var pveapi = [ "optional" : 1, "type" : "integer" }, + "scsiblock" : { + "default" : 0, + "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host", + "optional" : 1, + "type" : "boolean" + }, "secs" : { "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, @@ -8712,7 +8724,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "scsihw" : { "default" : "lsi", @@ -9621,6 +9633,12 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "targetstorage" : { + "description" : "Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", @@ -10442,12 +10460,25 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "targetstorage" : { + "description" : "Default target storage.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "vmid" : { "description" : "The (unique) ID of the VM.", "format" : "pve-vmid", "minimum" : 1, "type" : "integer", "typetext" : " (1 - N)" + }, + "with-local-disks" : { + "description" : "Enable live storage migration for local disk", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, @@ -11481,7 +11512,7 @@ var pveapi = [ "format" : "pve-qm-hostpci", "optional" : 1, "type" : "string", - "typetext" : "[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]", + "typetext" : "[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]", "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n" }, "hotplug" : { @@ -12626,6 +12657,12 @@ var pveapi = [ "optional" : 1, "type" : "integer" }, + "scsiblock" : { + "default" : 0, + "description" : "whether to use scsi-block for full passthrough of host block device\n\nWARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host", + "optional" : 1, + "type" : "boolean" + }, "secs" : { "description" : "Force the drive's physical geometry to have a specific sector count.", "optional" : 1, @@ -12678,7 +12715,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" + "typetext" : "[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]" }, "scsihw" : { "default" : "lsi", @@ -13626,7 +13663,8 @@ var pveapi = [ ], "any", 1 - ] + ], + "description" : "non-volume mount points in rootfs and mp[n] are restricted to root@pam" }, "protected" : 1, "proxyto" : "node", @@ -23337,6 +23375,13 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "vms" : { + "description" : "Only consider Guests with these IDs.", + "format" : "pve-vmid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" } } }, @@ -23374,6 +23419,13 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "vms" : { + "description" : "Only consider Guests with these IDs.", + "format" : "pve-vmid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" } } }, @@ -23424,6 +23476,13 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "vms" : { + "description" : "Only consider Guests with these IDs.", + "format" : "pve-vmid-list", + "optional" : 1, + "type" : "string", + "typetext" : "" } } }, @@ -25117,6 +25176,7 @@ var pveapi = [ "items" : { "properties" : { "comment" : { + "description" : "A comment. The GUI use this text when you select a domain (Realm) on the login window.", "optional" : 1, "type" : "string" }, diff --git a/ha-groups-opts.adoc b/ha-groups-opts.adoc new file mode 100644 index 0000000..7deb947 --- /dev/null +++ b/ha-groups-opts.adoc @@ -0,0 +1,16 @@ +`comment`: `` :: + +Description. + +`nodes`: `[:]{,[:]}*` :: + +List of cluster node members, where a priority can be given to each node. A resource bound to a group will run on the available nodes with the highest priority. If there are more nodes in the highest priority class, the services will get distributed to those nodes. The priorities have a relative meaning only. + +`nofailback`: `` ('default =' `0`):: + +The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. + +`restricted`: `` ('default =' `0`):: + +Resources bound to restricted groups may only run on nodes defined by the group. The resource will be placed in the stopped state if no group node member is online. Resources on unrestricted groups may run on any cluster node if all group members are offline, but they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with only one member. + diff --git a/ha-resources-opts.adoc b/ha-resources-opts.adoc new file mode 100644 index 0000000..50780ae --- /dev/null +++ b/ha-resources-opts.adoc @@ -0,0 +1,40 @@ +`comment`: `` :: + +Description. + +`group`: `` :: + +The HA group identifier. + +`max_relocate`: ` (0 - N)` ('default =' `1`):: + +Maximal number of service relocate tries when a service failes to start. + +`max_restart`: ` (0 - N)` ('default =' `1`):: + +Maximal number of tries to restart the service on a node after its start failed. + +`state`: `` ('default =' `started`):: + +Requested resource state. The CRM reads this state and acts accordingly. +Please note that `enabled` is just an alias for `started`. ++ +`started`;; ++ +The CRM tries to start the resource. Service state is +set to `started` after successful start. On node failures, or when start +fails, it tries to recover the resource. If everything fails, service +state it set to `error`. ++ +`stopped`;; ++ +The CRM tries to keep the resource in `stopped` state, but it +still tries to relocate the resources on node failures. ++ +`disabled`;; ++ +The CRM tries to put the resource in `stopped` state, but does not try +to relocate the resources on node failures. The main purpose of this +state is error recovery, because it is the only way to move a resource out +of the `error` state. + diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 0859989..7cd041c 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -133,7 +133,7 @@ Number of replicas per object Install ceph related packages. -`-version` `` :: +`-version` `` :: no description available diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index eacd6f6..d45a18b 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -161,7 +161,7 @@ NOTE: Requires option(s): `archive` Freeze CPU at startup (use 'c' monitor command to start execution). -`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: +`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. @@ -253,7 +253,7 @@ Allow reboot. If set to '0' the VM exit on reboot. Use volume as SATA hard disk or CD-ROM (n is 0 to 5). -`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). @@ -433,6 +433,14 @@ Migration traffic is encrypted using an SSH tunnel by default. On secure, comple Use online/live migration. +`-targetstorage` `` :: + +Default target storage. + +`-with-local-disks` `` :: + +Enable live storage migration for local disk + @@ -484,6 +492,16 @@ Used by qmigrate - do not use manually. +*qm nbdstop* `` + +Stop embedded nbd server. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + + + *qm pending* `` @@ -685,7 +703,7 @@ NOTE: Requires option(s): `delete` Freeze CPU at startup (use 'c' monitor command to start execution). -`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: +`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. @@ -777,7 +795,7 @@ Revert a pending change. Use volume as SATA hard disk or CD-ROM (n is 0 to 5). -`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`-scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). @@ -949,6 +967,10 @@ Ignore locks - only root is allowed to use this option. Some command save/restore state from this location. +`-targetstorage` `` :: + +Target storage for the migration. (Can be '1' to use the same storage id as on the source node.) + diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index fdc0cb6..125b4b0 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -90,7 +90,7 @@ Disk size. This is purely informational and has no effect. Freeze CPU at startup (use 'c' monitor command to start execution). -`hostpci[n]`: `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]` :: +`hostpci[n]`: `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. + @@ -116,6 +116,10 @@ Choose the PCI-express bus (needs the 'q35' machine model). Specify whether or not the device's ROM will be visible in the guest's memory map. +`romfile`=`` ;; + +Custom pci device rom filename (must be located in /usr/share/kvm/). + `x-vga`=`` ('default =' `0`);; Enable vfio-vga device support. @@ -593,7 +597,7 @@ Force disk geometry bios translation mode. Write error action. -`scsi[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`scsi[n]`: `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_length=] [,bps_wr=] [,bps_wr_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_length=] [,iops_rd_max=] [,iops_wr=] [,iops_wr_length=] [,iops_wr_max=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). @@ -729,6 +733,12 @@ The drive's media type. Number of queues. +`scsiblock`=`` ('default =' `0`);; + +whether to use scsi-block for full passthrough of host block device ++ +WARNING: can lead to I/O errors in combination with low memory or high memory fragmentation on host + `secs`=`` ;; Force the drive's physical geometry to have a specific sector count. -- 2.39.2