From 2489d6df4ac5e916ae18401310bfd1e69c993e55 Mon Sep 17 00:00:00 2001 From: Wolfgang Bumiller Date: Thu, 19 Oct 2017 09:30:23 +0200 Subject: [PATCH] update generated docs --- api-viewer/apidata.js | 394 +++++++++++++++++++++++++++----- ha-manager.1-synopsis.adoc | 56 ++--- ha-resources-opts.adoc | 12 +- pct-network-opts.adoc | 6 +- pct.1-synopsis.adoc | 236 +++++++++---------- pct.conf.5-opts.adoc | 6 +- pve-firewall-macros.adoc | 2 +- pve-firewall-rules-opts.adoc | 12 +- pve-firewall.8-synopsis.adoc | 20 +- pve-ha-crm.8-synopsis.adoc | 4 +- pve-ha-lrm.8-synopsis.adoc | 4 +- pveam.1-synopsis.adoc | 4 +- pveceph.1-synopsis.adoc | 98 ++++++-- pvecm.1-synopsis.adoc | 44 ++-- pvedaemon.8-synopsis.adoc | 4 +- pveproxy.8-synopsis.adoc | 4 +- pvesm.1-synopsis.adoc | 166 +++++++------- pvesr.1-synopsis.adoc | 46 ++-- pvestatd.8-synopsis.adoc | 4 +- pvesubscription.1-synopsis.adoc | 6 +- pveum.1-synopsis.adoc | 78 +++---- qm.1-synopsis.adoc | 388 +++++++++++++++++-------------- qm.conf.5-opts.adoc | 8 +- qmrestore.1-synopsis.adoc | 8 +- spiceproxy.8-synopsis.adoc | 4 +- vzdump.1-synopsis.adoc | 48 ++-- 26 files changed, 1018 insertions(+), 644 deletions(-) diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index a8916dd..a6b3cca 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -2953,11 +2953,12 @@ var pveapi = [ "started", "stopped", "enabled", - "disabled" + "disabled", + "ignored" ], "optional" : 1, "type" : "string", - "verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n" + "verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n`ignored`;;\n\nThe resource gets removed from the manager status and so the CRM and the LRM do\nnot touch the resource anymore. All {pve} API calls affecting this resource\nwill be executed, directly bypassing the HA stack. CRM commands will be thrown\naway while there source is in this state. The resource will not get relocated\non node failures.\n\n" } }, "type" : "object" @@ -3078,11 +3079,12 @@ var pveapi = [ "started", "stopped", "enabled", - "disabled" + "disabled", + "ignored" ], "optional" : 1, "type" : "string", - "verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n" + "verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n`ignored`;;\n\nThe resource gets removed from the manager status and so the CRM and the LRM do\nnot touch the resource anymore. All {pve} API calls affecting this resource\nwill be executed, directly bypassing the HA stack. CRM commands will be thrown\naway while there source is in this state. The resource will not get relocated\non node failures.\n\n" }, "type" : { "description" : "Resource type.", @@ -5904,12 +5906,12 @@ var pveapi = [ "cpuunits" : { "default" : 1024, "description" : "CPU weight for a VM.", - "maximum" : 500000, - "minimum" : 0, + "maximum" : 262144, + "minimum" : 2, "optional" : 1, "type" : "integer", - "typetext" : " (0 - 500000)", - "verbose_description" : "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0." + "typetext" : " (2 - 262144)", + "verbose_description" : "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." }, "delete" : { "description" : "A list of settings you want to delete.", @@ -7680,6 +7682,13 @@ var pveapi = [ "type" : "integer", "typetext" : " (1 - N)" }, + "vmstatestorage" : { + "description" : "Default storage for VM state volumes/files.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "watchdog" : { "description" : "Create a virtual hardware watchdog device.", "format" : "pve-qm-watchdog", @@ -7859,12 +7868,12 @@ var pveapi = [ "cpuunits" : { "default" : 1024, "description" : "CPU weight for a VM.", - "maximum" : 500000, - "minimum" : 0, + "maximum" : 262144, + "minimum" : 2, "optional" : 1, "type" : "integer", - "typetext" : " (0 - 500000)", - "verbose_description" : "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0." + "typetext" : " (2 - 262144)", + "verbose_description" : "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." }, "delete" : { "description" : "A list of settings you want to delete.", @@ -9635,6 +9644,13 @@ var pveapi = [ "type" : "integer", "typetext" : " (1 - N)" }, + "vmstatestorage" : { + "description" : "Default storage for VM state volumes/files.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "watchdog" : { "description" : "Create a virtual hardware watchdog device.", "format" : "pve-qm-watchdog", @@ -11234,8 +11250,11 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Snapshot" - ] + "VM.Snapshot", + "VM.Snapshot.Rollback" + ], + "any", + 1 ] }, "proxyto" : "node", @@ -11334,8 +11353,11 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Snapshot" - ] + "VM.Snapshot", + "VM.Snapshot.Rollback" + ], + "any", + 1 ] }, "protected" : 1, @@ -11947,12 +11969,12 @@ var pveapi = [ "cpuunits" : { "default" : 1024, "description" : "CPU weight for a VM.", - "maximum" : 500000, - "minimum" : 0, + "maximum" : 262144, + "minimum" : 2, "optional" : 1, "type" : "integer", - "typetext" : " (0 - 500000)", - "verbose_description" : "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.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0." + "typetext" : " (2 - 262144)", + "verbose_description" : "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." }, "description" : { "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.", @@ -13717,6 +13739,13 @@ var pveapi = [ "type" : "integer", "typetext" : " (1 - N)" }, + "vmstatestorage" : { + "description" : "Default storage for VM state volumes/files.", + "format" : "pve-storage-id", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "watchdog" : { "description" : "Create a virtual hardware watchdog device.", "format" : "pve-qm-watchdog", @@ -14007,14 +14036,14 @@ var pveapi = [ "ip" : { "description" : "IPv4 address in CIDR format.", "format" : "pve-ipv4-config", - "format_description" : "IPv4Format/CIDR", + "format_description" : "(IPv4/CIDR|dhcp|manual)", "optional" : 1, "type" : "string" }, "ip6" : { "description" : "IPv6 address in CIDR format.", "format" : "pve-ipv6-config", - "format_description" : "IPv6Format/CIDR", + "format_description" : "(IPv6/CIDR|auto|dhcp|manual)", "optional" : 1, "type" : "string" }, @@ -14061,7 +14090,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" + "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" }, "node" : { "description" : "The cluster node name.", @@ -14621,8 +14650,11 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Snapshot" - ] + "VM.Snapshot", + "VM.Snapshot.Rollback" + ], + "any", + 1 ] }, "protected" : 1, @@ -14673,8 +14705,11 @@ var pveapi = [ "perm", "/vms/{vmid}", [ - "VM.Snapshot" - ] + "VM.Snapshot", + "VM.Snapshot.Rollback" + ], + "any", + 1 ] }, "proxyto" : "node", @@ -17714,14 +17749,14 @@ var pveapi = [ "ip" : { "description" : "IPv4 address in CIDR format.", "format" : "pve-ipv4-config", - "format_description" : "IPv4Format/CIDR", + "format_description" : "(IPv4/CIDR|dhcp|manual)", "optional" : 1, "type" : "string" }, "ip6" : { "description" : "IPv6 address in CIDR format.", "format" : "pve-ipv6-config", - "format_description" : "IPv6Format/CIDR", + "format_description" : "(IPv6/CIDR|auto|dhcp|manual)", "optional" : 1, "type" : "string" }, @@ -17768,7 +17803,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" + "typetext" : "name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]" }, "node" : { "description" : "The cluster node name.", @@ -18168,7 +18203,7 @@ var pveapi = [ "type" : "string" }, "journal_dev" : { - "description" : "Block device name for journal.", + "description" : "Block device name for journal (filestore) or block.db (bluestore).", "optional" : 1, "type" : "string", "typetext" : "" @@ -18178,6 +18213,12 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "wal_dev" : { + "description" : "Block device name for block.wal (bluestore only).", + "optional" : 1, + "type" : "string", + "typetext" : "" } } }, @@ -18317,16 +18358,23 @@ var pveapi = [ { "info" : { "DELETE" : { - "description" : "Destroy Ceph monitor.", + "description" : "Destroy Ceph Monitor and Manager.", "method" : "DELETE", "name" : "destroymon", "parameters" : { "additionalProperties" : 0, "properties" : { + "exclude-manager" : { + "default" : 0, + "description" : "When set, removes only the monitor, not the manager", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "monid" : { "description" : "Monitor ID", - "type" : "integer", - "typetext" : "" + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", + "type" : "string" }, "node" : { "description" : "The cluster node name.", @@ -18409,12 +18457,25 @@ var pveapi = [ } }, "POST" : { - "description" : "Create Ceph Monitor", + "description" : "Create Ceph Monitor and Manager", "method" : "POST", "name" : "createmon", "parameters" : { "additionalProperties" : 0, "properties" : { + "exclude-manager" : { + "default" : 0, + "description" : "When set, only a monitor will be created.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "id" : { + "description" : "The ID for the monitor, when omitted the same as the nodename", + "optional" : 1, + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", + "type" : "string" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -18522,6 +18583,93 @@ var pveapi = [ "path" : "/nodes/{node}/ceph/init", "text" : "init" }, + { + "children" : [ + { + "info" : { + "DELETE" : { + "description" : "Destroy Ceph Manager.", + "method" : "DELETE", + "name" : "destroymgr", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "id" : { + "description" : "The ID of the manager", + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/mgr/{id}", + "text" : "{id}" + } + ], + "info" : { + "POST" : { + "description" : "Create Ceph Manager", + "method" : "POST", + "name" : "createmgr", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "id" : { + "description" : "The ID for the manager, when omitted the same as the nodename", + "optional" : 1, + "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Modify" + ] + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "string" + } + } + }, + "leaf" : 0, + "path" : "/nodes/{node}/ceph/mgr", + "text" : "mgr" + }, { "info" : { "POST" : { @@ -18540,7 +18688,7 @@ var pveapi = [ "service" : { "description" : "Ceph service name.", "optional" : 1, - "pattern" : "(mon|mds|osd)\\.[A-Za-z0-9]{1,32}", + "pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}", "type" : "string" } } @@ -18583,7 +18731,7 @@ var pveapi = [ "service" : { "description" : "Ceph service name.", "optional" : 1, - "pattern" : "(mon|mds|osd)\\.[A-Za-z0-9]{1,32}", + "pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}", "type" : "string" } } @@ -18676,6 +18824,13 @@ var pveapi = [ "format" : "pve-node", "type" : "string", "typetext" : "" + }, + "remove_storages" : { + "default" : 0, + "description" : "Remove all pveceph-managed storages configured for this pool", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } } }, @@ -18691,7 +18846,7 @@ var pveapi = [ "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "null" + "type" : "string" } } }, @@ -18761,17 +18916,30 @@ var pveapi = [ "parameters" : { "additionalProperties" : 0, "properties" : { - "crush_ruleset" : { - "default" : 0, - "description" : "The ruleset to use for mapping object placement in the cluster.", - "maximum" : 32768, - "minimum" : 0, + "add_storages" : { + "description" : "Configure VM and CT storages using the new pool.", "optional" : 1, - "type" : "integer", - "typetext" : " (0 - 32768)" + "type" : "boolean", + "typetext" : "" + }, + "application" : { + "description" : "The application of the pool, 'rbd' by default.", + "enum" : [ + "rbd", + "cephfs", + "rgw" + ], + "optional" : 1, + "type" : "string" + }, + "crush_rule" : { + "description" : "The rule to use for mapping object placement in the cluster.", + "optional" : 1, + "type" : "string", + "typetext" : "" }, "min_size" : { - "default" : 1, + "default" : 2, "description" : "Minimum number of replicas per object", "maximum" : 7, "minimum" : 1, @@ -18800,7 +18968,7 @@ var pveapi = [ "typetext" : " (8 - 32768)" }, "size" : { - "default" : 2, + "default" : 3, "description" : "Number of replicas per object", "maximum" : 7, "minimum" : 1, @@ -18822,7 +18990,7 @@ var pveapi = [ "protected" : 1, "proxyto" : "node", "returns" : { - "type" : "null" + "type" : "string" } } }, @@ -19073,6 +19241,56 @@ var pveapi = [ "leaf" : 1, "path" : "/nodes/{node}/ceph/log", "text" : "log" + }, + { + "info" : { + "GET" : { + "description" : "List ceph rules.", + "method" : "GET", + "name" : "rules", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/", + [ + "Sys.Audit", + "Datastore.Audit" + ], + "any", + 1 + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, + "links" : [ + { + "href" : "{name}", + "rel" : "child" + } + ], + "type" : "array" + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/ceph/rules", + "text" : "rules" } ], "info" : { @@ -19857,8 +20075,9 @@ var pveapi = [ "properties" : { "key" : { "description" : "Proxmox VE subscription key", - "type" : "string", - "typetext" : "" + "maxLength" : 32, + "pattern" : "pve([124])([cbsp])-[0-9a-f]{10}", + "type" : "string" }, "node" : { "description" : "The cluster node name.", @@ -24572,10 +24791,10 @@ var pveapi = [ }, "is_mountpoint" : { "default" : "no", - "description" : "Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.", + "description" : "Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string", + "typetext" : "" }, "krbd" : { "description" : "Access rbd through krbd kernel module.", @@ -24597,6 +24816,13 @@ var pveapi = [ "type" : "boolean", "typetext" : "" }, + "monhost" : { + "description" : "IP addresses of monitors (for external clusters).", + "format" : "pve-storage-portal-dns-list", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "nodes" : { "description" : "List of cluster node names.", "format" : "pve-node-list", @@ -24840,10 +25066,10 @@ var pveapi = [ }, "is_mountpoint" : { "default" : "no", - "description" : "Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.", + "description" : "Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.", "optional" : 1, - "type" : "boolean", - "typetext" : "" + "type" : "string", + "typetext" : "" }, "iscsiprovider" : { "description" : "iscsi provider", @@ -24872,7 +25098,7 @@ var pveapi = [ "typetext" : "" }, "monhost" : { - "description" : "Monitors daemon ips.", + "description" : "IP addresses of monitors (for external clusters).", "format" : "pve-storage-portal-dns-list", "optional" : 1, "type" : "string", @@ -25925,6 +26151,25 @@ var pveapi = [ "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*", "type" : "string" }, + "capath" : { + "default" : "/etc/ssl/certs", + "description" : "Path to the CA certificate store", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "cert" : { + "description" : "Path to the client certificate", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "certkey" : { + "description" : "Path to the client certificate key", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "comment" : { "description" : "Description.", "maxLength" : 4096, @@ -26011,6 +26256,13 @@ var pveapi = [ "optional" : 1, "pattern" : "\\S{2,}", "type" : "string" + }, + "verify" : { + "default" : 0, + "description" : "Verify the server's SSL certificate", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } }, "type" : "object" @@ -26100,6 +26352,25 @@ var pveapi = [ "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*", "type" : "string" }, + "capath" : { + "default" : "/etc/ssl/certs", + "description" : "Path to the CA certificate store", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "cert" : { + "description" : "Path to the client certificate", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, + "certkey" : { + "description" : "Path to the client certificate key", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "comment" : { "description" : "Description.", "maxLength" : 4096, @@ -26181,6 +26452,13 @@ var pveapi = [ "optional" : 1, "pattern" : "\\S{2,}", "type" : "string" + }, + "verify" : { + "default" : 0, + "description" : "Verify the server's SSL certificate", + "optional" : 1, + "type" : "boolean", + "typetext" : "" } }, "type" : "object" @@ -26207,7 +26485,7 @@ var pveapi = [ { "info" : { "GET" : { - "description" : "Dummy. Useful for formaters which want to priovde a login page.", + "description" : "Dummy. Useful for formatters which want to provide a login page.", "method" : "GET", "name" : "get_ticket", "parameters" : { diff --git a/ha-manager.1-synopsis.adoc b/ha-manager.1-synopsis.adoc index 1d46027..7394c5d 100644 --- a/ha-manager.1-synopsis.adoc +++ b/ha-manager.1-synopsis.adoc @@ -8,27 +8,27 @@ Create a new HA resource. HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). -`-comment` `` :: +`--comment` `` :: Description. -`-group` `` :: +`--group` `` :: The HA group identifier. -`-max_relocate` ` (0 - N)` ('default =' `1`):: +`--max_relocate` ` (0 - N)` ('default =' `1`):: Maximal number of service relocate tries when a service failes to start. -`-max_restart` ` (0 - N)` ('default =' `1`):: +`--max_restart` ` (0 - N)` ('default =' `1`):: Maximal number of tries to restart the service on a node after its start failed. -`-state` `` ('default =' `started`):: +`--state` `` ('default =' `started`):: Requested resource state. -`-type` `` :: +`--type` `` :: Resource type. @@ -38,14 +38,14 @@ Resource type. List HA resources. -`-type` `` :: +`--type` `` :: Only list resources of specific type -*ha-manager groupadd* ` -nodes ` `[OPTIONS]` +*ha-manager groupadd* ` --nodes ` `[OPTIONS]` Create a new HA group. @@ -53,23 +53,23 @@ Create a new HA group. The HA group identifier. -`-comment` `` :: +`--comment` `` :: Description. -`-nodes` `[:]{,[:]}*` :: +`--nodes` `[:]{,[:]}*` :: List of cluster node names with optional priority. -`-nofailback` `` ('default =' `0`):: +`--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`):: +`--restricted` `` ('default =' `0`):: Resources bound to restricted groups may only run on nodes defined by the group. -`-type` `` :: +`--type` `` :: Group type. @@ -99,27 +99,27 @@ Update ha group configuration. The HA group identifier. -`-comment` `` :: +`--comment` `` :: Description. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-nodes` `[:]{,[:]}*` :: +`--nodes` `[:]{,[:]}*` :: List of cluster node names with optional priority. -`-nofailback` `` ('default =' `0`):: +`--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`):: +`--restricted` `` ('default =' `0`):: Resources bound to restricted groups may only run on nodes defined by the group. @@ -134,7 +134,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -188,31 +188,31 @@ Update resource configuration. HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). -`-comment` `` :: +`--comment` `` :: Description. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-group` `` :: +`--group` `` :: The HA group identifier. -`-max_relocate` ` (0 - N)` ('default =' `1`):: +`--max_relocate` ` (0 - N)` ('default =' `1`):: Maximal number of service relocate tries when a service failes to start. -`-max_restart` ` (0 - N)` ('default =' `1`):: +`--max_restart` ` (0 - N)` ('default =' `1`):: Maximal number of tries to restart the service on a node after its start failed. -`-state` `` ('default =' `started`):: +`--state` `` ('default =' `started`):: Requested resource state. @@ -223,7 +223,7 @@ Requested resource state. Display HA manger status. -`-verbose` `` ('default =' `0`):: +`--verbose` `` ('default =' `0`):: Verbose output. Include complete CRM and LRM status (JSON). diff --git a/ha-resources-opts.adoc b/ha-resources-opts.adoc index 3dcb697..c0aaf19 100644 --- a/ha-resources-opts.adoc +++ b/ha-resources-opts.adoc @@ -8,13 +8,13 @@ The HA group identifier. `max_relocate`: ` (0 - N)` ('default =' `1`):: -Maximal number of service relocate tries when a service fails to start. +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`):: +`state`: `` ('default =' `started`):: Requested resource state. The CRM reads this state and acts accordingly. Please note that `enabled` is just an alias for `started`. @@ -37,4 +37,12 @@ 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. ++ +`ignored`;; ++ +The resource gets removed from the manager status and so the CRM and the LRM do +not touch the resource anymore. All {pve} API calls affecting this resource +will be executed, directly bypassing the HA stack. CRM commands will be thrown +away while there source is in this state. The resource will not get relocated +on node failures. diff --git a/pct-network-opts.adoc b/pct-network-opts.adoc index 50354da..7943b0c 100644 --- a/pct-network-opts.adoc +++ b/pct-network-opts.adoc @@ -1,4 +1,4 @@ -`net[n]`: `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: +`net[n]`: `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. @@ -22,11 +22,11 @@ Default gateway for IPv6 traffic. The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr) -`ip`=`` ;; +`ip`=`<(IPv4/CIDR|dhcp|manual)>` ;; IPv4 address in CIDR format. -`ip6`=`` ;; +`ip6`=`<(IPv6/CIDR|auto|dhcp|manual)>` ;; IPv6 address in CIDR format. diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 3e3f558..0fea003 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -1,6 +1,6 @@ *pct* ` [ARGS] [OPTIONS]` -*pct clone* ` -experimental ` `[OPTIONS]` +*pct clone* ` --experimental ` `[OPTIONS]` Create a container clone/copy @@ -12,31 +12,31 @@ The (unique) ID of the VM. VMID for the clone. -`-description` `` :: +`--description` `` :: Description for the new CT. -`-experimental` `` ('default =' `0`):: +`--experimental` `` ('default =' `0`):: The clone feature is experimental, set this flag if you know what you are doing. -`-full` `` ('default =' `0`):: +`--full` `` ('default =' `0`):: Create a full copy of all disk. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. -`-hostname` `` :: +`--hostname` `` :: Set a hostname for the new CT. -`-pool` `` :: +`--pool` `` :: Add the new CT to the specified pool. -`-snapname` `` :: +`--snapname` `` :: The name of the snapshot. -`-storage` `` :: +`--storage` `` :: Target storage for full clone. + @@ -85,131 +85,131 @@ The (unique) ID of the VM. The OS template or backup file. -`-arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. -`-cmode` `` ('default =' `tty`):: +`--cmode` `` ('default =' `tty`):: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). -`-console` `` ('default =' `1`):: +`--console` `` ('default =' `1`):: Attach a console device (/dev/console) to the container. -`-cores` ` (1 - 128)` :: +`--cores` ` (1 - 128)` :: The number of cores assigned to the container. A container can use all available cores by default. -`-cpulimit` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. + NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. -`-cpuunits` ` (0 - 500000)` ('default =' `1024`):: +`--cpuunits` ` (0 - 500000)` ('default =' `1024`):: 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 the weights of all the other running VMs. + NOTE: You can disable fair-scheduler configuration by setting this to 0. -`-description` `` :: +`--description` `` :: Container description. Only used on the configuration web interface. -`-force` `` :: +`--force` `` :: Allow to overwrite existing container. -`-hostname` `` :: +`--hostname` `` :: Set a host name for the container. -`-ignore-unpack-errors` `` :: +`--ignore-unpack-errors` `` :: Ignore errors when extracting the template. -`-lock` `` :: +`--lock` `` :: Lock/unlock the VM. -`-memory` ` (16 - N)` ('default =' `512`):: +`--memory` ` (16 - N)` ('default =' `512`):: Amount of RAM for the VM in MB. -`-mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container mount point. -`-nameserver` `` :: +`--nameserver` `` :: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. -`-net[n]` `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: +`--net[n]` `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. -`-onboot` `` ('default =' `0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. -`-password` :: +`--password` :: Sets root password inside container. -`-pool` `` :: +`--pool` `` :: Add the VM to the specified pool. -`-protection` `` ('default =' `0`):: +`--protection` `` ('default =' `0`):: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. -`-restore` `` :: +`--restore` `` :: Mark this as restore task. -`-rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container root. -`-searchdomain` `` :: +`--searchdomain` `` :: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. -`-ssh-public-keys` `` :: +`--ssh-public-keys` `` :: Setup public SSH keys (one key per line, OpenSSH format). -`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: +`--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. -`-storage` `` ('default =' `local`):: +`--storage` `` ('default =' `local`):: Default Storage. -`-swap` ` (0 - N)` ('default =' `512`):: +`--swap` ` (0 - N)` ('default =' `512`):: Amount of SWAP for the VM in MB. -`-template` `` ('default =' `0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-tty` ` (0 - 6)` ('default =' `2`):: +`--tty` ` (0 - 6)` ('default =' `2`):: Specify the number of tty available to the container -`-unprivileged` `` ('default =' `0`):: +`--unprivileged` `` ('default =' `0`):: Makes the container run as unprivileged user. (Should not be modified manually.) -`-unused[n]` `` :: +`--unused[n]` `` :: Reference to unused volumes. This is used internally, and should not be modified manually. @@ -228,7 +228,7 @@ The (unique) ID of the VM. The name of the snapshot. -`-force` `` :: +`--force` `` :: For removal from config file, even if removing disk snapshots fails. @@ -288,11 +288,11 @@ Run a filesystem check (fsck) on a container volume. The (unique) ID of the VM. -`-device` `` :: +`--device` `` :: A volume on which to run the filesystem check -`-force` `` ('default =' `0`):: +`--force` `` ('default =' `0`):: Force checking, even if the filesystem seems clean @@ -307,7 +307,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -344,19 +344,19 @@ The (unique) ID of the VM. Target node. -`-force` `` :: +`--force` `` :: Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead. -`-online` `` :: +`--online` `` :: Use online/live migration. -`-restart` `` :: +`--restart` `` :: Use restart migration -`-timeout` `` ('default =' `180`):: +`--timeout` `` ('default =' `180`):: Timeout in seconds for shutdown for restart migration @@ -391,15 +391,15 @@ Path to a file inside the container to pull. Destination -`-group` `` :: +`--group` `` :: Owner group name or id. -`-perms` `` :: +`--perms` `` :: File permissions to use (octal by default, prefix with '0x' for hexadecimal). -`-user` `` :: +`--user` `` :: Owner user name or id. @@ -421,15 +421,15 @@ Path to a local file. Destination inside the container to write to. -`-group` `` :: +`--group` `` :: Owner group name or id. When using a name it must exist inside the container. -`-perms` `` :: +`--perms` `` :: File permissions to use (octal by default, prefix with '0x' for hexadecimal). -`-user` `` :: +`--user` `` :: Owner user name or id. When using a name it must exist inside the container. @@ -452,7 +452,7 @@ The disk you want to resize. The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. @@ -470,127 +470,127 @@ The (unique) ID of the VM. The OS template or backup file. -`-arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. -`-cmode` `` ('default =' `tty`):: +`--cmode` `` ('default =' `tty`):: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). -`-console` `` ('default =' `1`):: +`--console` `` ('default =' `1`):: Attach a console device (/dev/console) to the container. -`-cores` ` (1 - 128)` :: +`--cores` ` (1 - 128)` :: The number of cores assigned to the container. A container can use all available cores by default. -`-cpulimit` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. + NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. -`-cpuunits` ` (0 - 500000)` ('default =' `1024`):: +`--cpuunits` ` (0 - 500000)` ('default =' `1024`):: 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 the weights of all the other running VMs. + NOTE: You can disable fair-scheduler configuration by setting this to 0. -`-description` `` :: +`--description` `` :: Container description. Only used on the configuration web interface. -`-force` `` :: +`--force` `` :: Allow to overwrite existing container. -`-hostname` `` :: +`--hostname` `` :: Set a host name for the container. -`-ignore-unpack-errors` `` :: +`--ignore-unpack-errors` `` :: Ignore errors when extracting the template. -`-lock` `` :: +`--lock` `` :: Lock/unlock the VM. -`-memory` ` (16 - N)` ('default =' `512`):: +`--memory` ` (16 - N)` ('default =' `512`):: Amount of RAM for the VM in MB. -`-mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container mount point. -`-nameserver` `` :: +`--nameserver` `` :: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. -`-net[n]` `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: +`--net[n]` `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. -`-onboot` `` ('default =' `0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. -`-password` :: +`--password` :: Sets root password inside container. -`-pool` `` :: +`--pool` `` :: Add the VM to the specified pool. -`-protection` `` ('default =' `0`):: +`--protection` `` ('default =' `0`):: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. -`-rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container root. -`-searchdomain` `` :: +`--searchdomain` `` :: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. -`-ssh-public-keys` `` :: +`--ssh-public-keys` `` :: Setup public SSH keys (one key per line, OpenSSH format). -`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: +`--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. -`-storage` `` ('default =' `local`):: +`--storage` `` ('default =' `local`):: Default Storage. -`-swap` ` (0 - N)` ('default =' `512`):: +`--swap` ` (0 - N)` ('default =' `512`):: Amount of SWAP for the VM in MB. -`-template` `` ('default =' `0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-tty` ` (0 - 6)` ('default =' `2`):: +`--tty` ` (0 - 6)` ('default =' `2`):: Specify the number of tty available to the container -`-unprivileged` `` ('default =' `0`):: +`--unprivileged` `` ('default =' `0`):: Makes the container run as unprivileged user. (Should not be modified manually.) -`-unused[n]` `` :: +`--unused[n]` `` :: Reference to unused volumes. This is used internally, and should not be modified manually. @@ -631,111 +631,111 @@ Set container options. The (unique) ID of the VM. -`-arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. -`-cmode` `` ('default =' `tty`):: +`--cmode` `` ('default =' `tty`):: Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). -`-console` `` ('default =' `1`):: +`--console` `` ('default =' `1`):: Attach a console device (/dev/console) to the container. -`-cores` ` (1 - 128)` :: +`--cores` ` (1 - 128)` :: The number of cores assigned to the container. A container can use all available cores by default. -`-cpulimit` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. + NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. -`-cpuunits` ` (0 - 500000)` ('default =' `1024`):: +`--cpuunits` ` (0 - 500000)` ('default =' `1024`):: 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 the weights of all the other running VMs. + NOTE: You can disable fair-scheduler configuration by setting this to 0. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-description` `` :: +`--description` `` :: Container description. Only used on the configuration web interface. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-hostname` `` :: +`--hostname` `` :: Set a host name for the container. -`-lock` `` :: +`--lock` `` :: Lock/unlock the VM. -`-memory` ` (16 - N)` ('default =' `512`):: +`--memory` ` (16 - N)` ('default =' `512`):: Amount of RAM for the VM in MB. -`-mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container mount point. -`-nameserver` `` :: +`--nameserver` `` :: Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. -`-net[n]` `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: +`--net[n]` `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. -`-onboot` `` ('default =' `0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `` :: +`--ostype` `` :: OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. -`-protection` `` ('default =' `0`):: +`--protection` `` ('default =' `0`):: Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. -`-rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container root. -`-searchdomain` `` :: +`--searchdomain` `` :: Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. -`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: +`--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. -`-swap` ` (0 - N)` ('default =' `512`):: +`--swap` ` (0 - N)` ('default =' `512`):: Amount of SWAP for the VM in MB. -`-template` `` ('default =' `0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-tty` ` (0 - 6)` ('default =' `2`):: +`--tty` ` (0 - 6)` ('default =' `2`):: Specify the number of tty available to the container -`-unprivileged` `` ('default =' `0`):: +`--unprivileged` `` ('default =' `0`):: Makes the container run as unprivileged user. (Should not be modified manually.) -`-unused[n]` `` :: +`--unused[n]` `` :: Reference to unused volumes. This is used internally, and should not be modified manually. @@ -751,11 +751,11 @@ container, see lxc-stop(1) for details. The (unique) ID of the VM. -`-forceStop` `` ('default =' `0`):: +`--forceStop` `` ('default =' `0`):: Make sure the Container stops. -`-timeout` ` (0 - N)` ('default =' `60`):: +`--timeout` ` (0 - N)` ('default =' `60`):: Wait maximal timeout seconds. @@ -774,7 +774,7 @@ The (unique) ID of the VM. The name of the snapshot. -`-description` `` :: +`--description` `` :: A textual description or comment. @@ -789,7 +789,7 @@ Start the container. The (unique) ID of the VM. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -804,7 +804,7 @@ Show CT status. The (unique) ID of the VM. -`-verbose` `` :: +`--verbose` `` :: Verbose output format @@ -820,7 +820,7 @@ container. The (unique) ID of the VM. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -837,7 +837,7 @@ The (unique) ID of the VM. -*pct template* ` -experimental ` `[OPTIONS]` +*pct template* ` --experimental ` `[OPTIONS]` Create a Template. @@ -845,7 +845,7 @@ Create a Template. The (unique) ID of the VM. -`-experimental` `` ('default =' `0`):: +`--experimental` `` ('default =' `0`):: The template feature is experimental, set this flag if you know what you are doing. diff --git a/pct.conf.5-opts.adoc b/pct.conf.5-opts.adoc index 05bfa82..fbced2d 100644 --- a/pct.conf.5-opts.adoc +++ b/pct.conf.5-opts.adoc @@ -90,7 +90,7 @@ Volume, device or directory to mount into the container. Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. -`net[n]`: `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: +`net[n]`: `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. @@ -114,11 +114,11 @@ Default gateway for IPv6 traffic. The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr) -`ip`=`` ;; +`ip`=`<(IPv4/CIDR|dhcp|manual)>` ;; IPv4 address in CIDR format. -`ip6`=`` ;; +`ip6`=`<(IPv6/CIDR|auto|dhcp|manual)>` ;; IPv6 address in CIDR format. diff --git a/pve-firewall-macros.adoc b/pve-firewall-macros.adoc index 5818a19..84da137 100644 --- a/pve-firewall-macros.adoc +++ b/pve-firewall-macros.adoc @@ -56,7 +56,7 @@ |=========================================================== [horizontal] -'Ceph':: Ceph Storage Cluster traffic (Ceph Monitors, OSD & MDS Daemons) +'Ceph':: Ceph Storage Cluster traffic (Ceph Monitors, OSD & MDS Deamons) [width="100%",options="header"] |=========================================================== diff --git a/pve-firewall-rules-opts.adoc b/pve-firewall-rules-opts.adoc index dbdc274..5d7ba48 100644 --- a/pve-firewall-rules-opts.adoc +++ b/pve-firewall-rules-opts.adoc @@ -1,24 +1,24 @@ -`-dest` `` :: +`--dest` `` :: Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. -`-dport` `` :: +`--dport` `` :: Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. -`-iface` `` :: +`--iface` `` :: Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. -`-proto` `` :: +`--proto` `` :: IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. -`-source` `` :: +`--source` `` :: Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. -`-sport` `` :: +`--sport` `` :: Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. diff --git a/pve-firewall.8-synopsis.adoc b/pve-firewall.8-synopsis.adoc index c68aaa4..729c81a 100644 --- a/pve-firewall.8-synopsis.adoc +++ b/pve-firewall.8-synopsis.adoc @@ -15,7 +15,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -40,35 +40,35 @@ Simulate firewall rules. This does not simulate kernel 'routing' table. Instead, this simply assumes that routing from source zone to destination zone is possible. -`-dest` `` :: +`--dest` `` :: Destination IP address. -`-dport` `` :: +`--dport` `` :: Destination port. -`-from` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `outside`):: +`--from` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `outside`):: Source zone. -`-protocol` `(tcp|udp)` ('default =' `tcp`):: +`--protocol` `(tcp|udp)` ('default =' `tcp`):: Protocol. -`-source` `` :: +`--source` `` :: Source IP address. -`-sport` `` :: +`--sport` `` :: Source port. -`-to` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `host`):: +`--to` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `host`):: Destination zone. -`-verbose` `` ('default =' `0`):: +`--verbose` `` ('default =' `0`):: Verbose output. @@ -78,7 +78,7 @@ Verbose output. Start the Proxmox VE firewall service. -`-debug` `` ('default =' `0`):: +`--debug` `` ('default =' `0`):: Debug mode - stay in foreground diff --git a/pve-ha-crm.8-synopsis.adoc b/pve-ha-crm.8-synopsis.adoc index 81ffb25..8a18e8a 100644 --- a/pve-ha-crm.8-synopsis.adoc +++ b/pve-ha-crm.8-synopsis.adoc @@ -8,7 +8,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -19,7 +19,7 @@ Verbose output format. Start the daemon. -`-debug` `` ('default =' `0`):: +`--debug` `` ('default =' `0`):: Debug mode - stay in foreground diff --git a/pve-ha-lrm.8-synopsis.adoc b/pve-ha-lrm.8-synopsis.adoc index c80bc9b..c2723d6 100644 --- a/pve-ha-lrm.8-synopsis.adoc +++ b/pve-ha-lrm.8-synopsis.adoc @@ -8,7 +8,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -19,7 +19,7 @@ Verbose output format. Start the daemon. -`-debug` `` ('default =' `0`):: +`--debug` `` ('default =' `0`):: Debug mode - stay in foreground diff --git a/pveam.1-synopsis.adoc b/pveam.1-synopsis.adoc index 3ba260c..abeb107 100644 --- a/pveam.1-synopsis.adoc +++ b/pveam.1-synopsis.adoc @@ -4,7 +4,7 @@ List available templates. -`-section` `` :: +`--section` `` :: Restrict list to specified section. @@ -34,7 +34,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index a1ee3ee..37d8117 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -1,8 +1,26 @@ *pveceph* ` [ARGS] [OPTIONS]` -*pveceph createmon* +*pveceph createmgr* `[OPTIONS]` -Create Ceph Monitor +Create Ceph Manager + +`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: + +The ID for the manager, when omitted the same as the nodename + + + +*pveceph createmon* `[OPTIONS]` + +Create Ceph Monitor and Manager + +`--exclude-manager` `` ('default =' `0`):: + +When set, only a monitor will be created. + +`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: + +The ID for the monitor, when omitted the same as the nodename @@ -15,17 +33,21 @@ Create OSD Block device name. -`-bluestore` `` ('default =' `0`):: +`--bluestore` `` ('default =' `0`):: Use bluestore instead of filestore. -`-fstype` `` ('default =' `xfs`):: +`--fstype` `` ('default =' `xfs`):: File system type (filestore only). -`-journal_dev` `` :: +`--journal_dev` `` :: -Block device name for journal. +Block device name for journal (filestore) or block.db (bluestore). + +`--wal_dev` `` :: + +Block device name for block.wal (bluestore only). @@ -38,32 +60,54 @@ Create POOL The name of the pool. It must be unique. -`-crush_ruleset` ` (0 - 32768)` ('default =' `0`):: +`--add_storages` `` :: + +Configure VM and CT storages using the new pool. -The ruleset to use for mapping object placement in the cluster. +`--application` `` :: -`-min_size` ` (1 - 7)` ('default =' `1`):: +The application of the pool, 'rbd' by default. + +`--crush_rule` `` :: + +The rule to use for mapping object placement in the cluster. + +`--min_size` ` (1 - 7)` ('default =' `2`):: Minimum number of replicas per object -`-pg_num` ` (8 - 32768)` ('default =' `64`):: +`--pg_num` ` (8 - 32768)` ('default =' `64`):: Number of placement groups. -`-size` ` (1 - 7)` ('default =' `2`):: +`--size` ` (1 - 7)` ('default =' `3`):: Number of replicas per object -*pveceph destroymon* `` +*pveceph destroymgr* `` + +Destroy Ceph Manager. + +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: + +The ID of the manager + -Destroy Ceph monitor. -``: `` :: +*pveceph destroymon* `` `[OPTIONS]` + +Destroy Ceph Monitor and Manager. + +``: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` :: Monitor ID +`--exclude-manager` `` ('default =' `0`):: + +When set, removes only the monitor, not the manager + @@ -75,7 +119,7 @@ Destroy OSD OSD ID -`-cleanup` `` ('default =' `0`):: +`--cleanup` `` ('default =' `0`):: If set, we remove partition table entries. @@ -90,10 +134,14 @@ Destroy pool The name of the pool. It must be unique. -`-force` `` ('default =' `0`):: +`--force` `` ('default =' `0`):: If true, destroys pool even if in use +`--remove_storages` `` ('default =' `0`):: + +Remove all pveceph-managed storages configured for this pool + @@ -105,7 +153,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -116,27 +164,27 @@ Verbose output format. Create initial ceph default configuration and setup symlinks. -`-disable_cephx` `` ('default =' `0`):: +`--disable_cephx` `` ('default =' `0`):: Disable cephx authentification. + WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private! -`-min_size` ` (1 - 7)` ('default =' `2`):: +`--min_size` ` (1 - 7)` ('default =' `2`):: Minimum number of available replicas per object to allow I/O -`-network` `` :: +`--network` `` :: Use specific network for all ceph related traffic -`-pg_bits` ` (6 - 14)` ('default =' `6`):: +`--pg_bits` ` (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 default pools. -`-size` ` (1 - 7)` ('default =' `3`):: +`--size` ` (1 - 7)` ('default =' `3`):: Targeted number of replicas per object @@ -147,7 +195,7 @@ Targeted number of replicas per object Install ceph related packages. -`-version` `` :: +`--version` `` :: no description available @@ -172,7 +220,7 @@ Destroy ceph related data and configuration files. Start ceph services. -``: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` :: Ceph service name. @@ -188,7 +236,7 @@ Get ceph status. Stop ceph services. -``: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` :: +``: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` :: Ceph service name. diff --git a/pvecm.1-synopsis.adoc b/pvecm.1-synopsis.adoc index 9ff6232..49d3cdf 100644 --- a/pvecm.1-synopsis.adoc +++ b/pvecm.1-synopsis.adoc @@ -8,23 +8,23 @@ Adds the current node to an existing cluster. Hostname (or IP) of an existing cluster member. -`-force` `` :: +`--force` `` :: Do not throw error if node already exists. -`-nodeid` ` (1 - N)` :: +`--nodeid` ` (1 - N)` :: Node id for this node. -`-ring0_addr` `` :: +`--ring0_addr` `` :: Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname. -`-ring1_addr` `` :: +`--ring1_addr` `` :: Hostname (or IP) of the corosync ring1 address, this needs an valid configured ring 1 interface in the cluster. -`-votes` ` (0 - N)` :: +`--votes` ` (0 - N)` :: Number of votes for this node @@ -38,23 +38,23 @@ Adds a node to the cluster configuration. The cluster node name. -`-force` `` :: +`--force` `` :: Do not throw error if node already exists. -`-nodeid` ` (1 - N)` :: +`--nodeid` ` (1 - N)` :: Node id for this node. -`-ring0_addr` `` :: +`--ring0_addr` `` :: Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname. -`-ring1_addr` `` :: +`--ring1_addr` `` :: Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr. -`-votes` ` (0 - N)` :: +`--votes` ` (0 - N)` :: Number of votes for this node @@ -68,27 +68,27 @@ Generate new cluster configuration. The name of the cluster. -`-bindnet0_addr` `` :: +`--bindnet0_addr` `` :: This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node. -`-bindnet1_addr` `` :: +`--bindnet1_addr` `` :: This specifies the network address the corosync ring 1 executive should bind to and is optional. -`-nodeid` ` (1 - N)` :: +`--nodeid` ` (1 - N)` :: Node id for this node. -`-ring0_addr` `` :: +`--ring0_addr` `` :: Hostname (or IP) of the corosync ring0 address of this node. Defaults to the hostname of the node. -`-ring1_addr` `` :: +`--ring1_addr` `` :: Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr. -`-votes` ` (1 - N)` :: +`--votes` ` (1 - N)` :: Number of votes for this node. @@ -123,7 +123,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -148,15 +148,15 @@ Used by VM/CT migration - do not use manually. Extra arguments as array -`-get_migration_ip` `` ('default =' `0`):: +`--get_migration_ip` `` ('default =' `0`):: return the migration IP, if configured -`-migration_network` `` :: +`--migration_network` `` :: the migration network used to detect the local migration IP -`-run-command` `` :: +`--run-command` `` :: Run a command with a tcp socket as standard input. The IP address and port are printed via this command's stdandard output first, each on a separate line. @@ -178,11 +178,11 @@ Displays the local view of the cluster status. Update node certificates (and generate all needed files/directories). -`-force` `` :: +`--force` `` :: Force generation of new SSL certifate. -`-silent` `` :: +`--silent` `` :: Ignore errors (i.e. when cluster has no quorum). diff --git a/pvedaemon.8-synopsis.adoc b/pvedaemon.8-synopsis.adoc index 1ad5ee2..23d1427 100644 --- a/pvedaemon.8-synopsis.adoc +++ b/pvedaemon.8-synopsis.adoc @@ -8,7 +8,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -25,7 +25,7 @@ Restart the daemon (or start if not running). Start the daemon. -`-debug` `` ('default =' `0`):: +`--debug` `` ('default =' `0`):: Debug mode - stay in foreground diff --git a/pveproxy.8-synopsis.adoc b/pveproxy.8-synopsis.adoc index 90ebadc..b602200 100644 --- a/pveproxy.8-synopsis.adoc +++ b/pveproxy.8-synopsis.adoc @@ -8,7 +8,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -25,7 +25,7 @@ Restart the daemon (or start if not running). Start the daemon. -`-debug` `` ('default =' `0`):: +`--debug` `` ('default =' `0`):: Debug mode - stay in foreground diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index df90d7c..326c603 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -12,147 +12,147 @@ Storage type. The storage identifier. -`-authsupported` `` :: +`--authsupported` `` :: Authsupported. -`-base` `` :: +`--base` `` :: Base volume. This volume is automatically activated. -`-blocksize` `` :: +`--blocksize` `` :: block size -`-comstar_hg` `` :: +`--comstar_hg` `` :: host group for comstar views -`-comstar_tg` `` :: +`--comstar_tg` `` :: target group for comstar views -`-content` `` :: +`--content` `` :: Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. -`-disable` `` :: +`--disable` `` :: Flag to disable the storage. -`-export` `` :: +`--export` `` :: NFS export path. -`-format` `` :: +`--format` `` :: Default image format. -`-is_mountpoint` `` ('default =' `no`):: +`--is_mountpoint` `` ('default =' `no`):: -Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. +Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. -`-iscsiprovider` `` :: +`--iscsiprovider` `` :: iscsi provider -`-krbd` `` :: +`--krbd` `` :: Access rbd through krbd kernel module. -`-maxfiles` ` (0 - N)` :: +`--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. -`-mkdir` `` ('default =' `yes`):: +`--mkdir` `` ('default =' `yes`):: Create the directory if it doesn't exist. -`-monhost` `` :: +`--monhost` `` :: -Monitors daemon ips. +IP addresses of monitors (for external clusters). -`-nodes` `` :: +`--nodes` `` :: List of cluster node names. -`-nowritecache` `` :: +`--nowritecache` `` :: disable write caching on the target -`-options` `` :: +`--options` `` :: NFS mount options (see 'man nfs') -`-path` `` :: +`--path` `` :: File system path. -`-pool` `` :: +`--pool` `` :: Pool. -`-portal` `` :: +`--portal` `` :: iSCSI portal (IP or DNS name with optional port). -`-redundancy` ` (1 - 16)` ('default =' `2`):: +`--redundancy` ` (1 - 16)` ('default =' `2`):: The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster. -`-saferemove` `` :: +`--saferemove` `` :: Zero-out data when removing LVs. -`-saferemove_throughput` `` :: +`--saferemove_throughput` `` :: Wipe throughput (cstream -t parameter value). -`-server` `` :: +`--server` `` :: Server IP or DNS name. -`-server2` `` :: +`--server2` `` :: Backup volfile server IP or DNS name. + NOTE: Requires option(s): `server` -`-shared` `` :: +`--shared` `` :: Mark storage as shared. -`-sparse` `` :: +`--sparse` `` :: use sparse volumes -`-tagged_only` `` :: +`--tagged_only` `` :: Only use logical volumes tagged with 'pve-vm-ID'. -`-target` `` :: +`--target` `` :: iSCSI target. -`-thinpool` `` :: +`--thinpool` `` :: LVM thin pool LV name. -`-transport` `` :: +`--transport` `` :: Gluster transport: tcp or rdma -`-username` `` :: +`--username` `` :: RBD Id. -`-vgname` `` :: +`--vgname` `` :: Volume group name. -`-volume` `` :: +`--volume` `` :: Glusterfs Volume. @@ -179,7 +179,7 @@ The name of the file to create. Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) -`-format` `` :: +`--format` `` :: no description available + @@ -204,15 +204,15 @@ Export stream format Destination file name -`-base` `(?^:[a-z0-9_\-]{1,40})` :: +`--base` `(?^:[a-z0-9_\-]{1,40})` :: Snapshot to start an incremental stream from -`-snapshot` `(?^:[a-z0-9_\-]{1,40})` :: +`--snapshot` `(?^:[a-z0-9_\-]{1,40})` :: Snapshot to export -`-with-snapshots` `` ('default =' `0`):: +`--with-snapshots` `` ('default =' `0`):: Whether to include intermediate snapshots in the stream @@ -237,7 +237,7 @@ Delete volume Volume identifier -`-storage` `` :: +`--storage` `` :: The storage identifier. @@ -263,7 +263,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -286,26 +286,26 @@ Import stream format Source file name -`-base` `(?^:[a-z0-9_\-]{1,40})` :: +`--base` `(?^:[a-z0-9_\-]{1,40})` :: Base snapshot of an incremental stream -`-delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` :: +`--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` :: A snapshot to delete on success -`-with-snapshots` `` ('default =' `0`):: +`--with-snapshots` `` ('default =' `0`):: Whether the stream includes intermediate snapshots -*pvesm iscsiscan* `-portal ` `[OPTIONS]` +*pvesm iscsiscan* `--portal ` `[OPTIONS]` Scan remote iSCSI server. -`-portal` `` :: +`--portal` `` :: no description available @@ -320,11 +320,11 @@ List storage content. The storage identifier. -`-content` `` :: +`--content` `` :: Only list content of this type. -`-vmid` ` (1 - N)` :: +`--vmid` ` (1 - N)` :: Only list images for this VM @@ -387,111 +387,115 @@ Update storage configuration. The storage identifier. -`-blocksize` `` :: +`--blocksize` `` :: block size -`-comstar_hg` `` :: +`--comstar_hg` `` :: host group for comstar views -`-comstar_tg` `` :: +`--comstar_tg` `` :: target group for comstar views -`-content` `` :: +`--content` `` :: Allowed content types. + NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-disable` `` :: +`--disable` `` :: Flag to disable the storage. -`-format` `` :: +`--format` `` :: Default image format. -`-is_mountpoint` `` ('default =' `no`):: +`--is_mountpoint` `` ('default =' `no`):: -Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline. +Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. -`-krbd` `` :: +`--krbd` `` :: Access rbd through krbd kernel module. -`-maxfiles` ` (0 - N)` :: +`--maxfiles` ` (0 - N)` :: Maximal number of backup files per VM. Use '0' for unlimted. -`-mkdir` `` ('default =' `yes`):: +`--mkdir` `` ('default =' `yes`):: Create the directory if it doesn't exist. -`-nodes` `` :: +`--monhost` `` :: + +IP addresses of monitors (for external clusters). + +`--nodes` `` :: List of cluster node names. -`-nowritecache` `` :: +`--nowritecache` `` :: disable write caching on the target -`-options` `` :: +`--options` `` :: NFS mount options (see 'man nfs') -`-pool` `` :: +`--pool` `` :: Pool. -`-redundancy` ` (1 - 16)` ('default =' `2`):: +`--redundancy` ` (1 - 16)` ('default =' `2`):: The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster. -`-saferemove` `` :: +`--saferemove` `` :: Zero-out data when removing LVs. -`-saferemove_throughput` `` :: +`--saferemove_throughput` `` :: Wipe throughput (cstream -t parameter value). -`-server` `` :: +`--server` `` :: Server IP or DNS name. -`-server2` `` :: +`--server2` `` :: Backup volfile server IP or DNS name. + NOTE: Requires option(s): `server` -`-shared` `` :: +`--shared` `` :: Mark storage as shared. -`-sparse` `` :: +`--sparse` `` :: use sparse volumes -`-tagged_only` `` :: +`--tagged_only` `` :: Only use logical volumes tagged with 'pve-vm-ID'. -`-transport` `` :: +`--transport` `` :: Gluster transport: tcp or rdma -`-username` `` :: +`--username` `` :: RBD Id. @@ -502,19 +506,19 @@ RBD Id. Get status for all datastores. -`-content` `` :: +`--content` `` :: Only list stores which support this content type. -`-enabled` `` ('default =' `0`):: +`--enabled` `` ('default =' `0`):: Only list stores which are enabled (not disabled in config). -`-storage` `` :: +`--storage` `` :: Only list status for specified storage -`-target` `` :: +`--target` `` :: If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. diff --git a/pvesr.1-synopsis.adoc b/pvesr.1-synopsis.adoc index 4363b9d..5ad776e 100644 --- a/pvesr.1-synopsis.adoc +++ b/pvesr.1-synopsis.adoc @@ -12,23 +12,23 @@ Replication Job ID. The ID is composed of a Guest ID and a job number, separated Target node. -`-comment` `` :: +`--comment` `` :: Description. -`-disable` `` :: +`--disable` `` :: Flag to disable/deactivate the entry. -`-rate` ` (1 - N)` :: +`--rate` ` (1 - N)` :: Rate limit in mbps (megabytes per second) as floating point number. -`-remove_job` `` :: +`--remove_job` `` :: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. -`-schedule` `` ('default =' `*/15`):: +`--schedule` `` ('default =' `*/15`):: Storage replication schedule. The format is a subset of `systemd` calender events. @@ -42,11 +42,11 @@ Mark replication job for removal. Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. -`-force` `` ('default =' `0`):: +`--force` `` ('default =' `0`):: Will remove the jobconfig entry, but will not cleanup. -`-keep` `` ('default =' `0`):: +`--keep` `` ('default =' `0`):: Keep replicated data at target (do not remove). @@ -86,7 +86,7 @@ Replication Job ID. The ID is composed of a Guest ID and a job number, separated The list of volume IDs to consider. -`-last_sync` ` (0 - N)` :: +`--last_sync` ` (0 - N)` :: Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots gets removed. @@ -101,7 +101,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -134,19 +134,19 @@ Replication Job ID. The ID is composed of a Guest ID and a job number, separated The list of volume IDs to consider. -`-force` `` ('default =' `0`):: +`--force` `` ('default =' `0`):: Allow to remove all existion volumes (empty volume list). -`-last_sync` ` (0 - N)` :: +`--last_sync` ` (0 - N)` :: Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots get removed. -`-parent_snapname` `` :: +`--parent_snapname` `` :: The name of the snapshot. -`-scan` `` :: +`--scan` `` :: List of storage IDs to scan for stale volumes. @@ -169,11 +169,11 @@ Replication Job ID. The ID is composed of a Guest ID and a job number, separated This method is called by the systemd-timer and executes all (or a specific) sync jobs. -`-id` `[1-9][0-9]{2,8}-\d{1,9}` :: +`--id` `[1-9][0-9]{2,8}-\d{1,9}` :: Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. -`-verbose` `` ('default =' `0`):: +`--verbose` `` ('default =' `0`):: Print more verbose logs to stdout. @@ -211,7 +211,7 @@ Job state as JSON decoded string. List status of all replication jobs on this node. -`-guest` ` (1 - N)` :: +`--guest` ` (1 - N)` :: Only list replication jobs for this guest. @@ -226,31 +226,31 @@ Update replication job configuration. Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. -`-comment` `` :: +`--comment` `` :: Description. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-disable` `` :: +`--disable` `` :: Flag to disable/deactivate the entry. -`-rate` ` (1 - N)` :: +`--rate` ` (1 - N)` :: Rate limit in mbps (megabytes per second) as floating point number. -`-remove_job` `` :: +`--remove_job` `` :: Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. -`-schedule` `` ('default =' `*/15`):: +`--schedule` `` ('default =' `*/15`):: Storage replication schedule. The format is a subset of `systemd` calender events. diff --git a/pvestatd.8-synopsis.adoc b/pvestatd.8-synopsis.adoc index 1dda4f4..6735a05 100644 --- a/pvestatd.8-synopsis.adoc +++ b/pvestatd.8-synopsis.adoc @@ -8,7 +8,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -25,7 +25,7 @@ Restart the daemon (or start if not running). Start the daemon. -`-debug` `` ('default =' `0`):: +`--debug` `` ('default =' `0`):: Debug mode - stay in foreground diff --git a/pvesubscription.1-synopsis.adoc b/pvesubscription.1-synopsis.adoc index 85feb32..371e83f 100644 --- a/pvesubscription.1-synopsis.adoc +++ b/pvesubscription.1-synopsis.adoc @@ -15,7 +15,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -26,7 +26,7 @@ Verbose output format. Set subscription key. -``: `` :: +``: `pve([124])([cbsp])-[0-9a-f]{10}` :: Proxmox VE subscription key @@ -36,7 +36,7 @@ Proxmox VE subscription key Update subscription info. -`-force` `` ('default =' `0`):: +`--force` `` ('default =' `0`):: Always connect to server, even if we have up to date info inside local cache. diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc index d9fbde6..6755db3 100644 --- a/pveum.1-synopsis.adoc +++ b/pveum.1-synopsis.adoc @@ -1,6 +1,6 @@ *pveum* ` [ARGS] [OPTIONS]` -*pveum acldel* ` -roles ` `[OPTIONS]` +*pveum acldel* ` --roles ` `[OPTIONS]` Update Access Control List (add or remove permissions). @@ -8,25 +8,25 @@ Update Access Control List (add or remove permissions). Access control path -`-groups` `` :: +`--groups` `` :: List of groups. -`-propagate` `` ('default =' `1`):: +`--propagate` `` ('default =' `1`):: Allow to propagate (inherit) permissions. -`-roles` `` :: +`--roles` `` :: List of roles. -`-users` `` :: +`--users` `` :: List of users. -*pveum aclmod* ` -roles ` `[OPTIONS]` +*pveum aclmod* ` --roles ` `[OPTIONS]` Update Access Control List (add or remove permissions). @@ -34,19 +34,19 @@ Update Access Control List (add or remove permissions). Access control path -`-groups` `` :: +`--groups` `` :: List of groups. -`-propagate` `` ('default =' `1`):: +`--propagate` `` ('default =' `1`):: Allow to propagate (inherit) permissions. -`-roles` `` :: +`--roles` `` :: List of roles. -`-users` `` :: +`--users` `` :: List of users. @@ -61,7 +61,7 @@ Create new group. no description available -`-comment` `` :: +`--comment` `` :: no description available @@ -85,7 +85,7 @@ Update group data. no description available -`-comment` `` :: +`--comment` `` :: no description available @@ -100,7 +100,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -126,7 +126,7 @@ Create new role. no description available -`-privs` `` :: +`--privs` `` :: no description available @@ -142,7 +142,7 @@ no description available -*pveum rolemod* ` -privs ` `[OPTIONS]` +*pveum rolemod* ` --privs ` `[OPTIONS]` Create new role. @@ -150,13 +150,13 @@ Create new role. no description available -`-append` `` :: +`--append` `` :: no description available + NOTE: Requires option(s): `privs` -`-privs` `` :: +`--privs` `` :: no description available @@ -171,23 +171,23 @@ Create or verify authentication ticket. User name -`-otp` `` :: +`--otp` `` :: One-time password for Two-factor authentication. -`-path` `` :: +`--path` `` :: Verify ticket, and check if user have access 'privs' on 'path' + NOTE: Requires option(s): `privs` -`-privs` `` :: +`--privs` `` :: Verify ticket, and check if user have access 'privs' on 'path' + NOTE: Requires option(s): `path` -`-realm` `` :: +`--realm` `` :: You can optionally pass the realm using this parameter. Normally the realm is simply added to the username @. @@ -202,39 +202,39 @@ Create new user. User ID -`-comment` `` :: +`--comment` `` :: no description available -`-email` `` :: +`--email` `` :: no description available -`-enable` `` ('default =' `1`):: +`--enable` `` ('default =' `1`):: Enable the account (default). You can set this to '0' to disable the accout -`-expire` ` (0 - N)` :: +`--expire` ` (0 - N)` :: Account expiration date (seconds since epoch). '0' means no expiration date. -`-firstname` `` :: +`--firstname` `` :: no description available -`-groups` `` :: +`--groups` `` :: no description available -`-keys` `` :: +`--keys` `` :: Keys for two factor auth (yubico). -`-lastname` `` :: +`--lastname` `` :: no description available -`-password` :: +`--password` :: Initial password. @@ -258,41 +258,41 @@ Update user configuration. User ID -`-append` `` :: +`--append` `` :: no description available + NOTE: Requires option(s): `groups` -`-comment` `` :: +`--comment` `` :: no description available -`-email` `` :: +`--email` `` :: no description available -`-enable` `` :: +`--enable` `` :: Enable/disable the account. -`-expire` ` (0 - N)` :: +`--expire` ` (0 - N)` :: Account expiration date (seconds since epoch). '0' means no expiration date. -`-firstname` `` :: +`--firstname` `` :: no description available -`-groups` `` :: +`--groups` `` :: no description available -`-keys` `` :: +`--keys` `` :: Keys for two factor auth (yubico). -`-lastname` `` :: +`--lastname` `` :: no description available diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index ff13c76..054436e 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -26,39 +26,39 @@ The (unique) ID of the VM. VMID for the clone. -`-description` `` :: +`--description` `` :: Description for the new VM. -`-format` `` :: +`--format` `` :: Target format for file storage. + NOTE: Requires option(s): `full` -`-full` `` ('default =' `0`):: +`--full` `` ('default =' `0`):: Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. -`-name` `` :: +`--name` `` :: Set a name for the new VM. -`-pool` `` :: +`--pool` `` :: Add the new VM to the specified pool. -`-snapname` `` :: +`--snapname` `` :: The name of the snapshot. -`-storage` `` :: +`--storage` `` :: Target storage for full clone. + NOTE: Requires option(s): `full` -`-target` `` :: +`--target` `` :: Target node. Only allowed if the original VM is on shared storage. @@ -73,7 +73,7 @@ configuration changes (see 'pending' API). The (unique) ID of the VM. -`-current` `` ('default =' `0`):: +`--current` `` ('default =' `0`):: Get current values (instead of pending values). @@ -87,251 +87,255 @@ Create or restore a virtual machine. The (unique) ID of the VM. -`-acpi` `` ('default =' `1`):: +`--acpi` `` ('default =' `1`):: Enable/disable ACPI. -`-agent` `` ('default =' `0`):: +`--agent` `` ('default =' `0`):: Enable/disable Qemu GuestAgent. -`-archive` `` :: +`--archive` `` :: The backup file. -`-args` `` :: +`--args` `` :: Arbitrary arguments passed to kvm. -`-autostart` `` ('default =' `0`):: +`--autostart` `` ('default =' `0`):: Automatic restart after crash (currently ignored). -`-balloon` ` (0 - N)` :: +`--balloon` ` (0 - N)` :: Amount of target RAM for the VM in MB. Using zero disables the ballon driver. -`-bios` `` ('default =' `seabios`):: +`--bios` `` ('default =' `seabios`):: Select BIOS implementation. -`-boot` `[acdn]{1,4}` ('default =' `cdn`):: +`--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+` :: +`--bootdisk` `(ide|sata|scsi|virtio)\d+` :: Enable booting from specified disk. -`-cdrom` `` :: +`--cdrom` `` :: This is an alias for option -ide2 -`-cores` ` (1 - N)` ('default =' `1`):: +`--cores` ` (1 - N)` ('default =' `1`):: The number of cores per socket. -`-cpu` `[cputype=] [,hidden=<1|0>]` :: +`--cpu` `[cputype=] [,hidden=<1|0>]` :: Emulated CPU type. -`-cpulimit` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. -`-cpuunits` ` (0 - 500000)` ('default =' `1024`):: +`--cpuunits` ` (2 - 262144)` ('default =' `1024`):: CPU weight for a VM. -`-description` `` :: +`--description` `` :: Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. -`-efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,format=] [,size=]` :: Configure a Disk for storing EFI vars -`-force` `` :: +`--force` `` :: Allow to overwrite existing VM. + NOTE: Requires option(s): `archive` -`-freeze` `` :: +`--freeze` `` :: Freeze CPU at startup (use 'c' monitor command to start execution). -`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. -`-hotplug` `` ('default =' `network,disk,usb`):: +`--hotplug` `` ('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'. -`-hugepages` `<1024 | 2 | any>` :: +`--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`-ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). -`-keyboard` `` ('default =' `en-us`):: +`--keyboard` `` ('default =' `en-us`):: Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file. -`-kvm` `` ('default =' `1`):: +`--kvm` `` ('default =' `1`):: Enable/disable KVM hardware virtualization. -`-localtime` `` :: +`--localtime` `` :: Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. -`-lock` `` :: +`--lock` `` :: Lock/unlock the VM. -`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: Specific the Qemu machine type. -`-memory` ` (16 - N)` ('default =' `512`):: +`--memory` ` (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` ` (0 - N)` ('default =' `0.1`):: +`--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: Set maximum tolerated downtime (in seconds) for migrations. -`-migrate_speed` ` (0 - N)` ('default =' `0`):: +`--migrate_speed` ` (0 - N)` ('default =' `0`):: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. -`-name` `` :: +`--name` `` :: Set a name for the VM. Only used on the configuration web interface. -`-net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: +`--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: Specify network devices. -`-numa` `` ('default =' `0`):: +`--numa` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: NUMA topology. -`-onboot` `` ('default =' `0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `` :: +`--ostype` `` :: Specify guest operating system. -`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: +`--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: Map host parallel devices (n is 0 to 2). -`-pool` `` :: +`--pool` `` :: Add the VM to the specified pool. -`-protection` `` ('default =' `0`):: +`--protection` `` ('default =' `0`):: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. -`-reboot` `` ('default =' `1`):: +`--reboot` `` ('default =' `1`):: Allow reboot. If set to '0' the VM exit on reboot. -`-sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,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). -`-scsihw` `` ('default =' `lsi`):: +`--scsihw` `` ('default =' `lsi`):: SCSI controller model -`-serial[n]` `(/dev/.+|socket)` :: +`--serial[n]` `(/dev/.+|socket)` :: Create a serial device inside the VM (n is 0 to 3) -`-shares` ` (0 - 50000)` ('default =' `1000`):: +`--shares` ` (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 -`-smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: Specify SMBIOS type 1 fields. -`-smp` ` (1 - N)` ('default =' `1`):: +`--smp` ` (1 - N)` ('default =' `1`):: The number of CPUs. Please use option -sockets instead. -`-sockets` ` (1 - N)` ('default =' `1`):: +`--sockets` ` (1 - N)` ('default =' `1`):: The number of CPU sockets. -`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: +`--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` `[[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. -`-storage` `` :: +`--storage` `` :: Default storage. -`-tablet` `` ('default =' `1`):: +`--tablet` `` ('default =' `1`):: Enable/disable the USB tablet device. -`-tdf` `` ('default =' `0`):: +`--tdf` `` ('default =' `0`):: Enable/disable time drift fix. -`-template` `` ('default =' `0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-unique` `` :: +`--unique` `` :: Assign a unique random ethernet address. + NOTE: Requires option(s): `archive` -`-unused[n]` `` :: +`--unused[n]` `` :: Reference to unused volumes. This is used internally, and should not be modified manually. -`-usb[n]` `[host=] [,usb3=<1|0>]` :: +`--usb[n]` `[host=] [,usb3=<1|0>]` :: Configure an USB device (n is 0 to 4). -`-vcpus` ` (1 - N)` ('default =' `0`):: +`--vcpus` ` (1 - N)` ('default =' `0`):: Number of hotplugged vcpus. -`-vga` `` :: +`--vga` `` :: Select the VGA type. -`-virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as VIRTIO hard disk (n is 0 to 15). -`-watchdog` `[[model=]] [,action=]` :: +`--vmstatestorage` `` :: + +Default storage for VM state volumes/files. + +`--watchdog` `[[model=]] [,action=]` :: Create a virtual hardware watchdog device. @@ -349,7 +353,7 @@ The (unique) ID of the VM. The name of the snapshot. -`-force` `` :: +`--force` `` :: For removal from config file, even if removing disk snapshots fails. @@ -363,7 +367,7 @@ Destroy the vm (also delete all used/owned volumes). The (unique) ID of the VM. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -378,7 +382,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -402,7 +406,33 @@ Path to the disk image to import Target storage ID -`-format` `` :: +`--format` `` :: + +Target format + + + +*qm importovf* ` ` `[OPTIONS]` + +Create a new VM using parameters read from an OVF manifest + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +path to the ovf file + +``: `` :: + +Target storage ID + +`--dryrun` `` :: + +Print a parsed representation of the extracted OVF parameters, but do not create a VM + +`--format` `` :: Target format @@ -413,7 +443,7 @@ Target format Virtual machine index (per node). -`-full` `` :: +`--full` `` :: Determine the full status of active VMs. @@ -441,27 +471,27 @@ The (unique) ID of the VM. Target node. -`-force` `` :: +`--force` `` :: Allow to migrate VMs which use local devices. Only root may use this option. -`-migration_network` `` :: +`--migration_network` `` :: CIDR of the (sub) network that is used for migration. -`-migration_type` `` :: +`--migration_type` `` :: Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. -`-online` `` :: +`--online` `` :: Use online/live migration. -`-targetstorage` `` :: +`--targetstorage` `` :: Default target storage. -`-with-local-disks` `` :: +`--with-local-disks` `` :: Enable live storage migration for local disk @@ -495,15 +525,15 @@ The disk you want to move. Target storage. -`-delete` `` ('default =' `0`):: +`--delete` `` ('default =' `0`):: Delete the original disk after successful copy. By default the original disk is kept as unused disk. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-format` `` :: +`--format` `` :: Target Format. @@ -542,7 +572,7 @@ The (unique) ID of the VM. Rescan all storages and update disk sizes and unused disk images. -`-vmid` ` (1 - N)` :: +`--vmid` ` (1 - N)` :: The (unique) ID of the VM. @@ -557,7 +587,7 @@ Reset virtual machine. The (unique) ID of the VM. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -579,11 +609,11 @@ The disk you want to resize. The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -597,11 +627,11 @@ Resume virtual machine. The (unique) ID of the VM. -`-nocheck` `` :: +`--nocheck` `` :: no description available -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -633,7 +663,7 @@ The (unique) ID of the VM. The key (qemu monitor encoding). -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -649,249 +679,253 @@ allocation. The (unique) ID of the VM. -`-acpi` `` ('default =' `1`):: +`--acpi` `` ('default =' `1`):: Enable/disable ACPI. -`-agent` `` ('default =' `0`):: +`--agent` `` ('default =' `0`):: Enable/disable Qemu GuestAgent. -`-args` `` :: +`--args` `` :: Arbitrary arguments passed to kvm. -`-autostart` `` ('default =' `0`):: +`--autostart` `` ('default =' `0`):: Automatic restart after crash (currently ignored). -`-balloon` ` (0 - N)` :: +`--balloon` ` (0 - N)` :: Amount of target RAM for the VM in MB. Using zero disables the ballon driver. -`-bios` `` ('default =' `seabios`):: +`--bios` `` ('default =' `seabios`):: Select BIOS implementation. -`-boot` `[acdn]{1,4}` ('default =' `cdn`):: +`--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+` :: +`--bootdisk` `(ide|sata|scsi|virtio)\d+` :: Enable booting from specified disk. -`-cdrom` `` :: +`--cdrom` `` :: This is an alias for option -ide2 -`-cores` ` (1 - N)` ('default =' `1`):: +`--cores` ` (1 - N)` ('default =' `1`):: The number of cores per socket. -`-cpu` `[cputype=] [,hidden=<1|0>]` :: +`--cpu` `[cputype=] [,hidden=<1|0>]` :: Emulated CPU type. -`-cpulimit` ` (0 - 128)` ('default =' `0`):: +`--cpulimit` ` (0 - 128)` ('default =' `0`):: Limit of CPU usage. -`-cpuunits` ` (0 - 500000)` ('default =' `1024`):: +`--cpuunits` ` (2 - 262144)` ('default =' `1024`):: CPU weight for a VM. -`-delete` `` :: +`--delete` `` :: A list of settings you want to delete. -`-description` `` :: +`--description` `` :: Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file. -`-digest` `` :: +`--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. -`-efidisk0` `[file=] [,format=] [,size=]` :: +`--efidisk0` `[file=] [,format=] [,size=]` :: Configure a Disk for storing EFI vars -`-force` `` :: +`--force` `` :: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. + NOTE: Requires option(s): `delete` -`-freeze` `` :: +`--freeze` `` :: Freeze CPU at startup (use 'c' monitor command to start execution). -`-hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: +`--hostpci[n]` `[host=] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=] [,x-vga=<1|0>]` :: Map host PCI devices into guest. -`-hotplug` `` ('default =' `network,disk,usb`):: +`--hotplug` `` ('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'. -`-hugepages` `<1024 | 2 | any>` :: +`--hugepages` `<1024 | 2 | any>` :: Enable/disable hugepages memory. -`-ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--ide[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,model=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as IDE hard disk or CD-ROM (n is 0 to 3). -`-keyboard` `` ('default =' `en-us`):: +`--keyboard` `` ('default =' `en-us`):: Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file. -`-kvm` `` ('default =' `1`):: +`--kvm` `` ('default =' `1`):: Enable/disable KVM hardware virtualization. -`-localtime` `` :: +`--localtime` `` :: Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS. -`-lock` `` :: +`--lock` `` :: Lock/unlock the VM. -`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: Specific the Qemu machine type. -`-memory` ` (16 - N)` ('default =' `512`):: +`--memory` ` (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` ` (0 - N)` ('default =' `0.1`):: +`--migrate_downtime` ` (0 - N)` ('default =' `0.1`):: Set maximum tolerated downtime (in seconds) for migrations. -`-migrate_speed` ` (0 - N)` ('default =' `0`):: +`--migrate_speed` ` (0 - N)` ('default =' `0`):: Set maximum speed (in MB/s) for migrations. Value 0 is no limit. -`-name` `` :: +`--name` `` :: Set a name for the VM. Only used on the configuration web interface. -`-net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: +`--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: Specify network devices. -`-numa` `` ('default =' `0`):: +`--numa` `` ('default =' `0`):: Enable/disable NUMA. -`-numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: +`--numa[n]` `cpus= [,hostnodes=] [,memory=] [,policy=]` :: NUMA topology. -`-onboot` `` ('default =' `0`):: +`--onboot` `` ('default =' `0`):: Specifies whether a VM will be started during system bootup. -`-ostype` `` :: +`--ostype` `` :: Specify guest operating system. -`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: +`--parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: Map host parallel devices (n is 0 to 2). -`-protection` `` ('default =' `0`):: +`--protection` `` ('default =' `0`):: Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. -`-reboot` `` ('default =' `1`):: +`--reboot` `` ('default =' `1`):: Allow reboot. If set to '0' the VM exit on reboot. -`-revert` `` :: +`--revert` `` :: Revert a pending change. -`-sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--sata[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: 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_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,scsiblock=<1|0>] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--scsi[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,queues=] [,replicate=<1|0>] [,rerror=] [,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). -`-scsihw` `` ('default =' `lsi`):: +`--scsihw` `` ('default =' `lsi`):: SCSI controller model -`-serial[n]` `(/dev/.+|socket)` :: +`--serial[n]` `(/dev/.+|socket)` :: Create a serial device inside the VM (n is 0 to 3) -`-shares` ` (0 - 50000)` ('default =' `1000`):: +`--shares` ` (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 -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: +`--smbios1` `[family=] [,manufacturer=] [,product=] [,serial=] [,sku=] [,uuid=] [,version=]` :: Specify SMBIOS type 1 fields. -`-smp` ` (1 - N)` ('default =' `1`):: +`--smp` ` (1 - N)` ('default =' `1`):: The number of CPUs. Please use option -sockets instead. -`-sockets` ` (1 - N)` ('default =' `1`):: +`--sockets` ` (1 - N)` ('default =' `1`):: The number of CPU sockets. -`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` ('default =' `now`):: +`--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` `[[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` `` ('default =' `1`):: +`--tablet` `` ('default =' `1`):: Enable/disable the USB tablet device. -`-tdf` `` ('default =' `0`):: +`--tdf` `` ('default =' `0`):: Enable/disable time drift fix. -`-template` `` ('default =' `0`):: +`--template` `` ('default =' `0`):: Enable/disable Template. -`-unused[n]` `` :: +`--unused[n]` `` :: Reference to unused volumes. This is used internally, and should not be modified manually. -`-usb[n]` `[host=] [,usb3=<1|0>]` :: +`--usb[n]` `[host=] [,usb3=<1|0>]` :: Configure an USB device (n is 0 to 4). -`-vcpus` ` (1 - N)` ('default =' `0`):: +`--vcpus` ` (1 - N)` ('default =' `0`):: Number of hotplugged vcpus. -`-vga` `` :: +`--vga` `` :: Select the VGA type. -`-virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: +`--virtio[n]` `[file=] [,aio=] [,backup=<1|0>] [,bps=] [,bps_max_length=] [,bps_rd=] [,bps_rd_max_length=] [,bps_wr=] [,bps_wr_max_length=] [,cache=] [,cyls=] [,detect_zeroes=<1|0>] [,discard=] [,format=] [,heads=] [,iops=] [,iops_max=] [,iops_max_length=] [,iops_rd=] [,iops_rd_max=] [,iops_rd_max_length=] [,iops_wr=] [,iops_wr_max=] [,iops_wr_max_length=] [,iothread=<1|0>] [,mbps=] [,mbps_max=] [,mbps_rd=] [,mbps_rd_max=] [,mbps_wr=] [,mbps_wr_max=] [,media=] [,replicate=<1|0>] [,rerror=] [,secs=] [,serial=] [,size=] [,snapshot=<1|0>] [,trans=] [,werror=]` :: Use volume as VIRTIO hard disk (n is 0 to 15). -`-watchdog` `[[model=]] [,action=]` :: +`--vmstatestorage` `` :: + +Default storage for VM state volumes/files. + +`--watchdog` `[[model=]] [,action=]` :: Create a virtual hardware watchdog device. @@ -919,19 +953,19 @@ should then proceed to a clean shutdown. The (unique) ID of the VM. -`-forceStop` `` ('default =' `0`):: +`--forceStop` `` ('default =' `0`):: Make sure the VM stops. -`-keepActive` `` ('default =' `0`):: +`--keepActive` `` ('default =' `0`):: Do not deactivate storage volumes. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-timeout` ` (0 - N)` :: +`--timeout` ` (0 - N)` :: Wait maximal timeout seconds. @@ -949,11 +983,11 @@ The (unique) ID of the VM. The name of the snapshot. -`-description` `` :: +`--description` `` :: A textual description or comment. -`-vmstate` `` :: +`--vmstate` `` :: Save the vmstate @@ -967,31 +1001,31 @@ Start virtual machine. The (unique) ID of the VM. -`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: +`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: Specific the Qemu machine type. -`-migratedfrom` `` :: +`--migratedfrom` `` :: The cluster node name. -`-migration_network` `` :: +`--migration_network` `` :: CIDR of the (sub) network that is used for migration. -`-migration_type` `` :: +`--migration_type` `` :: Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-stateuri` `` :: +`--stateuri` `` :: Some command save/restore state from this location. -`-targetstorage` `` :: +`--targetstorage` `` :: Target storage for the migration. (Can be '1' to use the same storage id as on the source node.) @@ -1006,7 +1040,7 @@ Show VM status. The (unique) ID of the VM. -`-verbose` `` :: +`--verbose` `` :: Verbose output format @@ -1022,19 +1056,19 @@ to pulling the power plug of a running computer and may damage the VM data The (unique) ID of the VM. -`-keepActive` `` ('default =' `0`):: +`--keepActive` `` ('default =' `0`):: Do not deactivate storage volumes. -`-migratedfrom` `` :: +`--migratedfrom` `` :: The cluster node name. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. -`-timeout` ` (0 - N)` :: +`--timeout` ` (0 - N)` :: Wait maximal timeout seconds. @@ -1048,7 +1082,7 @@ Suspend virtual machine. The (unique) ID of the VM. -`-skiplock` `` :: +`--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -1062,7 +1096,7 @@ Create a Template. The (unique) ID of the VM. -`-disk` `` :: +`--disk` `` :: If you want to convert only 1 disk to base image. @@ -1078,14 +1112,14 @@ configured, for example 'serial0: socket') The (unique) ID of the VM. -`-iface` `` :: +`--iface` `` :: Select the serial device. By default we simply use the first suitable device. -*qm unlink* ` -idlist ` `[OPTIONS]` +*qm unlink* ` --idlist ` `[OPTIONS]` Unlink/delete disk images. @@ -1093,11 +1127,11 @@ Unlink/delete disk images. The (unique) ID of the VM. -`-force` `` :: +`--force` `` :: Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. -`-idlist` `` :: +`--idlist` `` :: A list of disk IDs you want to delete. @@ -1132,7 +1166,7 @@ Wait until the VM is stopped. The (unique) ID of the VM. -`-timeout` ` (1 - N)` :: +`--timeout` ` (1 - N)` :: Timeout in seconds. Default is to wait forever. diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index 65cccb6..77c912c 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -60,11 +60,9 @@ 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`: ` (0 - 500000)` ('default =' `1024`):: +`cpuunits`: ` (2 - 262144)` ('default =' `1024`):: 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`: `` :: @@ -1055,6 +1053,10 @@ Force disk geometry bios translation mode. Write error action. +`vmstatestorage`: `` :: + +Default storage for VM state volumes/files. + `watchdog`: `[[model=]] [,action=]` :: 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) diff --git a/qmrestore.1-synopsis.adoc b/qmrestore.1-synopsis.adoc index 1cafb41..425c01a 100644 --- a/qmrestore.1-synopsis.adoc +++ b/qmrestore.1-synopsis.adoc @@ -12,19 +12,19 @@ The backup file. You can pass '-' to read from standard input. The (unique) ID of the VM. -`-force` `` :: +`--force` `` :: Allow to overwrite existing VM. -`-pool` `` :: +`--pool` `` :: Add the VM to the specified pool. -`-storage` `` :: +`--storage` `` :: Default storage. -`-unique` `` :: +`--unique` `` :: Assign a unique random ethernet address. diff --git a/spiceproxy.8-synopsis.adoc b/spiceproxy.8-synopsis.adoc index 9078619..a62ccd7 100644 --- a/spiceproxy.8-synopsis.adoc +++ b/spiceproxy.8-synopsis.adoc @@ -8,7 +8,7 @@ Get help about specified command. Command name -`-verbose` `` :: +`--verbose` `` :: Verbose output format. @@ -25,7 +25,7 @@ Restart the daemon (or start if not running). Start the daemon. -`-debug` `` ('default =' `0`):: +`--debug` `` ('default =' `0`):: Debug mode - stay in foreground diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc index 39600b2..87642b1 100644 --- a/vzdump.1-synopsis.adoc +++ b/vzdump.1-synopsis.adoc @@ -8,99 +8,99 @@ Create backup. The ID of the guest system you want to backup. -`-all` `` ('default =' `0`):: +`--all` `` ('default =' `0`):: Backup all known guest systems on this host. -`-bwlimit` ` (0 - N)` ('default =' `0`):: +`--bwlimit` ` (0 - N)` ('default =' `0`):: Limit I/O bandwidth (KBytes per second). -`-compress` `<0 | 1 | gzip | lzo>` ('default =' `0`):: +`--compress` `<0 | 1 | gzip | lzo>` ('default =' `0`):: Compress dump file. -`-dumpdir` `` :: +`--dumpdir` `` :: Store resulting files to specified directory. -`-exclude` `` :: +`--exclude` `` :: Exclude specified guest systems (assumes --all) -`-exclude-path` `` :: +`--exclude-path` `` :: Exclude certain files/directories (shell globs). -`-ionice` ` (0 - 8)` ('default =' `7`):: +`--ionice` ` (0 - 8)` ('default =' `7`):: Set CFQ ionice priority. -`-lockwait` ` (0 - N)` ('default =' `180`):: +`--lockwait` ` (0 - N)` ('default =' `180`):: Maximal time to wait for the global lock (minutes). -`-mailnotification` `` ('default =' `always`):: +`--mailnotification` `` ('default =' `always`):: Specify when to send an email -`-mailto` `` :: +`--mailto` `` :: Comma-separated list of email addresses that should receive email notifications. -`-maxfiles` ` (1 - N)` ('default =' `1`):: +`--maxfiles` ` (1 - N)` ('default =' `1`):: Maximal number of backup files per guest system. -`-mode` `` ('default =' `snapshot`):: +`--mode` `` ('default =' `snapshot`):: Backup mode. -`-node` `` :: +`--node` `` :: Only run if executed on this node. -`-pigz` `` ('default =' `0`):: +`--pigz` `` ('default =' `0`):: Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. -`-quiet` `` ('default =' `0`):: +`--quiet` `` ('default =' `0`):: Be quiet. -`-remove` `` ('default =' `1`):: +`--remove` `` ('default =' `1`):: Remove old backup files if there are more than 'maxfiles' backup files. -`-script` `` :: +`--script` `` :: Use specified hook script. -`-size` ` (500 - N)` ('default =' `1024`):: +`--size` ` (500 - N)` ('default =' `1024`):: Unused, will be removed in a future release. -`-stdexcludes` `` ('default =' `1`):: +`--stdexcludes` `` ('default =' `1`):: Exclude temporary files and logs. -`-stdout` `` :: +`--stdout` `` :: Write tar to stdout, not to a file. -`-stop` `` ('default =' `0`):: +`--stop` `` ('default =' `0`):: Stop runnig backup jobs on this host. -`-stopwait` ` (0 - N)` ('default =' `10`):: +`--stopwait` ` (0 - N)` ('default =' `10`):: Maximal time to wait until a guest system is stopped (minutes). -`-storage` `` :: +`--storage` `` :: Store resulting file to this storage. -`-tmpdir` `` :: +`--tmpdir` `` :: Store temporary files to specified directory. -- 2.39.2