proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-06-13 22:28:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update static/schema information

Browse Source 
The changes stem mostly from the actual definition of our minimum and
maximum range for the pve-vmid format.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2023-06-19 08:44:45 +02:00
parent d772991e62
commit 8dd66e125d
7 changed files with 634 additions and 481 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

929
api-viewer/apidata.js
View File

File diff suppressed because it is too large Load Diff

76
pct.1-synopsis.adoc
View File

@ -4,11 +4,11 @@
Create a container clone/copy Create a container clone/copy
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
`<newid>`: `<integer> (1 - N)` :: `<newid>`: `<integer> (100 - 999999999)` ::
VMID for the clone. VMID for the clone.
@ -48,7 +48,7 @@ Target node. Only allowed if the original VM is on shared storage.
Get container configuration. Get container configuration.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -64,7 +64,7 @@ Fetch config values from given snapshot.
Launch a console for the specified container. Launch a console for the specified container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -80,7 +80,7 @@ Print the list of assigned CPU sets.
Create or restore a container. Create or restore a container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -252,7 +252,7 @@ Reference to unused volumes. This is used internally, and should not be modified
Delete a LXC snapshot. Delete a LXC snapshot.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -268,7 +268,7 @@ For removal from config file, even if removing disk snapshots fails.
Destroy the container (also delete all uses files). Destroy the container (also delete all uses files).
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -288,7 +288,7 @@ Remove container from all related configurations. For example, backup jobs, repl
Get the container's current disk usage. Get the container's current disk usage.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -296,7 +296,7 @@ The (unique) ID of the VM.
Launch a shell for the specified container. Launch a shell for the specified container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -304,7 +304,7 @@ The (unique) ID of the VM.
Launch a command inside the specified container. Launch a command inside the specified container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -316,7 +316,7 @@ Extra arguments as array
Run a filesystem check (fsck) on a container volume. Run a filesystem check (fsck) on a container volume.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -333,7 +333,7 @@ Force checking, even if the filesystem seems clean
Run fstrim on a chosen CT and its mountpoints, except bind or read-only Run fstrim on a chosen CT and its mountpoints, except bind or read-only
mountpoints. mountpoints.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -361,7 +361,7 @@ LXC container index (per node).
List all snapshots. List all snapshots.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -369,7 +369,7 @@ The (unique) ID of the VM.
Migrate the container to another node. Creates a new migration task. Migrate the container to another node. Creates a new migration task.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -403,7 +403,7 @@ Mount the container's filesystem on the host. This will hold a lock on the
container and is meant for emergency maintenance only as it will prevent container and is meant for emergency maintenance only as it will prevent
further operations on the container other than start and stop. further operations on the container other than start and stop.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -412,7 +412,7 @@ The (unique) ID of the VM.
Move a rootfs-/mp-volume to a different storage or to a different Move a rootfs-/mp-volume to a different storage or to a different
container. container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -424,7 +424,7 @@ Volume which will be moved.
Target Storage. Target Storage.
`<target-vmid>`: `<integer> (1 - N)` :: `<target-vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -459,7 +459,7 @@ An alias for 'pct move-volume'.
Get container configuration, including pending changes. Get container configuration, including pending changes.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -467,7 +467,7 @@ The (unique) ID of the VM.
Copy a file from the container to the local system. Copy a file from the container to the local system.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -495,7 +495,7 @@ Owner user name or id.
Copy a local file to the container. Copy a local file to the container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -524,7 +524,7 @@ Owner user name or id. When using a name it must exist inside the container.
Reboot the container by shutting it down, and starting it again. Applies Reboot the container by shutting it down, and starting it again. Applies
pending changes. pending changes.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -537,11 +537,11 @@ Wait maximal timeout seconds for the shutdown.
Migrate container to a remote cluster. Creates a new migration task. Migrate container to a remote cluster. Creates a new migration task.
EXPERIMENTAL feature! EXPERIMENTAL feature!
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
`<target-vmid>`: `<integer> (1 - N)` :: `<target-vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -585,7 +585,7 @@ Rescan all storages and update disk sizes and unused disk images.
Do not actually write changes out to conifg. Do not actually write changes out to conifg.
`--vmid` `<integer> (1 - N)` :: `--vmid` `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -593,7 +593,7 @@ The (unique) ID of the VM.
Resize a container mount point. Resize a container mount point.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -613,7 +613,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
Create or restore a container. Create or restore a container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -781,7 +781,7 @@ Reference to unused volumes. This is used internally, and should not be modified
Resume the container. Resume the container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -789,7 +789,7 @@ The (unique) ID of the VM.
Rollback LXC state to specified snapshot. Rollback LXC state to specified snapshot.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -805,7 +805,7 @@ Whether the container should get started after rolling back successfully
Set container options. Set container options.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -944,7 +944,7 @@ Reference to unused volumes. This is used internally, and should not be modified
Shutdown the container. This will trigger a clean shutdown of the Shutdown the container. This will trigger a clean shutdown of the
container, see lxc-stop(1) for details. container, see lxc-stop(1) for details.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -960,7 +960,7 @@ Wait maximal timeout seconds.
Snapshot a container. Snapshot a container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -976,7 +976,7 @@ A textual description or comment.
Start the container. Start the container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -992,7 +992,7 @@ Ignore locks - only root is allowed to use this option.
Show CT status. Show CT status.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1005,7 +1005,7 @@ Verbose output format
Stop the container. This will abruptly stop all processes running in the Stop the container. This will abruptly stop all processes running in the
container. container.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1017,7 +1017,7 @@ Ignore locks - only root is allowed to use this option.
Suspend the container. This is experimental. Suspend the container. This is experimental.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1025,7 +1025,7 @@ The (unique) ID of the VM.
Create a Template. Create a Template.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1033,7 +1033,7 @@ The (unique) ID of the VM.
Unlock the VM. Unlock the VM.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1041,7 +1041,7 @@ The (unique) ID of the VM.
Unmount the container's filesystem. Unmount the container's filesystem.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.

6
pvenode.1-synopsis.adoc
View File

@ -81,7 +81,7 @@ ACME challenge type.
ACME Plugin ID name ACME Plugin ID name
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ipv64 | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nanelo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
API plugin name API plugin name
@ -133,7 +133,7 @@ Update ACME plugin configuration.
ACME Plugin ID name ACME Plugin ID name
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ipv64 | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nanelo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
API plugin name API plugin name
@ -334,7 +334,7 @@ Only list tasks until this UNIX epoch.
Only list tasks from this user. Only list tasks from this user.
`--vmid` `<integer> (1 - N)` :: `--vmid` `<integer> (100 - 999999999)` ::
Only list tasks for this VM. Only list tasks for this VM.

6
pvesm.1-synopsis.adoc
View File

@ -260,7 +260,7 @@ Allocate disk images.
The storage identifier. The storage identifier.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
Specify owner VM Specify owner VM
@ -410,7 +410,7 @@ The storage identifier.
Only list content of this type. Only list content of this type.
`--vmid` `<integer> (1 - N)` :: `--vmid` `<integer> (100 - 999999999)` ::
Only list images for this VM Only list images for this VM
@ -480,7 +480,7 @@ Keep backups for the last <N> different years. If there is morethan one backup f
Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
`--vmid` `<integer> (1 - N)` :: `--vmid` `<integer> (100 - 999999999)` ::
Only consider backups for this guest. Only consider backups for this guest.

4
pvesr.1-synopsis.adoc
View File

@ -174,7 +174,7 @@ Replication Job ID. The ID is composed of a Guest ID and a job number, separated
Set the job replication state on migration. This call is for internal use. Set the job replication state on migration. This call is for internal use.
It will accept the job state as ja JSON obj. It will accept the job state as ja JSON obj.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -186,7 +186,7 @@ Job state as JSON decoded string.
List status of all replication jobs on this node. List status of all replication jobs on this node.
`--guest` `<integer> (1 - N)` :: `--guest` `<integer> (100 - 999999999)` ::
Only list replication jobs for this guest. Only list replication jobs for this guest.

92
qm.1-synopsis.adoc
View File

@ -9,7 +9,7 @@ An alias for 'qm guest cmd'.
Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts Cleans up resources like tap devices, vgpus, etc. Called after a vm shuts
down, crashes, etc. down, crashes, etc.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -25,11 +25,11 @@ Indicates if the shutdown was requested by the guest or via qmp.
Create a copy of virtual machine/template. Create a copy of virtual machine/template.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
`<newid>`: `<integer> (1 - N)` :: `<newid>`: `<integer> (100 - 999999999)` ::
VMID for the clone. VMID for the clone.
@ -73,7 +73,7 @@ Target node. Only allowed if the original VM is on shared storage.
Get automatically generated cloudinit config. Get automatically generated cloudinit config.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -85,7 +85,7 @@ Config type.
Get the cloudinit configuration with both current and pending values. Get the cloudinit configuration with both current and pending values.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -93,7 +93,7 @@ The (unique) ID of the VM.
Regenerate and change cloudinit config drive. Regenerate and change cloudinit config drive.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -103,7 +103,7 @@ Get the virtual machine configuration with pending configuration changes
applied. Set the 'current' parameter to get the current configuration applied. Set the 'current' parameter to get the current configuration
instead. instead.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -119,7 +119,7 @@ Fetch config values from given snapshot.
Create or restore a virtual machine. Create or restore a virtual machine.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -483,7 +483,7 @@ Create a virtual hardware watchdog device.
Delete a VM snapshot. Delete a VM snapshot.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -500,7 +500,7 @@ For removal from config file, even if removing disk snapshots fails.
Destroy the VM and all used/owned volumes. Removes any VM specific Destroy the VM and all used/owned volumes. Removes any VM specific
permissions and firewall rules permissions and firewall rules
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -521,7 +521,7 @@ Ignore locks - only root is allowed to use this option.
Import an external disk image as an unused disk in a VM. The Import an external disk image as an unused disk in a VM. The
image format has to be supported by qemu-img(1). image format has to be supported by qemu-img(1).
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -541,7 +541,7 @@ Target format
Move volume to different storage or to a different VM. Move volume to different storage or to a different VM.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -579,7 +579,7 @@ Prevent changes if the current config file of the target VM has a"
The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key.
`--target-vmid` `<integer> (1 - N)` :: `--target-vmid` `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -591,7 +591,7 @@ Rescan all storages and update disk sizes and unused disk images.
Do not actually write changes out to VM config(s). Do not actually write changes out to VM config(s).
`--vmid` `<integer> (1 - N)` :: `--vmid` `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -599,7 +599,7 @@ The (unique) ID of the VM.
Extend volume size. Extend volume size.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -623,7 +623,7 @@ Ignore locks - only root is allowed to use this option.
Unlink/delete disk images. Unlink/delete disk images.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -639,7 +639,7 @@ A list of disk IDs you want to delete.
Execute QEMU Guest Agent commands. Execute QEMU Guest Agent commands.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -651,7 +651,7 @@ The QGA command.
Executes the given command via the guest agent Executes the given command via the guest agent
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -675,7 +675,7 @@ The maximum time to wait synchronously for the command to finish. If reached, th
Gets the status of the given pid started by the guest-agent Gets the status of the given pid started by the guest-agent
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -687,7 +687,7 @@ The PID to query
Sets the password for the given user to the given password Sets the password for the given user to the given password
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -719,7 +719,7 @@ An alias for 'qm disk import'.
Create a new VM using parameters read from an OVF manifest Create a new VM using parameters read from an OVF manifest
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -751,7 +751,7 @@ Determine the full status of active VMs.
List all snapshots. List all snapshots.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -759,7 +759,7 @@ The (unique) ID of the VM.
Migrate virtual machine. Creates a new migration task. Migrate virtual machine. Creates a new migration task.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -799,7 +799,7 @@ Enable live storage migration for local disk
Enter QEMU Monitor interface. Enter QEMU Monitor interface.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -819,7 +819,7 @@ Used by qmigrate - do not use manually.
Stop embedded nbd server. Stop embedded nbd server.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -827,7 +827,7 @@ The (unique) ID of the VM.
Get the virtual machine configuration with both current and pending values. Get the virtual machine configuration with both current and pending values.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -836,7 +836,7 @@ The (unique) ID of the VM.
Reboot the VM by shutting it down, and starting it again. Applies pending Reboot the VM by shutting it down, and starting it again. Applies pending
changes. changes.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -849,11 +849,11 @@ Wait maximal timeout seconds for the shutdown.
Migrate virtual machine to a remote cluster. Creates a new migration task. Migrate virtual machine to a remote cluster. Creates a new migration task.
EXPERIMENTAL feature! EXPERIMENTAL feature!
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
`<target-vmid>`: `<integer> (1 - N)` :: `<target-vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -889,7 +889,7 @@ An alias for 'qm disk rescan'.
Reset virtual machine. Reset virtual machine.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -905,7 +905,7 @@ An alias for 'qm disk resize'.
Resume virtual machine. Resume virtual machine.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -921,7 +921,7 @@ Ignore locks - only root is allowed to use this option.
Rollback VM state to specified snapshot. Rollback VM state to specified snapshot.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -937,7 +937,7 @@ Whether the VM should get started after rolling back successfully. (Note: VMs wi
Send key event to virtual machine. Send key event to virtual machine.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -955,7 +955,7 @@ Set virtual machine options (synchrounous API) - You should consider using
the POST method instead for any actions involving hotplug or storage the POST method instead for any actions involving hotplug or storage
allocation. allocation.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1303,7 +1303,7 @@ Create a virtual hardware watchdog device.
Show command line which is used to start the VM (debug info). Show command line which is used to start the VM (debug info).
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1321,7 +1321,7 @@ Shutdown virtual machine. This is similar to pressing the power button on a
physical machine.This will send an ACPI event for the guest OS, which physical machine.This will send an ACPI event for the guest OS, which
should then proceed to a clean shutdown. should then proceed to a clean shutdown.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1345,7 +1345,7 @@ Wait maximal timeout seconds.
Snapshot a VM. Snapshot a VM.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1365,7 +1365,7 @@ Save the vmstate
Start virtual machine. Start virtual machine.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1409,7 +1409,7 @@ Wait maximal timeout seconds.
Show VM status. Show VM status.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1422,7 +1422,7 @@ Verbose output format
Stop virtual machine. The qemu process will exit immediately. Thisis akin Stop virtual machine. The qemu process will exit immediately. Thisis akin
to pulling the power plug of a running computer and may damage the VM data to pulling the power plug of a running computer and may damage the VM data
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1446,7 +1446,7 @@ Wait maximal timeout seconds.
Suspend virtual machine. Suspend virtual machine.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1468,7 +1468,7 @@ If set, suspends the VM to disk. Will be resumed on next VM start.
Create a Template. Create a Template.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1481,7 +1481,7 @@ If you want to convert only 1 disk to base image.
Open a terminal using a serial device (The VM need to have a serial device Open a terminal using a serial device (The VM need to have a serial device
configured, for example 'serial0: socket') configured, for example 'serial0: socket')
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1501,7 +1501,7 @@ An alias for 'qm disk unlink'.
Unlock the VM. Unlock the VM.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1509,7 +1509,7 @@ The (unique) ID of the VM.
Proxy VM VNC traffic to stdin/stdout Proxy VM VNC traffic to stdin/stdout
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.
@ -1517,7 +1517,7 @@ The (unique) ID of the VM.
Wait until the VM is stopped. Wait until the VM is stopped.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.

2
qmrestore.1-synopsis.adoc
View File

@ -8,7 +8,7 @@ Restore QemuServer vzdump backups.
The backup file. You can pass '-' to read from standard input. The backup file. You can pass '-' to read from standard input.
`<vmid>`: `<integer> (1 - N)` :: `<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM. The (unique) ID of the VM.