From: Dietmar Maurer Date: Mon, 12 Feb 2018 08:50:48 +0000 (+0100) Subject: update generated docs X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=35a75dd36c05f79e9dda81147867878a55d839c1 update generated docs --- diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index a6b3cca..6c6d9c0 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -3623,7 +3623,7 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "console" : { - "description" : "Select the default Console viewer. You can either use the builtin java applet (VNC), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC).", + "description" : "Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC).", "enum" : [ "applet", "vv", @@ -5853,17 +5853,24 @@ var pveapi = [ "486", "athlon", "Broadwell", + "Broadwell-IBRS", "Broadwell-noTSX", + "Broadwell-noTSX-IBRS", "Conroe", "core2duo", "coreduo", "Haswell", + "Haswell-IBRS", "Haswell-noTSX", + "Haswell-noTSX-IBRS", "host", "IvyBridge", + "IvyBridge-IBRS", "kvm32", "kvm64", + "max", "Nehalem", + "Nehalem-IBRS", "Opteron_G1", "Opteron_G2", "Opteron_G3", @@ -5877,11 +5884,23 @@ var pveapi = [ "qemu32", "qemu64", "SandyBridge", + "SandyBridge-IBRS", "Skylake-Client", - "Westmere" + "Skylake-Client-IBRS", + "Skylake-Server", + "Skylake-Server-IBRS", + "Westmere", + "Westmere-IBRS" ], "type" : "string" }, + "flags" : { + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.", + "format_description" : "+FLAG[;-FLAG...]", + "optional" : 1, + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl))(;(?^:[+-](pcid|spec-ctrl)))*)", + "type" : "string" + }, "hidden" : { "default" : 0, "description" : "Do not identify as a KVM virtual machine.", @@ -5891,7 +5910,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[cputype=] [,hidden=<1|0>]" + "typetext" : "[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]" }, "cpulimit" : { "default" : 0, @@ -6279,8 +6298,8 @@ var pveapi = [ "typetext" : "[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=]" }, "keyboard" : { - "default" : "en-us", - "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.", + "default" : null, + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.", "enum" : [ "de", "de-ch", @@ -6577,7 +6596,7 @@ var pveapi = [ ], "optional" : 1, "type" : "string", - "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" }, "parallel[n]" : { "description" : "Map host parallel devices (n is 0 to 2).", @@ -7815,17 +7834,24 @@ var pveapi = [ "486", "athlon", "Broadwell", + "Broadwell-IBRS", "Broadwell-noTSX", + "Broadwell-noTSX-IBRS", "Conroe", "core2duo", "coreduo", "Haswell", + "Haswell-IBRS", "Haswell-noTSX", + "Haswell-noTSX-IBRS", "host", "IvyBridge", + "IvyBridge-IBRS", "kvm32", "kvm64", + "max", "Nehalem", + "Nehalem-IBRS", "Opteron_G1", "Opteron_G2", "Opteron_G3", @@ -7839,11 +7865,23 @@ var pveapi = [ "qemu32", "qemu64", "SandyBridge", + "SandyBridge-IBRS", "Skylake-Client", - "Westmere" + "Skylake-Client-IBRS", + "Skylake-Server", + "Skylake-Server-IBRS", + "Westmere", + "Westmere-IBRS" ], "type" : "string" }, + "flags" : { + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.", + "format_description" : "+FLAG[;-FLAG...]", + "optional" : 1, + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl))(;(?^:[+-](pcid|spec-ctrl)))*)", + "type" : "string" + }, "hidden" : { "default" : 0, "description" : "Do not identify as a KVM virtual machine.", @@ -7853,7 +7891,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[cputype=] [,hidden=<1|0>]" + "typetext" : "[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]" }, "cpulimit" : { "default" : 0, @@ -8241,8 +8279,8 @@ var pveapi = [ "typetext" : "[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=]" }, "keyboard" : { - "default" : "en-us", - "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.", + "default" : null, + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.", "enum" : [ "de", "de-ch", @@ -8539,7 +8577,7 @@ var pveapi = [ ], "optional" : 1, "type" : "string", - "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" }, "parallel[n]" : { "description" : "Map host parallel devices (n is 0 to 2).", @@ -9880,6 +9918,74 @@ var pveapi = [ "path" : "/nodes/{node}/qemu/{vmid}/vncproxy", "text" : "vncproxy" }, + { + "info" : { + "POST" : { + "description" : "Creates a TCP proxy connections.", + "method" : "POST", + "name" : "termproxy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "serial" : { + "description" : "opens a serial terminal (defaults to display)", + "enum" : [ + "serial0", + "serial1", + "serial2", + "serial3" + ], + "optional" : 1, + "type" : "string" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "port" : { + "type" : "integer" + }, + "ticket" : { + "type" : "string" + }, + "upid" : { + "type" : "string" + }, + "user" : { + "type" : "string" + } + } + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/qemu/{vmid}/termproxy", + "text" : "termproxy" + }, { "info" : { "GET" : { @@ -11916,17 +12022,24 @@ var pveapi = [ "486", "athlon", "Broadwell", + "Broadwell-IBRS", "Broadwell-noTSX", + "Broadwell-noTSX-IBRS", "Conroe", "core2duo", "coreduo", "Haswell", + "Haswell-IBRS", "Haswell-noTSX", + "Haswell-noTSX-IBRS", "host", "IvyBridge", + "IvyBridge-IBRS", "kvm32", "kvm64", + "max", "Nehalem", + "Nehalem-IBRS", "Opteron_G1", "Opteron_G2", "Opteron_G3", @@ -11940,11 +12053,23 @@ var pveapi = [ "qemu32", "qemu64", "SandyBridge", + "SandyBridge-IBRS", "Skylake-Client", - "Westmere" + "Skylake-Client-IBRS", + "Skylake-Server", + "Skylake-Server-IBRS", + "Westmere", + "Westmere-IBRS" ], "type" : "string" }, + "flags" : { + "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.", + "format_description" : "+FLAG[;-FLAG...]", + "optional" : 1, + "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl))(;(?^:[+-](pcid|spec-ctrl)))*)", + "type" : "string" + }, "hidden" : { "default" : 0, "description" : "Do not identify as a KVM virtual machine.", @@ -11954,7 +12079,7 @@ var pveapi = [ }, "optional" : 1, "type" : "string", - "typetext" : "[cputype=] [,hidden=<1|0>]" + "typetext" : "[cputype=] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]" }, "cpulimit" : { "default" : 0, @@ -12328,8 +12453,8 @@ var pveapi = [ "typetext" : "[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=]" }, "keyboard" : { - "default" : "en-us", - "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.", + "default" : null, + "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.", "enum" : [ "de", "de-ch", @@ -12626,7 +12751,7 @@ var pveapi = [ ], "optional" : 1, "type" : "string", - "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" + "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n" }, "parallel[n]" : { "description" : "Map host parallel devices (n is 0 to 2).", @@ -16889,6 +17014,63 @@ var pveapi = [ "path" : "/nodes/{node}/lxc/{vmid}/vncproxy", "text" : "vncproxy" }, + { + "info" : { + "POST" : { + "description" : "Creates a TCP proxy connection.", + "method" : "POST", + "name" : "termproxy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "vmid" : { + "description" : "The (unique) ID of the VM.", + "format" : "pve-vmid", + "minimum" : 1, + "type" : "integer", + "typetext" : " (1 - N)" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/vms/{vmid}", + [ + "VM.Console" + ] + ] + }, + "protected" : 1, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "port" : { + "type" : "integer" + }, + "ticket" : { + "type" : "string" + }, + "upid" : { + "type" : "string" + }, + "user" : { + "type" : "string" + } + } + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/lxc/{vmid}/termproxy", + "text" : "termproxy" + }, { "info" : { "GET" : { @@ -18180,8 +18362,8 @@ var pveapi = [ "additionalProperties" : 0, "properties" : { "bluestore" : { - "default" : 0, - "description" : "Use bluestore instead of filestore.", + "default" : 1, + "description" : "Use bluestore instead of filestore. This is the default.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -18476,6 +18658,13 @@ var pveapi = [ "pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?", "type" : "string" }, + "mon-address" : { + "description" : "Overwrites autodetected monitor IP address. Must be in the public network of ceph.", + "format" : "ip", + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -20060,6 +20249,15 @@ var pveapi = [ } } }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, "protected" : 1, "proxyto" : "node", "returns" : { @@ -20087,6 +20285,15 @@ var pveapi = [ } } }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Modify" + ] + ] + }, "protected" : 1, "proxyto" : "node", "returns" : { @@ -21976,6 +22183,13 @@ var pveapi = [ "type" : "boolean", "typetext" : "" }, + "format" : { + "default" : 0, + "description" : "Include information about formats", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "node" : { "description" : "The cluster node name.", "format" : "pve-node", @@ -23873,6 +24087,13 @@ var pveapi = [ "type" : "string", "typetext" : "" }, + "service" : { + "description" : "Service ID", + "maxLength" : 128, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "since" : { "description" : "Display all log since this date-time string.", "optional" : 1, @@ -24009,6 +24230,64 @@ var pveapi = [ "path" : "/nodes/{node}/vncshell", "text" : "vncshell" }, + { + "info" : { + "POST" : { + "description" : "Creates a VNC Shell proxy.", + "method" : "POST", + "name" : "termproxy", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + }, + "upgrade" : { + "default" : 0, + "description" : "Run 'apt-get dist-upgrade' instead of normal shell.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "perm", + "/nodes/{node}", + [ + "Sys.Console" + ] + ], + "description" : "Restricted to users on realm 'pam'" + }, + "protected" : 1, + "returns" : { + "additionalProperties" : 0, + "properties" : { + "port" : { + "type" : "integer" + }, + "ticket" : { + "type" : "string" + }, + "upid" : { + "type" : "string" + }, + "user" : { + "type" : "string" + } + } + } + } + }, + "leaf" : 1, + "path" : "/nodes/{node}/termproxy", + "text" : "termproxy" + }, { "info" : { "GET" : { diff --git a/datacenter.cfg.5-opts.adoc b/datacenter.cfg.5-opts.adoc index 1890a29..db62fe9 100644 --- a/datacenter.cfg.5-opts.adoc +++ b/datacenter.cfg.5-opts.adoc @@ -1,6 +1,6 @@ `console`: `` :: -Select the default Console viewer. You can either use the builtin java applet (VNC), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC). +Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC). `email_from`: `` :: diff --git a/ha-manager.1-synopsis.adoc b/ha-manager.1-synopsis.adoc index 7394c5d..3071693 100644 --- a/ha-manager.1-synopsis.adoc +++ b/ha-manager.1-synopsis.adoc @@ -32,8 +32,6 @@ Requested resource state. Resource type. - - *ha-manager config* `[OPTIONS]` List HA resources. @@ -42,9 +40,6 @@ List HA resources. Only list resources of specific type - - - *ha-manager groupadd* ` --nodes ` `[OPTIONS]` Create a new HA group. @@ -73,14 +68,10 @@ Resources bound to restricted groups may only run on nodes defined by the group. Group type. - - *ha-manager groupconfig* Get HA groups. - - *ha-manager groupremove* `` Delete ha group configuration. @@ -89,8 +80,6 @@ Delete ha group configuration. The HA group identifier. - - *ha-manager groupset* `` `[OPTIONS]` Update ha group configuration. @@ -123,24 +112,18 @@ The CRM tries to run services on the node with the highest priority. If a node w Resources bound to restricted groups may only run on nodes defined by the group. - - - -*ha-manager help* `[]` `[OPTIONS]` +*ha-manager help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *ha-manager migrate* ` ` Request resource migration (online) to another node. @@ -153,8 +136,6 @@ HA resource ID. This consists of a resource type followed by a resource specific The cluster node name. - - *ha-manager relocate* ` ` Request resource relocatzion to another node. This stops the service on the @@ -168,8 +149,6 @@ HA resource ID. This consists of a resource type followed by a resource specific The cluster node name. - - *ha-manager remove* `` Delete resource configuration. @@ -178,8 +157,6 @@ Delete 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). - - *ha-manager set* `` `[OPTIONS]` Update resource configuration. @@ -216,9 +193,6 @@ Maximal number of tries to restart the service on a node after its start failed. Requested resource state. - - - *ha-manager status* `[OPTIONS]` Display HA manger status. @@ -228,5 +202,3 @@ Display HA manger status. Verbose output. Include complete CRM and LRM status (JSON). - - diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 0fea003..3ecb377 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -42,9 +42,6 @@ Target storage for full clone. + NOTE: Requires option(s): `full` - - - *pct config* `` Get container configuration. @@ -53,9 +50,6 @@ Get container configuration. The (unique) ID of the VM. - - - *pct console* `` Launch a console for the specified container. @@ -64,15 +58,10 @@ Launch a console for the specified container. The (unique) ID of the VM. - - *pct cpusets* Print the list of assigned CPU sets. - - - *pct create* ` ` `[OPTIONS]` Create or restore a container. @@ -213,9 +202,6 @@ Makes the container run as unprivileged user. (Should not be modified manually.) Reference to unused volumes. This is used internally, and should not be modified manually. - - - *pct delsnapshot* ` ` `[OPTIONS]` Delete a LXC snapshot. @@ -232,9 +218,6 @@ The name of the snapshot. For removal from config file, even if removing disk snapshots fails. - - - *pct destroy* `` Destroy the container (also delete all uses files). @@ -243,9 +226,6 @@ Destroy the container (also delete all uses files). The (unique) ID of the VM. - - - *pct df* `` Get the container's current disk usage. @@ -254,8 +234,6 @@ Get the container's current disk usage. The (unique) ID of the VM. - - *pct enter* `` Launch a shell for the specified container. @@ -264,8 +242,6 @@ Launch a shell for the specified container. The (unique) ID of the VM. - - *pct exec* ` []` Launch a command inside the specified container. @@ -278,8 +254,6 @@ The (unique) ID of the VM. Extra arguments as array - - *pct fsck* `` `[OPTIONS]` Run a filesystem check (fsck) on a container volume. @@ -296,31 +270,22 @@ A volume on which to run the filesystem check Force checking, even if the filesystem seems clean - - - -*pct help* `[]` `[OPTIONS]` +*pct help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pct list* LXC container index (per node). - - - *pct listsnapshot* `` List all snapshots. @@ -329,9 +294,6 @@ List all snapshots. The (unique) ID of the VM. - - - *pct migrate* ` ` `[OPTIONS]` Migrate the container to another node. Creates a new migration task. @@ -360,9 +322,6 @@ Use restart migration Timeout in seconds for shutdown for restart migration - - - *pct mount* `` Mount the container's filesystem on the host. This will hold a lock on the @@ -373,8 +332,6 @@ further operations on the container other than start and stop. The (unique) ID of the VM. - - *pct pull* ` ` `[OPTIONS]` Copy a file from the container to the local system. @@ -403,8 +360,6 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal). Owner user name or id. - - *pct push* ` ` `[OPTIONS]` Copy a local file to the container. @@ -433,9 +388,6 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal). Owner user name or id. When using a name it must exist inside the container. - - - *pct resize* ` ` `[OPTIONS]` Resize a container mount point. @@ -456,8 +408,6 @@ The new size. With the '+' sign the value is added to the actual size of the vol Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. - - *pct restore* ` ` `[OPTIONS]` Create or restore a container. @@ -594,9 +544,6 @@ Makes the container run as unprivileged user. (Should not be modified manually.) Reference to unused volumes. This is used internally, and should not be modified manually. - - - *pct resume* `` Resume the container. @@ -605,9 +552,6 @@ Resume the container. The (unique) ID of the VM. - - - *pct rollback* ` ` Rollback LXC state to specified snapshot. @@ -620,9 +564,6 @@ The (unique) ID of the VM. The name of the snapshot. - - - *pct set* `` `[OPTIONS]` Set container options. @@ -739,9 +680,6 @@ Makes the container run as unprivileged user. (Should not be modified manually.) Reference to unused volumes. This is used internally, and should not be modified manually. - - - *pct shutdown* `` `[OPTIONS]` Shutdown the container. This will trigger a clean shutdown of the @@ -759,9 +697,6 @@ Make sure the Container stops. Wait maximal timeout seconds. - - - *pct snapshot* ` ` `[OPTIONS]` Snapshot a container. @@ -778,9 +713,6 @@ The name of the snapshot. A textual description or comment. - - - *pct start* `` `[OPTIONS]` Start the container. @@ -793,9 +725,6 @@ The (unique) ID of the VM. Ignore locks - only root is allowed to use this option. - - - *pct status* `` `[OPTIONS]` Show CT status. @@ -808,9 +737,6 @@ The (unique) ID of the VM. Verbose output format - - - *pct stop* `` `[OPTIONS]` Stop the container. This will abruptly stop all processes running in the @@ -824,8 +750,6 @@ The (unique) ID of the VM. Ignore locks - only root is allowed to use this option. - - *pct suspend* `` Suspend the container. @@ -834,9 +758,6 @@ Suspend the container. The (unique) ID of the VM. - - - *pct template* ` --experimental ` `[OPTIONS]` Create a Template. @@ -849,9 +770,6 @@ The (unique) ID of the VM. The template feature is experimental, set this flag if you know what you are doing. - - - *pct unlock* `` Unlock the VM. @@ -860,8 +778,6 @@ Unlock the VM. The (unique) ID of the VM. - - *pct unmount* `` Unmount the container's filesystem. @@ -871,5 +787,3 @@ Unmount the container's filesystem. The (unique) ID of the VM. - - diff --git a/pve-firewall.8-synopsis.adoc b/pve-firewall.8-synopsis.adoc index 729c81a..882aab8 100644 --- a/pve-firewall.8-synopsis.adoc +++ b/pve-firewall.8-synopsis.adoc @@ -4,36 +4,26 @@ Compile and print firewall rules. This is useful for testing. - - - -*pve-firewall help* `[]` `[OPTIONS]` +*pve-firewall help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pve-firewall localnet* Print information about local network. - - *pve-firewall restart* Restart the Proxmox VE firewall service. - - *pve-firewall simulate* `[OPTIONS]` Simulate firewall rules. This does not simulate kernel 'routing' table. @@ -72,8 +62,6 @@ Destination zone. Verbose output. - - *pve-firewall start* `[OPTIONS]` Start the Proxmox VE firewall service. @@ -82,19 +70,13 @@ Start the Proxmox VE firewall service. Debug mode - stay in foreground - - *pve-firewall status* Get firewall status. - - *pve-firewall stop* Stop firewall. This removes all Proxmox VE related iptable rules. The host is unprotected afterwards. - - diff --git a/pve-ha-crm.8-synopsis.adoc b/pve-ha-crm.8-synopsis.adoc index 8a18e8a..5e1a4f9 100644 --- a/pve-ha-crm.8-synopsis.adoc +++ b/pve-ha-crm.8-synopsis.adoc @@ -1,20 +1,17 @@ *pve-ha-crm* ` [ARGS] [OPTIONS]` -*pve-ha-crm help* `[]` `[OPTIONS]` +*pve-ha-crm help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pve-ha-crm start* `[OPTIONS]` Start the daemon. @@ -23,18 +20,12 @@ Start the daemon. Debug mode - stay in foreground - - *pve-ha-crm status* Get daemon status. - - *pve-ha-crm stop* Stop the daemon. - - diff --git a/pve-ha-lrm.8-synopsis.adoc b/pve-ha-lrm.8-synopsis.adoc index c2723d6..bda0678 100644 --- a/pve-ha-lrm.8-synopsis.adoc +++ b/pve-ha-lrm.8-synopsis.adoc @@ -1,20 +1,17 @@ *pve-ha-lrm* ` [ARGS] [OPTIONS]` -*pve-ha-lrm help* `[]` `[OPTIONS]` +*pve-ha-lrm help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pve-ha-lrm start* `[OPTIONS]` Start the daemon. @@ -23,18 +20,12 @@ Start the daemon. Debug mode - stay in foreground - - *pve-ha-lrm status* Get daemon status. - - *pve-ha-lrm stop* Stop the daemon. - - diff --git a/pveam.1-synopsis.adoc b/pveam.1-synopsis.adoc index abeb107..8164a26 100644 --- a/pveam.1-synopsis.adoc +++ b/pveam.1-synopsis.adoc @@ -8,9 +8,6 @@ List available templates. Restrict list to specified section. - - - *pveam download* `