update static/schema information

[pve-docs.git] / pct.1-synopsis.adoc

diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc
index 4c82a59254bd98db6d27d478c3fa6f5c79aa64a4..add622aef01c045505f4bd0d62c1df2777ec4e5a 100644 (file)
--- a/pct.1-synopsis.adoc
+++ b/pct.1-synopsis.adoc
@@ -4,11 +4,11 @@
 
 Create a container clone/copy
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
-`<newid>`: `<integer> (1 - N)` ::
+`<newid>`: `<integer> (100 - 999999999)` ::
 
 VMID for the clone.
 
@@ -48,7 +48,7 @@ Target node. Only allowed if the original VM is on shared storage.
 
 Get container configuration.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -64,7 +64,7 @@ Fetch config values from given snapshot.
 
 Launch a console for the specified container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -80,7 +80,7 @@ Print the list of assigned CPU sets.
 
 Create or restore a container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -88,7 +88,7 @@ The (unique) ID of the VM.
 
 The OS template or backup file.
 
-`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
 
 OS architecture type.
 
@@ -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>]` ::
 
@@ -164,13 +162,13 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
 
 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 
-`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
+`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 
 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 | nixos | opensuse | ubuntu | unmanaged>` ::
 
@@ -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>` ::
 
@@ -254,7 +252,7 @@ Reference to unused volumes. This is used internally, and should not be modified
 
 Delete a LXC snapshot.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -270,7 +268,7 @@ For removal from config file, even if removing disk snapshots fails.
 
 Destroy the container (also delete all uses files).
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -290,7 +288,7 @@ Remove container from all related configurations. For example, backup jobs, repl
 
 Get the container's current disk usage.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -298,7 +296,7 @@ The (unique) ID of the VM.
 
 Launch a shell for the specified container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -306,7 +304,7 @@ The (unique) ID of the VM.
 
 Launch a command inside the specified container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -318,7 +316,7 @@ Extra arguments as array
 
 Run a filesystem check (fsck) on a container volume.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -332,9 +330,10 @@ Force checking, even if the filesystem seems clean
 
 *pct fstrim* `<vmid>` `[OPTIONS]`
 
-Run fstrim on a chosen CT and its mountpoints.
+Run fstrim on a chosen CT and its mountpoints, except bind or read-only
+mountpoints.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -362,7 +361,7 @@ LXC container index (per node).
 
 List all snapshots.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -370,7 +369,7 @@ The (unique) ID of the VM.
 
 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.
 
@@ -404,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
 further operations on the container other than start and stop.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -413,7 +412,7 @@ The (unique) ID of the VM.
 Move a rootfs-/mp-volume to a different storage or to a different
 container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -425,7 +424,7 @@ Volume which will be moved.
 
 Target Storage.
 
-`<target-vmid>`: `<integer> (1 - N)` ::
+`<target-vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -460,7 +459,7 @@ An alias for 'pct move-volume'.
 
 Get container configuration, including pending changes.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -468,7 +467,7 @@ The (unique) ID of the VM.
 
 Copy a file from the container to the local system.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -496,7 +495,7 @@ Owner user name or id.
 
 Copy a local file to the container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -525,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
 pending changes.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -533,6 +532,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> (100 - 999999999)` ::
+
+The (unique) ID of the VM.
+
+`<target-vmid>`: `<integer> (100 - 999999999)` ::
+
+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.
@@ -541,7 +585,7 @@ Rescan all storages and update disk sizes and unused disk images.
 
 Do not actually write changes out to conifg.
 
-`--vmid` `<integer> (1 - N)` ::
+`--vmid` `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -549,7 +593,7 @@ The (unique) ID of the VM.
 
 Resize a container mount point.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -569,7 +613,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
 
 Create or restore a container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -577,7 +621,7 @@ The (unique) ID of the VM.
 
 The OS template or backup file.
 
-`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
 
 OS architecture type.
 
@@ -603,11 +647,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`)::
 
@@ -639,11 +681,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>]` ::
 
@@ -653,13 +695,13 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
 
 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 
-`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
+`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 
 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 | nixos | opensuse | ubuntu | unmanaged>` ::
 
@@ -703,7 +745,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,15 +781,15 @@ Reference to unused volumes. This is used internally, and should not be modified
 
 Resume the container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
-*pct rollback* `<vmid> <snapname>`
+*pct rollback* `<vmid> <snapname>` `[OPTIONS]`
 
 Rollback LXC state to specified snapshot.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -755,15 +797,19 @@ 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.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
-`--arch` `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
+`--arch` `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
 
 OS architecture type.
 
@@ -785,11 +831,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`)::
 
@@ -821,11 +865,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>]` ::
 
@@ -835,13 +879,13 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G
 
 Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
 
-`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
+`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
 
 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 | nixos | opensuse | ubuntu | unmanaged>` ::
 
@@ -869,7 +913,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>` ::
 
@@ -900,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
 container, see lxc-stop(1) for details.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -916,7 +960,7 @@ Wait maximal timeout seconds.
 
 Snapshot a container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -932,7 +976,7 @@ A textual description or comment.
 
 Start the container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -948,7 +992,7 @@ Ignore locks - only root is allowed to use this option.
 
 Show CT status.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -961,7 +1005,7 @@ Verbose output format
 Stop the container. This will abruptly stop all processes running in the
 container.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -973,7 +1017,7 @@ Ignore locks - only root is allowed to use this option.
 
 Suspend the container. This is experimental.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -981,7 +1025,7 @@ The (unique) ID of the VM.
 
 Create a Template.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -989,7 +1033,7 @@ The (unique) ID of the VM.
 
 Unlock the VM.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.
 
@@ -997,7 +1041,7 @@ The (unique) ID of the VM.
 
 Unmount the container's filesystem.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 The (unique) ID of the VM.