mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-08-03 06:57:10 +00:00
make update-static
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
68a192b5be
commit
4d47f12597
File diff suppressed because it is too large
Load Diff
@ -44,7 +44,7 @@ Specify external http proxy which is used for downloads (example: 'http://userna
|
||||
|
||||
Default keybord layout for vnc server.
|
||||
|
||||
`language`: `<de | en>` ::
|
||||
`language`: `<ca | de | en | es | eu | fa | fr | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW>` ::
|
||||
|
||||
Default GUI language.
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ Get container configuration.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
*pct console* `<vmid>`
|
||||
*pct console* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Launch a console for the specified container.
|
||||
|
||||
@ -56,6 +56,10 @@ Launch a console for the specified container.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--escape` `\^?[a-z]` ('default =' `^a`)::
|
||||
|
||||
Escape sequence prefix. For example to use <Ctrl+b q> as the escape sequence pass '^b'.
|
||||
|
||||
*pct cpusets*
|
||||
|
||||
Print the list of assigned CPU sets.
|
||||
@ -72,7 +76,7 @@ The (unique) ID of the VM.
|
||||
|
||||
The OS template or backup file.
|
||||
|
||||
`--arch` `<amd64 | i386>` ('default =' `amd64`)::
|
||||
`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
@ -108,6 +112,10 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
|
||||
Allow containers access to advanced features.
|
||||
|
||||
`--force` `<boolean>` ::
|
||||
|
||||
Allow to overwrite existing container.
|
||||
@ -120,7 +128,7 @@ Set a host name for the container.
|
||||
|
||||
Ignore errors when extracting the template.
|
||||
|
||||
`--lock` `<backup | migrate | rollback | snapshot>` ::
|
||||
`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
@ -268,7 +276,7 @@ Run a filesystem check (fsck) on a container volume.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--device` `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
|
||||
`--device` `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
|
||||
|
||||
A volume on which to run the filesystem check
|
||||
|
||||
@ -346,7 +354,7 @@ Move a rootfs-/mp-volume to a different storage
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<volume>`: `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
|
||||
`<volume>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
|
||||
|
||||
Volume which will be moved.
|
||||
|
||||
@ -426,7 +434,7 @@ Resize a container mount point.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<disk>`: `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
|
||||
`<disk>`: `<mp0 | mp1 | mp10 | mp100 | mp101 | mp102 | mp103 | mp104 | mp105 | mp106 | mp107 | mp108 | mp109 | mp11 | mp110 | mp111 | mp112 | mp113 | mp114 | mp115 | mp116 | mp117 | mp118 | mp119 | mp12 | mp120 | mp121 | mp122 | mp123 | mp124 | mp125 | mp126 | mp127 | mp128 | mp129 | mp13 | mp130 | mp131 | mp132 | mp133 | mp134 | mp135 | mp136 | mp137 | mp138 | mp139 | mp14 | mp140 | mp141 | mp142 | mp143 | mp144 | mp145 | mp146 | mp147 | mp148 | mp149 | mp15 | mp150 | mp151 | mp152 | mp153 | mp154 | mp155 | mp156 | mp157 | mp158 | mp159 | mp16 | mp160 | mp161 | mp162 | mp163 | mp164 | mp165 | mp166 | mp167 | mp168 | mp169 | mp17 | mp170 | mp171 | mp172 | mp173 | mp174 | mp175 | mp176 | mp177 | mp178 | mp179 | mp18 | mp180 | mp181 | mp182 | mp183 | mp184 | mp185 | mp186 | mp187 | mp188 | mp189 | mp19 | mp190 | mp191 | mp192 | mp193 | mp194 | mp195 | mp196 | mp197 | mp198 | mp199 | mp2 | mp20 | mp200 | mp201 | mp202 | mp203 | mp204 | mp205 | mp206 | mp207 | mp208 | mp209 | mp21 | mp210 | mp211 | mp212 | mp213 | mp214 | mp215 | mp216 | mp217 | mp218 | mp219 | mp22 | mp220 | mp221 | mp222 | mp223 | mp224 | mp225 | mp226 | mp227 | mp228 | mp229 | mp23 | mp230 | mp231 | mp232 | mp233 | mp234 | mp235 | mp236 | mp237 | mp238 | mp239 | mp24 | mp240 | mp241 | mp242 | mp243 | mp244 | mp245 | mp246 | mp247 | mp248 | mp249 | mp25 | mp250 | mp251 | mp252 | mp253 | mp254 | mp255 | mp26 | mp27 | mp28 | mp29 | mp3 | mp30 | mp31 | mp32 | mp33 | mp34 | mp35 | mp36 | mp37 | mp38 | mp39 | mp4 | mp40 | mp41 | mp42 | mp43 | mp44 | mp45 | mp46 | mp47 | mp48 | mp49 | mp5 | mp50 | mp51 | mp52 | mp53 | mp54 | mp55 | mp56 | mp57 | mp58 | mp59 | mp6 | mp60 | mp61 | mp62 | mp63 | mp64 | mp65 | mp66 | mp67 | mp68 | mp69 | mp7 | mp70 | mp71 | mp72 | mp73 | mp74 | mp75 | mp76 | mp77 | mp78 | mp79 | mp8 | mp80 | mp81 | mp82 | mp83 | mp84 | mp85 | mp86 | mp87 | mp88 | mp89 | mp9 | mp90 | mp91 | mp92 | mp93 | mp94 | mp95 | mp96 | mp97 | mp98 | mp99 | rootfs>` ::
|
||||
|
||||
The disk you want to resize.
|
||||
|
||||
@ -450,7 +458,7 @@ The (unique) ID of the VM.
|
||||
|
||||
The OS template or backup file.
|
||||
|
||||
`--arch` `<amd64 | i386>` ('default =' `amd64`)::
|
||||
`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
@ -486,6 +494,10 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
|
||||
Allow containers access to advanced features.
|
||||
|
||||
`--force` `<boolean>` ::
|
||||
|
||||
Allow to overwrite existing container.
|
||||
@ -498,7 +510,7 @@ Set a host name for the container.
|
||||
|
||||
Ignore errors when extracting the template.
|
||||
|
||||
`--lock` `<backup | migrate | rollback | snapshot>` ::
|
||||
`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
@ -610,7 +622,7 @@ Set container options.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--arch` `<amd64 | i386>` ('default =' `amd64`)::
|
||||
`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
@ -650,11 +662,15 @@ Container description. Only used on the configuration web interface.
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`--features` `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
|
||||
Allow containers access to advanced features.
|
||||
|
||||
`--hostname` `<string>` ::
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`--lock` `<backup | migrate | rollback | snapshot>` ::
|
||||
`--lock` `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
`arch`: `<amd64 | i386>` ('default =' `amd64`)::
|
||||
`arch`: `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
@ -30,11 +30,27 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`features`: `[keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
|
||||
|
||||
Allow containers access to advanced features.
|
||||
|
||||
`keyctl`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
For unprivileged containers only: Allow the use of the keyctl() system call. This is required to use docker inside a container. By default unprivileged containers will see this system call as non-existent. This is mostly a workaround for systemd-networkd, as it will treat it as a fatal error when some keyctl() operations are denied by the kernel due to lacking permissions. Essentially, you can choose between running systemd-networkd or docker.
|
||||
|
||||
`mount`=`<fstype;fstype;...>` ;;
|
||||
|
||||
Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.
|
||||
|
||||
`nesting`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Allow nesting. Best used with unprivileged containers with additional id mapping. Note that this will expose procfs and sysfs contents of the host to the guest.
|
||||
|
||||
`hostname`: `<string>` ::
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`lock`: `<backup | migrate | rollback | snapshot>` ::
|
||||
`lock`: `<backup | disk | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ Block device name.
|
||||
|
||||
Use bluestore instead of filestore. This is the default.
|
||||
|
||||
`--fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
|
||||
`--fstype` `<ext4 | xfs>` ('default =' `xfs`)::
|
||||
|
||||
File system type (filestore only).
|
||||
|
||||
|
||||
@ -74,6 +74,10 @@ iscsi provider
|
||||
|
||||
Access rbd through krbd kernel module.
|
||||
|
||||
`--lio_tpg` `<string>` ::
|
||||
|
||||
target portal group for Linux LIO targets
|
||||
|
||||
`--maxfiles` `<integer> (0 - N)` ::
|
||||
|
||||
Maximal number of backup files per VM. Use '0' for unlimted.
|
||||
@ -216,19 +220,19 @@ Scan remote CIFS server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
The server address (name or IP).
|
||||
|
||||
`--domain` `<string>` ::
|
||||
|
||||
no description available
|
||||
SMB domain (Workgroup).
|
||||
|
||||
`--password` `<password>` ::
|
||||
|
||||
no description available
|
||||
User password.
|
||||
|
||||
`--username` `<string>` ::
|
||||
|
||||
no description available
|
||||
User name.
|
||||
|
||||
*pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
|
||||
|
||||
@ -284,7 +288,7 @@ Scan remote GlusterFS server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
The server address (name or IP).
|
||||
|
||||
*pvesm help* `[OPTIONS]`
|
||||
|
||||
@ -326,13 +330,13 @@ A snapshot to delete on success
|
||||
|
||||
Whether the stream includes intermediate snapshots
|
||||
|
||||
*pvesm iscsiscan* `--portal <string>` `[OPTIONS]`
|
||||
*pvesm iscsiscan* `<portal>`
|
||||
|
||||
Scan remote iSCSI server.
|
||||
|
||||
`--portal` `<string>` ::
|
||||
`<portal>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
The iSCSI portal (IP or DNS name with optional port).
|
||||
|
||||
*pvesm list* `<storage>` `[OPTIONS]`
|
||||
|
||||
@ -368,7 +372,7 @@ Scan remote NFS server.
|
||||
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
The server address (name or IP).
|
||||
|
||||
*pvesm path* `<volume>`
|
||||
|
||||
@ -448,6 +452,10 @@ Assume the given path is an externally managed mountpoint and consider the stora
|
||||
|
||||
Access rbd through krbd kernel module.
|
||||
|
||||
`--lio_tpg` `<string>` ::
|
||||
|
||||
target portal group for Linux LIO targets
|
||||
|
||||
`--maxfiles` `<integer> (0 - N)` ::
|
||||
|
||||
Maximal number of backup files per VM. Use '0' for unlimted.
|
||||
|
||||
@ -1,16 +1,8 @@
|
||||
*qm* `<COMMAND> [ARGS] [OPTIONS]`
|
||||
|
||||
*qm agent* `<vmid> <command>`
|
||||
*qm agent*
|
||||
|
||||
Execute Qemu Guest Agent commands.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-host-name | get-memory-block-info | get-memory-blocks | get-osinfo | get-time | get-timezone | get-users | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` ::
|
||||
|
||||
The QGA command.
|
||||
An alias for 'qm guest cmd'.
|
||||
|
||||
*qm clone* `<vmid> <newid>` `[OPTIONS]`
|
||||
|
||||
@ -81,9 +73,9 @@ The (unique) ID of the VM.
|
||||
|
||||
Enable/disable ACPI.
|
||||
|
||||
`--agent` `<boolean>` ('default =' `0`)::
|
||||
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
|
||||
|
||||
Enable/disable Qemu GuestAgent.
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
|
||||
`--archive` `<string>` ::
|
||||
|
||||
@ -212,7 +204,7 @@ Lock/unlock the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
|
||||
|
||||
Specific the Qemu machine type.
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
`--memory` `<integer> (16 - N)` ('default =' `512`)::
|
||||
|
||||
@ -356,7 +348,7 @@ Configure an USB device (n is 0 to 4).
|
||||
|
||||
Number of hotplugged vcpus.
|
||||
|
||||
`--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
|
||||
`--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ::
|
||||
|
||||
Select the VGA type.
|
||||
|
||||
@ -364,6 +356,10 @@ Select the VGA type.
|
||||
|
||||
Use volume as VIRTIO hard disk (n is 0 to 15).
|
||||
|
||||
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
|
||||
|
||||
Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
|
||||
|
||||
`--vmstatestorage` `<string>` ::
|
||||
|
||||
Default storage for VM state volumes/files.
|
||||
@ -400,6 +396,66 @@ The (unique) ID of the VM.
|
||||
|
||||
Ignore locks - only root is allowed to use this option.
|
||||
|
||||
*qm guest cmd* `<vmid> <command>`
|
||||
|
||||
Execute Qemu Guest Agent commands.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-host-name | get-memory-block-info | get-memory-blocks | get-osinfo | get-time | get-timezone | get-users | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` ::
|
||||
|
||||
The QGA command.
|
||||
|
||||
*qm guest exec* `<vmid> [<extra-args>]` `[OPTIONS]`
|
||||
|
||||
Executes the given command via the guest agent
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<extra-args>`: `<array>` ::
|
||||
|
||||
Extra arguments as array
|
||||
|
||||
`--synchronous` `<boolean>` ('default =' `1`)::
|
||||
|
||||
If set to off, returns the pid immediately instead of waiting for the commmand to finish or the timeout.
|
||||
|
||||
`--timeout` `<integer> (0 - N)` ('default =' `30`)::
|
||||
|
||||
The maximum time to wait synchronously for the command to finish. If reached, the pid gets returned. Set to 0 to deactivate
|
||||
|
||||
*qm guest exec-status* `<vmid> <pid>`
|
||||
|
||||
Gets the status of the given pid started by the guest-agent
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<pid>`: `<integer>` ::
|
||||
|
||||
The PID to query
|
||||
|
||||
*qm guest passwd* `<vmid> <username>` `[OPTIONS]`
|
||||
|
||||
Sets the password for the given user to the given password
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<username>`: `<string>` ::
|
||||
|
||||
The user to set the password for.
|
||||
|
||||
`--crypted` `<boolean>` ('default =' `0`)::
|
||||
|
||||
set to 1 if the password has already been passed through crypt()
|
||||
|
||||
*qm help* `[OPTIONS]`
|
||||
|
||||
Get help about specified command.
|
||||
@ -569,6 +625,10 @@ The (unique) ID of the VM.
|
||||
|
||||
Rescan all storages and update disk sizes and unused disk images.
|
||||
|
||||
`--dryrun` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Do not actually write changes out to VM config(s).
|
||||
|
||||
`--vmid` `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
@ -667,9 +727,9 @@ The (unique) ID of the VM.
|
||||
|
||||
Enable/disable ACPI.
|
||||
|
||||
`--agent` `<boolean>` ('default =' `0`)::
|
||||
`--agent` `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
|
||||
|
||||
Enable/disable Qemu GuestAgent.
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
|
||||
`--args` `<string>` ::
|
||||
|
||||
@ -798,7 +858,7 @@ Lock/unlock the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
|
||||
|
||||
Specific the Qemu machine type.
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
`--memory` `<integer> (16 - N)` ('default =' `512`)::
|
||||
|
||||
@ -932,7 +992,7 @@ Configure an USB device (n is 0 to 4).
|
||||
|
||||
Number of hotplugged vcpus.
|
||||
|
||||
`--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
|
||||
`--vga` `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ::
|
||||
|
||||
Select the VGA type.
|
||||
|
||||
@ -940,6 +1000,10 @@ Select the VGA type.
|
||||
|
||||
Use volume as VIRTIO hard disk (n is 0 to 15).
|
||||
|
||||
`--vmgenid` `<UUID>` ('default =' `1 (autogenerated)`)::
|
||||
|
||||
Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.
|
||||
|
||||
`--vmstatestorage` `<string>` ::
|
||||
|
||||
Default storage for VM state volumes/files.
|
||||
@ -1016,7 +1080,7 @@ The (unique) ID of the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
|
||||
|
||||
Specific the Qemu machine type.
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
`--migratedfrom` `<string>` ::
|
||||
|
||||
|
||||
@ -2,10 +2,18 @@
|
||||
|
||||
Enable/disable ACPI.
|
||||
|
||||
`agent`: `<boolean>` ('default =' `0`)::
|
||||
`agent`: `[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]` ::
|
||||
|
||||
Enable/disable Qemu GuestAgent and its properties.
|
||||
|
||||
`enabled`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Enable/disable Qemu GuestAgent.
|
||||
|
||||
`fstrim_cloned_disks`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Run fstrim after cloning/moving a disk.
|
||||
|
||||
`args`: `<string>` ::
|
||||
|
||||
Arbitrary arguments passed to kvm, for example:
|
||||
@ -64,7 +72,7 @@ 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'.
|
||||
List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb'.
|
||||
|
||||
`hidden`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
@ -365,7 +373,7 @@ Lock/unlock the VM.
|
||||
|
||||
`machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` ::
|
||||
|
||||
Specific the Qemu machine type.
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
`memory`: `<integer> (16 - N)` ('default =' `512`)::
|
||||
|
||||
@ -963,7 +971,7 @@ Specifies whether if given host option is a USB3 device or port (this does curre
|
||||
|
||||
Number of hotplugged vcpus.
|
||||
|
||||
`vga`: `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
|
||||
`vga`: `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ::
|
||||
|
||||
Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.
|
||||
|
||||
@ -1137,6 +1145,11 @@ Force disk geometry bios translation mode.
|
||||
|
||||
Write error action.
|
||||
|
||||
`vmgenid`: `<UUID>` ('default =' `1 (autogenerated)`)::
|
||||
|
||||
The VM generation ID (vmgenid) device exposes a 128-bit integer value identifier to the guest OS. This allows to notify the guest operating system when the virtual machine is executed with a different configuration (e.g. snapshot execution or creation from a template). The guest operating system notices the change, and is then able to react as appropriate by marking its copies of distributed databases as dirty, re-initializing its random number generator, etc.
|
||||
Note that auto-creation only works when done throug API/CLI create or update methods, but not when manually editing the config file.
|
||||
|
||||
`vmstatestorage`: `<string>` ::
|
||||
|
||||
Default storage for VM state volumes/files.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user