"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",
"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",
"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.",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[cputype=]<enum> [,hidden=<1|0>]"
+ "typetext" : "[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]"
},
"cpulimit" : {
"default" : 0,
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"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",
],
"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).",
"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",
"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.",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[cputype=]<enum> [,hidden=<1|0>]"
+ "typetext" : "[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]"
},
"cpulimit" : {
"default" : 0,
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"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",
],
"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).",
"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" : "<string>"
+ },
+ "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" : "<integer> (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" : {
"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",
"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.",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[cputype=]<enum> [,hidden=<1|0>]"
+ "typetext" : "[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]"
},
"cpulimit" : {
"default" : 0,
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
},
"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",
],
"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).",
"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" : "<string>"
+ },
+ "vmid" : {
+ "description" : "The (unique) ID of the VM.",
+ "format" : "pve-vmid",
+ "minimum" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (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" : {
"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" : "<boolean>"
"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" : "<string>"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
}
}
},
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/nodes/{node}",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/nodes/{node}",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "format" : {
+ "default" : 0,
+ "description" : "Include information about formats",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
+ "service" : {
+ "description" : "Service ID",
+ "maxLength" : 128,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"since" : {
"description" : "Display all log since this date-time string.",
"optional" : 1,
"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" : "<string>"
+ },
+ "upgrade" : {
+ "default" : 0,
+ "description" : "Run 'apt-get dist-upgrade' instead of normal shell.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ }
+ }
+ },
+ "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" : {
`console`: `<applet | html5 | vv>` ::
-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`: `<string>` ::
Resource type.
-
-
*ha-manager config* `[OPTIONS]`
List HA resources.
Only list resources of specific type
-
-
-
*ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
Create a new HA group.
Group type.
-
-
*ha-manager groupconfig*
Get HA groups.
-
-
*ha-manager groupremove* `<group>`
Delete ha group configuration.
The HA group identifier.
-
-
*ha-manager groupset* `<group>` `[OPTIONS]`
Update ha group configuration.
Resources bound to restricted groups may only run on nodes defined by the group.
-
-
-
-*ha-manager help* `[<cmd>]` `[OPTIONS]`
+*ha-manager help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*ha-manager migrate* `<sid> <node>`
Request resource migration (online) to another node.
The cluster node name.
-
-
*ha-manager relocate* `<sid> <node>`
Request resource relocatzion to another node. This stops the service on the
The cluster node name.
-
-
*ha-manager remove* `<sid>`
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* `<sid>` `[OPTIONS]`
Update resource configuration.
Requested resource state.
-
-
-
*ha-manager status* `[OPTIONS]`
Display HA manger status.
Verbose output. Include complete CRM and LRM status (JSON).
-
-
+
NOTE: Requires option(s): `full`
-
-
-
*pct config* `<vmid>`
Get container configuration.
The (unique) ID of the VM.
-
-
-
*pct console* `<vmid>`
Launch a console for the specified container.
The (unique) ID of the VM.
-
-
*pct cpusets*
Print the list of assigned CPU sets.
-
-
-
*pct create* `<vmid> <ostemplate>` `[OPTIONS]`
Create or restore a container.
Reference to unused volumes. This is used internally, and should not be modified manually.
-
-
-
*pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
Delete a LXC snapshot.
For removal from config file, even if removing disk snapshots fails.
-
-
-
*pct destroy* `<vmid>`
Destroy the container (also delete all uses files).
The (unique) ID of the VM.
-
-
-
*pct df* `<vmid>`
Get the container's current disk usage.
The (unique) ID of the VM.
-
-
*pct enter* `<vmid>`
Launch a shell for the specified container.
The (unique) ID of the VM.
-
-
*pct exec* `<vmid> [<extra-args>]`
Launch a command inside the specified container.
Extra arguments as array
-
-
*pct fsck* `<vmid>` `[OPTIONS]`
Run a filesystem check (fsck) on a container volume.
Force checking, even if the filesystem seems clean
-
-
-
-*pct help* `[<cmd>]` `[OPTIONS]`
+*pct help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pct list*
LXC container index (per node).
-
-
-
*pct listsnapshot* `<vmid>`
List all snapshots.
The (unique) ID of the VM.
-
-
-
*pct migrate* `<vmid> <target>` `[OPTIONS]`
Migrate the container to another node. Creates a new migration task.
Timeout in seconds for shutdown for restart migration
-
-
-
*pct mount* `<vmid>`
Mount the container's filesystem on the host. This will hold a lock on the
The (unique) ID of the VM.
-
-
*pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
Copy a file from the container to the local system.
Owner user name or id.
-
-
*pct push* `<vmid> <file> <destination>` `[OPTIONS]`
Copy a local file to the container.
Owner user name or id. When using a name it must exist inside the container.
-
-
-
*pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
Resize a container mount point.
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
-
-
*pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
Create or restore a container.
Reference to unused volumes. This is used internally, and should not be modified manually.
-
-
-
*pct resume* `<vmid>`
Resume the container.
The (unique) ID of the VM.
-
-
-
*pct rollback* `<vmid> <snapname>`
Rollback LXC state to specified snapshot.
The name of the snapshot.
-
-
-
*pct set* `<vmid>` `[OPTIONS]`
Set container options.
Reference to unused volumes. This is used internally, and should not be modified manually.
-
-
-
*pct shutdown* `<vmid>` `[OPTIONS]`
Shutdown the container. This will trigger a clean shutdown of the
Wait maximal timeout seconds.
-
-
-
*pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
Snapshot a container.
A textual description or comment.
-
-
-
*pct start* `<vmid>` `[OPTIONS]`
Start the container.
Ignore locks - only root is allowed to use this option.
-
-
-
*pct status* `<vmid>` `[OPTIONS]`
Show CT status.
Verbose output format
-
-
-
*pct stop* `<vmid>` `[OPTIONS]`
Stop the container. This will abruptly stop all processes running in the
Ignore locks - only root is allowed to use this option.
-
-
*pct suspend* `<vmid>`
Suspend the container.
The (unique) ID of the VM.
-
-
-
*pct template* `<vmid> --experimental <boolean>` `[OPTIONS]`
Create a Template.
The template feature is experimental, set this flag if you know what you are doing.
-
-
-
*pct unlock* `<vmid>`
Unlock the VM.
The (unique) ID of the VM.
-
-
*pct unmount* `<vmid>`
Unmount the container's filesystem.
The (unique) ID of the VM.
-
-
Compile and print firewall rules. This is useful for testing.
-
-
-
-*pve-firewall help* `[<cmd>]` `[OPTIONS]`
+*pve-firewall help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
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.
Verbose output.
-
-
*pve-firewall start* `[OPTIONS]`
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.
-
-
*pve-ha-crm* `<COMMAND> [ARGS] [OPTIONS]`
-*pve-ha-crm help* `[<cmd>]` `[OPTIONS]`
+*pve-ha-crm help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pve-ha-crm start* `[OPTIONS]`
Start the daemon.
Debug mode - stay in foreground
-
-
*pve-ha-crm status*
Get daemon status.
-
-
*pve-ha-crm stop*
Stop the daemon.
-
-
*pve-ha-lrm* `<COMMAND> [ARGS] [OPTIONS]`
-*pve-ha-lrm help* `[<cmd>]` `[OPTIONS]`
+*pve-ha-lrm help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pve-ha-lrm start* `[OPTIONS]`
Start the daemon.
Debug mode - stay in foreground
-
-
*pve-ha-lrm status*
Get daemon status.
-
-
*pve-ha-lrm stop*
Stop the daemon.
-
-
Restrict list to specified section.
-
-
-
*pveam download* `<storage> <template>`
Download appliance templates.
The template wich will downloaded
-
-
-
-*pveam help* `[<cmd>]` `[OPTIONS]`
+*pveam help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pveam list* `<storage>`
Get list of all templates on storage
Only list templates on specified storage
-
-
*pveam remove* `<template_path>`
Remove a template.
The template to remove.
-
-
*pveam update*
Update Container Template Database.
-
-
The ID for the manager, when omitted the same as the nodename
-
-
*pveceph createmon* `[OPTIONS]`
Create Ceph Monitor and Manager
The ID for the monitor, when omitted the same as the nodename
+`--mon-address` `<string>` ::
-
+Overwrites autodetected monitor IP address. Must be in the public network of ceph.
*pveceph createosd* `<dev>` `[OPTIONS]`
Block device name.
-`--bluestore` `<boolean>` ('default =' `0`)::
+`--bluestore` `<boolean>` ('default =' `1`)::
-Use bluestore instead of filestore.
+Use bluestore instead of filestore. This is the default.
`--fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
Block device name for block.wal (bluestore only).
-
-
-
*pveceph createpool* `<name>` `[OPTIONS]`
Create POOL
Number of replicas per object
-
-
*pveceph destroymgr* `<id>`
Destroy Ceph Manager.
The ID of the manager
-
-
*pveceph destroymon* `<monid>` `[OPTIONS]`
Destroy Ceph Monitor and Manager.
When set, removes only the monitor, not the manager
-
-
-
*pveceph destroyosd* `<osdid>` `[OPTIONS]`
Destroy OSD
If set, we remove partition table entries.
-
-
-
*pveceph destroypool* `<name>` `[OPTIONS]`
Destroy pool
Remove all pveceph-managed storages configured for this pool
-
-
-
-*pveceph help* `[<cmd>]` `[OPTIONS]`
+*pveceph help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pveceph init* `[OPTIONS]`
Create initial ceph default configuration and setup symlinks.
Targeted number of replicas per object
-
-
-
*pveceph install* `[OPTIONS]`
Install ceph related packages.
no description available
-
-
-
*pveceph lspools*
List all pools.
-
-
-
*pveceph purge*
Destroy ceph related data and configuration files.
-
-
-
*pveceph start* `[<service>]`
Start ceph services.
Ceph service name.
-
-
*pveceph status*
Get ceph status.
-
-
*pveceph stop* `[<service>]`
Stop ceph services.
Ceph service name.
-
-
Number of votes for this node
-
-
*pvecm addnode* `<node>` `[OPTIONS]`
Adds a node to the cluster configuration.
Number of votes for this node
-
-
*pvecm create* `<clustername>` `[OPTIONS]`
Generate new cluster configuration.
Number of votes for this node.
-
-
*pvecm delnode* `<node>`
Removes a node to the cluster configuration.
Hostname or IP of the corosync ring0 address of this node.
-
-
*pvecm expected* `<expected>`
Tells corosync a new value of expected votes.
Expected votes
-
-
-
-*pvecm help* `[<cmd>]` `[OPTIONS]`
+*pvecm help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pvecm keygen* `<filename>`
Generate new cryptographic key for corosync.
Output file name
-
-
*pvecm mtunnel* `[<extra-args>]` `[OPTIONS]`
Used by VM/CT migration - do not use manually.
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.
-
-
*pvecm nodes*
Displays the local view of the cluster nodes.
-
-
*pvecm status*
Displays the local view of the cluster status.
-
-
*pvecm updatecerts* `[OPTIONS]`
Update node certificates (and generate all needed files/directories).
Ignore errors (i.e. when cluster has no quorum).
-
-
*pvedaemon* `<COMMAND> [ARGS] [OPTIONS]`
-*pvedaemon help* `[<cmd>]` `[OPTIONS]`
+*pvedaemon help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pvedaemon restart*
Restart the daemon (or start if not running).
-
-
*pvedaemon start* `[OPTIONS]`
Start the daemon.
Debug mode - stay in foreground
-
-
*pvedaemon status*
Get daemon status.
-
-
*pvedaemon stop*
Stop the daemon.
-
-
*pveproxy* `<COMMAND> [ARGS] [OPTIONS]`
-*pveproxy help* `[<cmd>]` `[OPTIONS]`
+*pveproxy help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pveproxy restart*
Restart the daemon (or start if not running).
-
-
*pveproxy start* `[OPTIONS]`
Start the daemon.
Debug mode - stay in foreground
-
-
*pveproxy status*
Get daemon status.
-
-
*pveproxy stop*
Stop the daemon.
-
-
Glusterfs Volume.
-
-
-
*pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
Allocate disk images.
+
NOTE: Requires option(s): `size`
-
-
-
*pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
Export a volume.
Whether to include intermediate snapshots in the stream
-
-
*pvesm extractconfig* `<volume>`
Extract configuration from vzdump backup archive.
Volume identifier
-
-
-
*pvesm free* `<volume>` `[OPTIONS]`
Delete volume
The storage identifier.
-
-
-
*pvesm glusterfsscan* `<server>`
Scan remote GlusterFS server.
no description available
-
-
-
-*pvesm help* `[<cmd>]` `[OPTIONS]`
+*pvesm help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
Import a volume.
Whether the stream includes intermediate snapshots
-
-
-
*pvesm iscsiscan* `--portal <string>` `[OPTIONS]`
Scan remote iSCSI server.
no description available
-
-
-
*pvesm list* `<storage>` `[OPTIONS]`
List storage content.
Only list images for this VM
-
-
-
*pvesm lvmscan*
List local LVM volume groups.
-
-
*pvesm lvmthinscan* `<vg>`
List local LVM Thin Pools.
no description available
-
-
*pvesm nfsscan* `<server>`
Scan remote NFS server.
no description available
-
-
-
*pvesm path* `<volume>`
Get filesystem path for specified volume
Volume identifier
-
-
-
*pvesm remove* `<storage>`
Delete storage configuration.
The storage identifier.
-
-
*pvesm set* `<storage>` `[OPTIONS]`
Update storage configuration.
RBD Id.
-
-
-
*pvesm status* `[OPTIONS]`
Get status for all datastores.
Only list stores which are enabled (not disabled in config).
+`--format` `<boolean>` ('default =' `0`)::
+
+Include information about formats
+
`--storage` `<string>` ::
Only list status for specified storage
If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.
-
-
-
*pvesm zfsscan*
Scan zfs pool list on local node.
-
-
Storage replication schedule. The format is a subset of `systemd` calender events.
-
-
*pvesr delete* `<id>` `[OPTIONS]`
Mark replication job for removal.
Keep replicated data at target (do not remove).
-
-
-
*pvesr disable* `<id>`
Disable a replication job.
Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
-
-
*pvesr enable* `<id>`
Enable a replication job.
Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
-
-
*pvesr finalize-local-job* `<id> [<extra-args>]` `[OPTIONS]`
Finalize a replication job. This removes all replications snapshots with
Time (UNIX epoch) of last successful sync. If not specified, all replication snapshots gets removed.
-
-
-
-*pvesr help* `[<cmd>]` `[OPTIONS]`
+*pvesr help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pvesr list*
List replication jobs.
-
-
-
*pvesr prepare-local-job* `<id> [<extra-args>]` `[OPTIONS]`
Prepare for starting a replication job. This is called on the target node
List of storage IDs to scan for stale volumes.
-
-
-
*pvesr read* `<id>`
Read replication job configuration.
Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
-
-
-
*pvesr run* `[OPTIONS]`
This method is called by the systemd-timer and executes all (or a specific)
Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
-`--verbose` `<boolean>` ('default =' `0`)::
-
-Print more verbose logs to stdout.
+`--mail` `<boolean>` ('default =' `0`)::
+Send an email notification in case of a failure.
+`--verbose` `<boolean>` ('default =' `0`)::
+Print more verbose logs to stdout.
*pvesr schedule-now* `<id>`
Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.
-
-
-
*pvesr set-state* `<vmid> <state>`
Set the job replication state on migration. This call is for internal use.
Job state as JSON decoded string.
-
-
-
*pvesr status* `[OPTIONS]`
List status of all replication jobs on this node.
Only list replication jobs for this guest.
-
-
-
*pvesr update* `<id>` `[OPTIONS]`
Update replication job configuration.
Storage replication schedule. The format is a subset of `systemd` calender events.
-
-
*pvestatd* `<COMMAND> [ARGS] [OPTIONS]`
-*pvestatd help* `[<cmd>]` `[OPTIONS]`
+*pvestatd help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pvestatd restart*
Restart the daemon (or start if not running).
-
-
*pvestatd start* `[OPTIONS]`
Start the daemon.
Debug mode - stay in foreground
-
-
*pvestatd status*
Get daemon status.
-
-
*pvestatd stop*
Stop the daemon.
-
-
Read subscription info.
-
-
-
-*pvesubscription help* `[<cmd>]` `[OPTIONS]`
+*pvesubscription help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pvesubscription set* `<key>`
Set subscription key.
Proxmox VE subscription key
-
-
*pvesubscription update* `[OPTIONS]`
Update subscription info.
Always connect to server, even if we have up to date info inside local cache.
-
-
List of users.
-
-
*pveum aclmod* `<path> --roles <string>` `[OPTIONS]`
Update Access Control List (add or remove permissions).
List of users.
-
-
-
*pveum groupadd* `<groupid>` `[OPTIONS]`
Create new group.
no description available
-
-
*pveum groupdel* `<groupid>`
Delete group.
no description available
-
-
*pveum groupmod* `<groupid>` `[OPTIONS]`
Update group data.
no description available
-
-
-
-*pveum help* `[<cmd>]` `[OPTIONS]`
+*pveum help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*pveum passwd* `<userid>`
Change user password.
User ID
-
-
-
*pveum roleadd* `<roleid>` `[OPTIONS]`
Create new role.
no description available
-
-
*pveum roledel* `<roleid>`
Delete role.
no description available
-
-
*pveum rolemod* `<roleid> --privs <string>` `[OPTIONS]`
Create new role.
no description available
-
-
-
*pveum ticket* `<username>` `[OPTIONS]`
Create or verify authentication ticket.
You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
-
-
-
*pveum useradd* `<userid>` `[OPTIONS]`
Create new user.
Initial password.
-
-
*pveum userdel* `<userid>`
Delete user.
User ID
-
-
*pveum usermod* `<userid>` `[OPTIONS]`
Update user configuration.
no description available
-
-
The QGA command.
-
-
*qm clone* `<vmid> <newid>` `[OPTIONS]`
Create a copy of virtual machine/template.
Target node. Only allowed if the original VM is on shared storage.
-
-
*qm config* `<vmid>` `[OPTIONS]`
Get current virtual machine configuration. This does not include pending
Get current values (instead of pending values).
-
-
*qm create* `<vmid>` `[OPTIONS]`
Create or restore a virtual machine.
The number of cores per socket.
-`--cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
+`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
Emulated CPU type.
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
-`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ('default =' `en-us`)::
+`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
-Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
`--kvm` `<boolean>` ('default =' `1`)::
Create a virtual hardware watchdog device.
-
-
*qm delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
Delete a VM snapshot.
For removal from config file, even if removing disk snapshots fails.
-
-
*qm destroy* `<vmid>` `[OPTIONS]`
Destroy the vm (also delete all used/owned volumes).
Ignore locks - only root is allowed to use this option.
-
-
-
-*qm help* `[<cmd>]` `[OPTIONS]`
+*qm help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*qm importdisk* `<vmid> <source> <storage>` `[OPTIONS]`
Import an external disk image as an unused disk in a VM. The
Target format
-
-
*qm importovf* `<vmid> <manifest> <storage>` `[OPTIONS]`
Create a new VM using parameters read from an OVF manifest
Target format
-
-
-
*qm list* `[OPTIONS]`
Virtual machine index (per node).
Determine the full status of active VMs.
-
-
*qm listsnapshot* `<vmid>`
List all snapshots.
The (unique) ID of the VM.
-
-
*qm migrate* `<vmid> <target>` `[OPTIONS]`
Migrate virtual machine. Creates a new migration task.
Enable live storage migration for local disk
-
-
-
*qm monitor* `<vmid>`
Enter Qemu Monitor interface.
The (unique) ID of the VM.
-
-
-
*qm move_disk* `<vmid> <disk> <storage>` `[OPTIONS]`
Move volume to different storage.
Target Format.
-
-
-
*qm mtunnel*
Used by qmigrate - do not use manually.
-
-
*qm nbdstop* `<vmid>`
Stop embedded nbd server.
The (unique) ID of the VM.
-
-
-
*qm pending* `<vmid>`
Get virtual machine configuration, including pending changes.
The (unique) ID of the VM.
-
-
-
*qm rescan* `[OPTIONS]`
Rescan all storages and update disk sizes and unused disk images.
The (unique) ID of the VM.
-
-
-
*qm reset* `<vmid>` `[OPTIONS]`
Reset virtual machine.
Ignore locks - only root is allowed to use this option.
-
-
*qm resize* `<vmid> <disk> <size>` `[OPTIONS]`
Extend volume size.
Ignore locks - only root is allowed to use this option.
-
-
*qm resume* `<vmid>` `[OPTIONS]`
Resume virtual machine.
Ignore locks - only root is allowed to use this option.
-
-
*qm rollback* `<vmid> <snapname>`
Rollback VM state to specified snapshot.
The name of the snapshot.
-
-
*qm sendkey* `<vmid> <key>` `[OPTIONS]`
Send key event to virtual machine.
Ignore locks - only root is allowed to use this option.
-
-
*qm set* `<vmid>` `[OPTIONS]`
Set virtual machine options (synchrounous API) - You should consider using
The number of cores per socket.
-`--cpu` `[cputype=]<enum> [,hidden=<1|0>]` ::
+`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
Emulated CPU type.
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
-`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ('default =' `en-us`)::
+`--keyboard` `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
-Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
`--kvm` `<boolean>` ('default =' `1`)::
Create a virtual hardware watchdog device.
-
-
-
-*qm showcmd* `<vmid>`
+*qm showcmd* `<vmid>` `[OPTIONS]`
Show command line which is used to start the VM (debug info).
The (unique) ID of the VM.
+`--pretty` `<boolean>` ('default =' `0`)::
-
+Puts each option on a new line to enhance human readability
*qm shutdown* `<vmid>` `[OPTIONS]`
Wait maximal timeout seconds.
-
-
*qm snapshot* `<vmid> <snapname>` `[OPTIONS]`
Snapshot a VM.
Save the vmstate
-
-
*qm start* `<vmid>` `[OPTIONS]`
Start virtual machine.
Target storage for the migration. (Can be '1' to use the same storage id as on the source node.)
-
-
-
*qm status* `<vmid>` `[OPTIONS]`
Show VM status.
Verbose output format
-
-
-
*qm stop* `<vmid>` `[OPTIONS]`
Stop virtual machine. The qemu process will exit immediately. Thisis akin
Wait maximal timeout seconds.
-
-
*qm suspend* `<vmid>` `[OPTIONS]`
Suspend virtual machine.
Ignore locks - only root is allowed to use this option.
-
-
*qm template* `<vmid>` `[OPTIONS]`
Create a Template.
If you want to convert only 1 disk to base image.
-
-
-
*qm terminal* `<vmid>` `[OPTIONS]`
Open a terminal using a serial device (The VM need to have a serial device
The (unique) ID of the VM.
-`--iface` `<serial0 | serial1 | serial2 | serial3>` ::
-
-Select the serial device. By default we simply use the first suitable device.
+`--escape` `<string>` ('default =' `^O`)::
+Escape character.
+`--iface` `<serial0 | serial1 | serial2 | serial3>` ::
+Select the serial device. By default we simply use the first suitable device.
*qm unlink* `<vmid> --idlist <string>` `[OPTIONS]`
A list of disk IDs you want to delete.
-
-
-
*qm unlock* `<vmid>`
Unlock the VM.
The (unique) ID of the VM.
-
-
*qm vncproxy* `<vmid>`
Proxy VM VNC traffic to stdin/stdout
The (unique) ID of the VM.
-
-
*qm wait* `<vmid>` `[OPTIONS]`
Wait until the VM is stopped.
Timeout in seconds. Default is to wait forever.
-
-
The number of cores per socket.
-`cpu`: `[cputype=]<enum> [,hidden=<1|0>]` ::
+`cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
Emulated CPU type.
-`cputype`=`<486 | Broadwell | Broadwell-noTSX | Conroe | Haswell | Haswell-noTSX | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Skylake-Client | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
+`cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Conroe | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | IvyBridge | IvyBridge-IBRS | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Server | Skylake-Server-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
Emulated CPU type.
+`flags`=`<+FLAG[;-FLAG...]>` ;;
+
+List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl'.
+
`hidden`=`<boolean>` ('default =' `0`);;
Do not identify as a KVM virtual machine.
Write error action.
-`keyboard`: `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ('default =' `en-us`)::
+`keyboard`: `<da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr>` ::
-Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.
+Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.It should not be necessary to set it.
`kvm`: `<boolean>` ('default =' `1`)::
w2k8;; Microsoft Windows 2008
wvista;; Microsoft Windows Vista
win7;; Microsoft Windows 7
-win8;; Microsoft Windows 8/2012
+win8;; Microsoft Windows 8/2012/2012r2
+win10;; Microsoft Windows 10/2016
l24;; Linux 2.4 Kernel
l26;; Linux 2.6/3.X Kernel
solaris;; Solaris/OpenSolaris/OpenIndiania kernel
*spiceproxy* `<COMMAND> [ARGS] [OPTIONS]`
-*spiceproxy help* `[<cmd>]` `[OPTIONS]`
+*spiceproxy help* `[OPTIONS]`
Get help about specified command.
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
-Command name
+Shows help for a specific command
`--verbose` `<boolean>` ::
Verbose output format.
-
-
-
*spiceproxy restart*
Restart the daemon (or start if not running).
-
-
*spiceproxy start* `[OPTIONS]`
Start the daemon.
Debug mode - stay in foreground
-
-
*spiceproxy status*
Get daemon status.
-
-
*spiceproxy stop*
Stop the daemon.
-
-
projects / pve-docs.git / commitdiff