]> git.proxmox.com Git - pve-docs.git/blobdiff - pct.1-synopsis.adoc
qm: add documentation for vm network MTU setting
[pve-docs.git] / pct.1-synopsis.adoc
index 4d084af10b24e81f9d95c2a7d383e2db1e52fb9d..6ed21a6c66de3f8382cac0c7a74e5ec2d39c2fba 100644 (file)
@@ -114,11 +114,9 @@ Limit of CPU usage.
 +
 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 
-`--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
+`--cpuunits` `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
 
-CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
-+
-NOTE: You can disable fair-scheduler configuration by setting this to 0.
+CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
 
 `--debug` `<boolean>` ('default =' `0`)::
 
@@ -150,11 +148,11 @@ Ignore errors when extracting the template.
 
 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
-Lock/unlock the VM.
+Lock/unlock the container.
 
 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 
-Amount of RAM for the VM in MB.
+Amount of RAM for the container in MB.
 
 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
@@ -170,9 +168,9 @@ Specifies network interfaces for the container.
 
 `--onboot` `<boolean>` ('default =' `0`)::
 
-Specifies whether a VM will be started during system bootup.
+Specifies whether a container will be started during system bootup.
 
-`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
+`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
 
 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 
@@ -218,7 +216,7 @@ Default Storage.
 
 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 
-Amount of SWAP for the VM in MB.
+Amount of SWAP for the container in MB.
 
 `--tags` `<string>` ::
 
@@ -390,6 +388,10 @@ Use online/live migration.
 
 Use restart migration
 
+`--target-storage` `<string>` ::
+
+Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
+
 `--timeout` `<integer>` ('default =' `180`)::
 
 Timeout in seconds for shutdown for restart migration
@@ -529,6 +531,51 @@ The (unique) ID of the VM.
 
 Wait maximal timeout seconds for the shutdown.
 
+*pct remote-migrate* `<vmid> [<target-vmid>] <target-endpoint> --target-bridge <string> --target-storage <string>` `[OPTIONS]`
+
+Migrate container to a remote cluster. Creates a new migration task.
+EXPERIMENTAL feature!
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<target-vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<target-endpoint>`: `apitoken=<A full Proxmox API token including the secret value.> ,host=<Remote Proxmox hostname or IP> [,fingerprint=<Remote host's certificate fingerprint, if not trusted by system store.>] [,port=<integer>]` ::
+
+Remote target endpoint
+
+`--bwlimit` `<integer> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::
+
+Override I/O bandwidth limit (in KiB/s).
+
+`--delete` `<boolean>` ('default =' `0`)::
+
+Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state.
+
+`--online` `<boolean>` ::
+
+Use online/live migration.
+
+`--restart` `<boolean>` ::
+
+Use restart migration
+
+`--target-bridge` `<string>` ::
+
+Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself.
+
+`--target-storage` `<string>` ::
+
+Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
+
+`--timeout` `<integer>` ('default =' `180`)::
+
+Timeout in seconds for shutdown for restart migration
+
 *pct rescan* `[OPTIONS]`
 
 Rescan all storages and update disk sizes and unused disk images.
@@ -599,11 +646,9 @@ Limit of CPU usage.
 +
 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 
-`--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
+`--cpuunits` `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
 
-CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
-+
-NOTE: You can disable fair-scheduler configuration by setting this to 0.
+CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
 
 `--debug` `<boolean>` ('default =' `0`)::
 
@@ -635,11 +680,11 @@ Ignore errors when extracting the template.
 
 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
-Lock/unlock the VM.
+Lock/unlock the container.
 
 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 
-Amount of RAM for the VM in MB.
+Amount of RAM for the container in MB.
 
 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
@@ -655,9 +700,9 @@ Specifies network interfaces for the container.
 
 `--onboot` `<boolean>` ('default =' `0`)::
 
-Specifies whether a VM will be started during system bootup.
+Specifies whether a container will be started during system bootup.
 
-`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
+`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
 
 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 
@@ -699,7 +744,7 @@ Default Storage.
 
 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 
-Amount of SWAP for the VM in MB.
+Amount of SWAP for the container in MB.
 
 `--tags` `<string>` ::
 
@@ -739,7 +784,7 @@ Resume the container.
 
 The (unique) ID of the VM.
 
-*pct rollback* `<vmid> <snapname>`
+*pct rollback* `<vmid> <snapname>` `[OPTIONS]`
 
 Rollback LXC state to specified snapshot.
 
@@ -751,6 +796,10 @@ The (unique) ID of the VM.
 
 The name of the snapshot.
 
+`--start` `<boolean>` ('default =' `0`)::
+
+Whether the container should get started after rolling back successfully
+
 *pct set* `<vmid>` `[OPTIONS]`
 
 Set container options.
@@ -781,11 +830,9 @@ Limit of CPU usage.
 +
 NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.
 
-`--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
+`--cpuunits` `<integer> (0 - 500000)` ('default =' `cgroup v1: 1024, cgroup v2: 100`)::
 
-CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
-+
-NOTE: You can disable fair-scheduler configuration by setting this to 0.
+CPU weight for a container, will be clamped to [1, 10000] in cgroup v2.
 
 `--debug` `<boolean>` ('default =' `0`)::
 
@@ -817,11 +864,11 @@ Set a host name for the container.
 
 `--lock` `<backup | create | destroyed | disk | fstrim | migrate | mounted | rollback | snapshot | snapshot-delete>` ::
 
-Lock/unlock the VM.
+Lock/unlock the container.
 
 `--memory` `<integer> (16 - N)` ('default =' `512`)::
 
-Amount of RAM for the VM in MB.
+Amount of RAM for the container in MB.
 
 `--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
 
@@ -837,9 +884,9 @@ Specifies network interfaces for the container.
 
 `--onboot` `<boolean>` ('default =' `0`)::
 
-Specifies whether a VM will be started during system bootup.
+Specifies whether a container will be started during system bootup.
 
-`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
+`--ostype` `<alpine | archlinux | centos | debian | devuan | fedora | gentoo | nixos | opensuse | ubuntu | unmanaged>` ::
 
 OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 
@@ -865,7 +912,7 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener
 
 `--swap` `<integer> (0 - N)` ('default =' `512`)::
 
-Amount of SWAP for the VM in MB.
+Amount of SWAP for the container in MB.
 
 `--tags` `<string>` ::