mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-04-28 12:12:29 +00:00
update static schema/synopsis definitions
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
19556f5368
commit
1c5325464b
File diff suppressed because it is too large
Load Diff
@ -52,7 +52,7 @@ Specify external http proxy which is used for downloads (example: 'http://userna
|
||||
|
||||
Default keybord layout for vnc server.
|
||||
|
||||
`language`: `<ca | de | en | es | eu | fa | fr | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW>` ::
|
||||
`language`: `<ca | da | de | en | es | eu | fa | fr | he | it | ja | nb | nn | pl | pt_BR | ru | sl | sv | tr | zh_CN | zh_TW>` ::
|
||||
|
||||
Default GUI language.
|
||||
|
||||
|
||||
@ -40,6 +40,43 @@ List HA resources.
|
||||
|
||||
Only list resources of specific type
|
||||
|
||||
*ha-manager crm-command migrate* `<sid> <node>`
|
||||
|
||||
Request resource migration (online) to another node.
|
||||
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
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).
|
||||
|
||||
`<node>`: `<string>` ::
|
||||
|
||||
Target node.
|
||||
|
||||
*ha-manager crm-command relocate* `<sid> <node>`
|
||||
|
||||
Request resource relocatzion to another node. This stops the service on the
|
||||
old node, and restarts it on the target node.
|
||||
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
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).
|
||||
|
||||
`<node>`: `<string>` ::
|
||||
|
||||
Target node.
|
||||
|
||||
*ha-manager crm-command stop* `<sid> <timeout>`
|
||||
|
||||
Request the service to be stopped.
|
||||
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
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).
|
||||
|
||||
`<timeout>`: `<integer> (0 - N)` ::
|
||||
|
||||
Timeout in seconds. If set to 0 a hard stop will be performed.
|
||||
|
||||
*ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`
|
||||
|
||||
Create a new HA group.
|
||||
@ -124,30 +161,13 @@ Shows help for a specific command
|
||||
|
||||
Verbose output format.
|
||||
|
||||
*ha-manager migrate* `<sid> <node>`
|
||||
*ha-manager migrate*
|
||||
|
||||
Request resource migration (online) to another node.
|
||||
An alias for 'ha-manager crm-command migrate'.
|
||||
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
*ha-manager relocate*
|
||||
|
||||
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).
|
||||
|
||||
`<node>`: `<string>` ::
|
||||
|
||||
Target node.
|
||||
|
||||
*ha-manager relocate* `<sid> <node>`
|
||||
|
||||
Request resource relocatzion to another node. This stops the service on the
|
||||
old node, and restarts it on the target node.
|
||||
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
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).
|
||||
|
||||
`<node>`: `<string>` ::
|
||||
|
||||
Target node.
|
||||
An alias for 'ha-manager crm-command relocate'.
|
||||
|
||||
*ha-manager remove* `<sid>`
|
||||
|
||||
|
||||
@ -52,6 +52,10 @@ Get container configuration.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--current` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Get current values (instead of pending values).
|
||||
|
||||
`--snapshot` `<string>` ::
|
||||
|
||||
Fetch config values from given snapshot.
|
||||
@ -140,7 +144,7 @@ Set a host name for the container.
|
||||
|
||||
Ignore errors when extracting the template.
|
||||
|
||||
`--lock` `<backup | create | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
@ -250,7 +254,7 @@ The name of the snapshot.
|
||||
|
||||
For removal from config file, even if removing disk snapshots fails.
|
||||
|
||||
*pct destroy* `<vmid>`
|
||||
*pct destroy* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Destroy the container (also delete all uses files).
|
||||
|
||||
@ -258,6 +262,10 @@ Destroy the container (also delete all uses files).
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--purge` `<boolean>` ::
|
||||
|
||||
Remove vmid from backup cron jobs.
|
||||
|
||||
*pct df* `<vmid>`
|
||||
|
||||
Get the container's current disk usage.
|
||||
@ -404,6 +412,14 @@ Delete the original volume after successful copy. By default the original is kep
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
*pct pending* `<vmid>`
|
||||
|
||||
Get container configuration, including pending changes.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
*pct pull* `<vmid> <path> <destination>` `[OPTIONS]`
|
||||
|
||||
Copy a file from the container to the local system.
|
||||
@ -560,7 +576,7 @@ Set a host name for the container.
|
||||
|
||||
Ignore errors when extracting the template.
|
||||
|
||||
`--lock` `<backup | create | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
@ -730,7 +746,7 @@ Script that will be exectued during various steps in the containers lifetime.
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`--lock` `<backup | create | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
`--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
@ -762,6 +778,10 @@ OS type. This is used to setup configuration inside the container, and correspon
|
||||
|
||||
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
|
||||
|
||||
`--revert` `<string>` ::
|
||||
|
||||
Revert a pending change.
|
||||
|
||||
`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container root.
|
||||
|
||||
@ -58,7 +58,7 @@ Script that will be exectued during various steps in the containers lifetime.
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`lock`: `<backup | create | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
`lock`: `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
|
||||
@ -62,6 +62,7 @@
|
||||
|===========================================================
|
||||
|Action|proto|dport|sport
|
||||
|PARAM|tcp|6789|
|
||||
|PARAM|tcp|3300|
|
||||
|PARAM|tcp|6800:7300|
|
||||
|===========================================================
|
||||
|
||||
|
||||
@ -159,15 +159,16 @@ Only consider Guests with these IDs.
|
||||
|
||||
*pvenode startall* `[OPTIONS]`
|
||||
|
||||
Start all VMs and containers (when onboot=1).
|
||||
Start all VMs and containers located on this node (by default only those
|
||||
with onboot=1).
|
||||
|
||||
`--force` `<boolean>` ::
|
||||
`--force` `<boolean>` ('default =' `off`)::
|
||||
|
||||
force if onboot=0.
|
||||
Issue start command even if virtual guest have 'onboot' not set or set to off.
|
||||
|
||||
`--vms` `<string>` ::
|
||||
|
||||
Only consider Guests with these IDs.
|
||||
Only consider guests from this comma separated list of VMIDs.
|
||||
|
||||
*pvenode stopall* `[OPTIONS]`
|
||||
|
||||
|
||||
@ -262,6 +262,10 @@ Delete volume
|
||||
|
||||
Volume identifier
|
||||
|
||||
`--delay` `<integer> (1 - 30)` ::
|
||||
|
||||
Time to wait for the task to finish. We return 'null' if the task finish within that time.
|
||||
|
||||
`--storage` `<string>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -126,6 +126,10 @@ The backup file.
|
||||
|
||||
Arbitrary arguments passed to kvm.
|
||||
|
||||
`--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
|
||||
|
||||
Configure a audio device, useful in combination with QXL/Spice.
|
||||
|
||||
`--autostart` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Automatic restart after crash (currently ignored).
|
||||
@ -255,7 +259,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
@ -351,6 +355,10 @@ The number of CPUs. Please use option -sockets instead.
|
||||
|
||||
The number of CPU sockets.
|
||||
|
||||
`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
|
||||
|
||||
Configure additional enhancements for SPICE.
|
||||
|
||||
`--sshkeys` `<filepath>` ::
|
||||
|
||||
cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
|
||||
@ -445,6 +453,10 @@ Destroy the vm (also delete all used/owned volumes).
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--purge` `<boolean>` ::
|
||||
|
||||
Remove vmid from backup cron jobs.
|
||||
|
||||
`--skiplock` `<boolean>` ::
|
||||
|
||||
Ignore locks - only root is allowed to use this option.
|
||||
@ -612,7 +624,7 @@ Migration traffic is encrypted using an SSH tunnel by default. On secure, comple
|
||||
|
||||
`--online` `<boolean>` ::
|
||||
|
||||
Use online/live migration.
|
||||
Use online/live migration if VM is running. Ignored if VM is stopped.
|
||||
|
||||
`--targetstorage` `<string>` ::
|
||||
|
||||
@ -682,6 +694,19 @@ Get virtual machine configuration, including pending changes.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
*qm reboot* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Reboot the VM by shutting it down, and starting it again. Applies pending
|
||||
changes.
|
||||
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--timeout` `<integer> (0 - N)` ::
|
||||
|
||||
Wait maximal timeout seconds for the shutdown.
|
||||
|
||||
*qm rescan* `[OPTIONS]`
|
||||
|
||||
Rescan all storages and update disk sizes and unused disk images.
|
||||
@ -800,6 +825,10 @@ Virtual processor architecture. Defaults to the host.
|
||||
|
||||
Arbitrary arguments passed to kvm.
|
||||
|
||||
`--audio0` `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
|
||||
|
||||
Configure a audio device, useful in combination with QXL/Spice.
|
||||
|
||||
`--autostart` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Automatic restart after crash (currently ignored).
|
||||
@ -933,7 +962,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
@ -1033,6 +1062,10 @@ The number of CPUs. Please use option -sockets instead.
|
||||
|
||||
The number of CPU sockets.
|
||||
|
||||
`--spice_enhancements` `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
|
||||
|
||||
Configure additional enhancements for SPICE.
|
||||
|
||||
`--sshkeys` `<filepath>` ::
|
||||
|
||||
cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
|
||||
@ -1159,7 +1192,7 @@ Start virtual machine.
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
|
||||
`--machine` `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
|
||||
@ -26,6 +26,18 @@ args: -no-reboot -no-hpet
|
||||
+
|
||||
NOTE: this option is for experts only.
|
||||
|
||||
`audio0`: `device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]` ::
|
||||
|
||||
Configure a audio device, useful in combination with QXL/Spice.
|
||||
|
||||
`device`=`<AC97 | ich9-intel-hda | intel-hda>` ;;
|
||||
|
||||
Configure an audio device.
|
||||
|
||||
`driver`=`<spice>` ('default =' `spice`);;
|
||||
|
||||
Driver backend for the audio device.
|
||||
|
||||
`autostart`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Automatic restart after crash (currently ignored).
|
||||
@ -86,13 +98,13 @@ The number of cores per socket.
|
||||
|
||||
Emulated CPU type.
|
||||
|
||||
`cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Conroe | EPYC | EPYC-IBPB | 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`);;
|
||||
`cputype`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Conroe | EPYC | EPYC-IBPB | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | IvyBridge | IvyBridge-IBRS | KnightsMill | 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', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.
|
||||
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, md-clear, hv-tlbflush, hv-evmcs, aes.
|
||||
|
||||
`hidden`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
@ -425,7 +437,7 @@ Set the real time clock to local time. This is enabled by default if ostype indi
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`machine`: `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?|virt(?:-\d+\.\d+)?)` ::
|
||||
`machine`: `(pc|pc(-i440fx)?-\d+(\.\d+)+(\.pxe)?|q35|pc-q35-\d+(\.\d+)+(\.pxe)?|virt(?:-\d+(\.\d+)+)?)` ::
|
||||
|
||||
Specifies the Qemu machine type.
|
||||
|
||||
@ -991,6 +1003,18 @@ The number of CPUs. Please use option -sockets instead.
|
||||
|
||||
The number of CPU sockets.
|
||||
|
||||
`spice_enhancements`: `[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]` ::
|
||||
|
||||
Configure additional enhancements for SPICE.
|
||||
|
||||
`foldersharing`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.
|
||||
|
||||
`videostreaming`=`<all | filter | off>` ('default =' `off`);;
|
||||
|
||||
Enable video streaming. Uses compression for detected video streams.
|
||||
|
||||
`sshkeys`: `<string>` ::
|
||||
|
||||
cloud-init: Setup public SSH keys (one key per line, OpenSSH format).
|
||||
@ -1039,7 +1063,7 @@ The value 'spice' can be used to add a usb redirection devices for spice.
|
||||
|
||||
`usb3`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).
|
||||
Specifies whether if given host option is a USB3 device or port.
|
||||
|
||||
`vcpus`: `<integer> (1 - N)` ('default =' `0`)::
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user