vzdump: drop overly scary & outdated warning about fleecing

[pve-docs.git] / pct.conf.5-opts.adoc

diff --git a/pct.conf.5-opts.adoc b/pct.conf.5-opts.adoc
index 1a88936fc7442e0423851ec283cfe1f8f563dc91..20a0a645821cd72b383272b219e911a2ac11b967 100644 (file)
--- a/pct.conf.5-opts.adoc
+++ b/pct.conf.5-opts.adoc
@@ -1,4 +1,4 @@
-`arch`: `<amd64 | arm64 | armhf | i386>` ('default =' `amd64`)::
+`arch`: `<amd64 | arm64 | armhf | i386 | riscv32 | riscv64>` ('default =' `amd64`)::
 
 OS architecture type.
 
@@ -10,25 +10,47 @@ Console mode. By default, the console command tries to open a connection to one
 
 Attach a console device (/dev/console) to the container.
 
-`cores`: `<integer> (1 - 128)` ::
+`cores`: `<integer> (1 - 8192)` ::
 
 The number of cores assigned to the container. A container can use all available cores by default.
 
-`cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
+`cpulimit`: `<number> (0 - 8192)` ('default =' `0`)::
 
 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. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this container gets. Number is relative to the weights of all the other running guests.
+
+`debug`: `<boolean>` ('default =' `0`)::
+
+Try to be more verbose. For now this only enables debug log-level on start.
 
 `description`: `<string>` ::
 
-Container description. Only used on the configuration web interface.
+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
+
+`gid`=`<integer> (0 - N)` ;;
+
+Group ID to be assigned to the device node
+
+`mode`=`<Octal access mode>` ;;
+
+Access mode to be set on the device node
+
+`path`=`<Path>` ;;
+
+Path to the device to pass through to the container
+
+`uid`=`<integer> (0 - N)` ;;
+
+User ID to be assigned to the device node
 
 `features`: `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]` ::
 
@@ -68,15 +90,15 @@ 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>]` ::
 
-Use volume as container mount point.
+Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume.
 
 `acl`=`<boolean>` ;;
 
@@ -126,7 +148,7 @@ Volume, device or directory to mount into the container.
 
 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.
 
@@ -158,7 +180,11 @@ IPv4 address in CIDR format.
 
 IPv6 address in CIDR format.
 
-`mtu`=`<integer> (64 - N)` ;;
+`link_down`=`<boolean>` ;;
+
+Whether this interface should be disconnected (like pulling the plug).
+
+`mtu`=`<integer> (64 - 65535)` ;;
 
 Maximum transfer unit of the interface. (lxc.network.mtu)
 
@@ -184,9 +210,9 @@ Network interface type.
 
 `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 | 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.
 
@@ -242,7 +268,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>` ::
 
@@ -252,6 +278,10 @@ Tags of the Container. This is only meta information.
 
 Enable/disable Template.
 
+`timezone`: `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
 `tty`: `<integer> (0 - 6)` ('default =' `2`)::
 
 Specify the number of tty available to the container