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.
The name of the snapshot.
-`--storage` `<string>` ::
+`--storage` `<storage ID>` ::
Target storage for full clone.
Get container configuration.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Launch a console for the specified container.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Create or restore a container.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
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.
+
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`)::
Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
+`--dev[n]` `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
+
+Device to pass through to the container
+
`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
Allow containers access to advanced features.
`--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>]` ::
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 | 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.
Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
-`--storage` `<string>` ('default =' `local`)::
+`--storage` `<storage ID>` ('default =' `local`)::
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>` ::
Delete a LXC snapshot.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Destroy the container (also delete all uses files).
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Get the container's current disk usage.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
-*pct enter* `<vmid>`
+*pct enter* `<vmid>` `[OPTIONS]`
Launch a shell for the specified container.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
-*pct exec* `<vmid> [<extra-args>]`
+`--keep-env` `<boolean>` ('default =' `1`)::
+
+Keep the current environment. This option will disabled by default with PVE 9. If you rely on a preserved environment, please use this option to be future-proof.
+
+*pct exec* `<vmid> [<extra-args>]` `[OPTIONS]`
Launch a command inside the specified container.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Extra arguments as array
+`--keep-env` `<boolean>` ('default =' `1`)::
+
+Keep the current environment. This option will disabled by default with PVE 9. If you rely on a preserved environment, please use this option to be future-proof.
+
*pct fsck* `<vmid>` `[OPTIONS]`
Run a filesystem check (fsck) on a container volume.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
*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.
List all snapshots.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
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.
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.
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.
Volume which will be moved.
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
Target Storage.
-`<target-vmid>`: `<integer> (1 - N)` ::
+`<target-vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Get container configuration, including pending changes.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
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.
Copy a local file to the container.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
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.
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=<PVEAPIToken=user@realm!token=SECRET> ,host=<ADDRESS> [,fingerprint=<FINGERPRINT>] [,port=<PORT>]` ::
+
+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.
Do not actually write changes out to conifg.
-`--vmid` `<integer> (1 - N)` ::
+`--vmid` `<integer> (100 - 999999999)` ::
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.
Create or restore a container.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
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.
+
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`)::
Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
+`--dev[n]` `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
+
+Device to pass through to the container
+
`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
Allow containers access to advanced features.
`--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>]` ::
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 | 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.
Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.
-`--storage` `<string>` ('default =' `local`)::
+`--storage` `<storage ID>` ('default =' `local`)::
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>` ::
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.
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.
+
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`)::
Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.
+`--dev[n]` `[[path=]<Path>] [,gid=<integer>] [,mode=<Octal access mode>] [,uid=<integer>]` ::
+
+Device to pass through to the container
+
`--digest` `<string>` ::
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`--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>]` ::
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 | 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.
`--swap` `<integer> (0 - N)` ('default =' `512`)::
-Amount of SWAP for the VM in MB.
+Amount of SWAP for the container in MB.
`--tags` `<string>` ::
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.
Snapshot a container.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Start the container.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Show CT status.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
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.
+`--overrule-shutdown` `<boolean>` ('default =' `0`)::
+
+Try to abort active 'vzshutdown' tasks before stopping.
+
`--skiplock` `<boolean>` ::
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.
Create a Template.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
The (unique) ID of the VM.
Unlock the VM.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
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.