]> git.proxmox.com Git - pve-docs.git/blobdiff - pct.1-synopsis.adoc
sdn: add rp_filter sysctl tuning when mulitple evpn nodes are used
[pve-docs.git] / pct.1-synopsis.adoc
index 4c82a59254bd98db6d27d478c3fa6f5c79aa64a4..ee54277076f5ec59ab37217a114a882a95d7bdd5 100644 (file)
@@ -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>` ::
 
@@ -332,7 +330,8 @@ 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)` ::
 
@@ -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> (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.
@@ -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>` ::
 
@@ -743,7 +785,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.
 
@@ -755,6 +797,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.
@@ -763,7 +809,7 @@ Set container options.
 
 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>` ::