`-experimental` `boolean` (default=`0`)::
-The clone feature is experimental, set this flag if you know what you are
-doing.
+The clone feature is experimental, set this flag if you know what you are doing.
`-full` `boolean` (default=`0`)::
-Create a full copy of all disk. This is always done when you clone a normal
-CT. For CT templates, we try to create a linked clone by default.
+Create a full copy of all disk. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.
`-hostname` `string` ::
`-cmode` `(console | shell | tty)` (default=`tty`)::
-Console mode. By default, the console command tries to open a connection to
-one of the available tty devices. By setting cmode to 'console' it tries to
-attach to /dev/console instead. If you set cmode to 'shell', it simply
-invokes a shell inside the container (no login).
+Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
`-console` `boolean` (default=`1`)::
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.
+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`)::
-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.
+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.
Amount of RAM for the VM in MB.
-`-mp[n]` `mp=<Path>, [volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
+`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
-Use volume as container mount point (experimental feature).
+Use volume as container mount point.
`-nameserver` `string` ::
-Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain nor nameserver.
+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=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,rate=<mbps>] [,tag=<VlanNo>] [,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=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
Specifies whether a VM will be started during system bootup.
-`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
+`-ostype` `(alpine | archlinux | centos | debian | fedora | gentoo | 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.
+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.
`-password` ::
`-protection` `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the CT or CT's
-disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
`-restore` `boolean` ::
Mark this as restore task.
-`-rootfs` `[volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
+`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.
`-searchdomain` `string` ::
-Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`-ssh-public-keys` `filepath` ::
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+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`)::
`-unprivileged` `boolean` (default=`0`)::
-Makes the container run as unprivileged user. (Should not be modified
-manually.)
+Makes the container run as unprivileged user. (Should not be modified manually.)
`-unused[n]` `string` ::
-Reference to unused volumes.
+Reference to unused volumes. This is used internally, and should not be modified manually.
+*pct df* `<vmid>`
+
+Get the container's current disk usage.
+
+`<vmid>` `integer (1 - N)` ::
+
+The (unique) ID of the VM.
+
+
+
*pct enter* `<vmid>`
Launch a shell for the specified container.
`-force` `boolean` ::
-Force migration despite local bind / device mounts. WARNING: identical bind
-/ device mounts need to be available on the target node.
+Force migration despite local bind / device mounts. WARNING: identical bind / device mounts need to be available on the target node.
`-online` `boolean` ::
`-perms` `string` ::
-File permissions to use (octal by default, prefix with '0x' for
-hexadecimal).
+File permissions to use (octal by default, prefix with '0x' for hexadecimal).
`-user` `string` ::
`-group` `string` ::
-Owner group name or id. When using a name it must exist inside the
-container.
+Owner group name or id. When using a name it must exist inside the container.
`-perms` `string` ::
-File permissions to use (octal by default, prefix with '0x' for
-hexadecimal).
+File permissions to use (octal by default, prefix with '0x' for hexadecimal).
`-user` `string` ::
-Owner user name or id. When using a name it must exist inside the
-container.
+Owner user name or id. When using a name it must exist inside the container.
`<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
-The new size. With the '+' sign the value is added to the actual size of
-the volume and without it, the value is taken as an absolute one. Shrinking
-disk size is not supported.
+The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-cmode` `(console | shell | tty)` (default=`tty`)::
-Console mode. By default, the console command tries to open a connection to
-one of the available tty devices. By setting cmode to 'console' it tries to
-attach to /dev/console instead. If you set cmode to 'shell', it simply
-invokes a shell inside the container (no login).
+Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
`-console` `boolean` (default=`1`)::
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.
+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`)::
-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.
+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.
Amount of RAM for the VM in MB.
-`-mp[n]` `mp=<Path>, [volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
+`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
-Use volume as container mount point (experimental feature).
+Use volume as container mount point.
`-nameserver` `string` ::
-Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain nor nameserver.
+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=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,rate=<mbps>] [,tag=<VlanNo>] [,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=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
Specifies whether a VM will be started during system bootup.
-`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
+`-ostype` `(alpine | archlinux | centos | debian | fedora | gentoo | 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.
+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.
`-password` ::
`-protection` `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the CT or CT's
-disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
-`-rootfs` `[volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
+`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.
`-searchdomain` `string` ::
-Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`-ssh-public-keys` `filepath` ::
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+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`)::
`-unprivileged` `boolean` (default=`0`)::
-Makes the container run as unprivileged user. (Should not be modified
-manually.)
+Makes the container run as unprivileged user. (Should not be modified manually.)
`-unused[n]` `string` ::
-Reference to unused volumes.
+Reference to unused volumes. This is used internally, and should not be modified manually.
`-cmode` `(console | shell | tty)` (default=`tty`)::
-Console mode. By default, the console command tries to open a connection to
-one of the available tty devices. By setting cmode to 'console' it tries to
-attach to /dev/console instead. If you set cmode to 'shell', it simply
-invokes a shell inside the container (no login).
+Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).
`-console` `boolean` (default=`1`)::
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.
+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`)::
-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.
+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.
`-digest` `string` ::
-Prevent changes if current configuration file has different SHA1 digest.
-This can be used to prevent concurrent modifications.
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-hostname` `string` ::
Amount of RAM for the VM in MB.
-`-mp[n]` `mp=<Path>, [volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
+`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
-Use volume as container mount point (experimental feature).
+Use volume as container mount point.
`-nameserver` `string` ::
-Sets DNS server IP address for a container. Create will automatically use
-the setting from the host if you neither set searchdomain nor nameserver.
+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=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,rate=<mbps>] [,tag=<VlanNo>] [,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=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
Specifies network interfaces for the container.
Specifies whether a VM will be started during system bootup.
-`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` ::
+`-ostype` `(alpine | archlinux | centos | debian | fedora | gentoo | 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.
+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.
`-protection` `boolean` (default=`0`)::
-Sets the protection flag of the container. This will prevent the CT or CT's
-disk remove/update operation.
+Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
-`-rootfs` `[volume=]<volume> [,acl=<acl>] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=<ro>] [,size=<DiskSize>]` ::
+`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,size=<DiskSize>]` ::
Use volume as container root.
`-searchdomain` `string` ::
-Sets DNS search domains for a container. Create will automatically use the
-setting from the host if you neither set searchdomain nor nameserver.
+Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
-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.
+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.
`-swap` `integer (0 - N)` (default=`512`)::
`-unprivileged` `boolean` (default=`0`)::
-Makes the container run as unprivileged user. (Should not be modified
-manually.)
+Makes the container run as unprivileged user. (Should not be modified manually.)
`-unused[n]` `string` ::
-Reference to unused volumes.
+Reference to unused volumes. This is used internally, and should not be modified manually.
+
+*pct status* `<vmid>` `[OPTIONS]`
+
+Show CT status.
+
+`<vmid>` `integer (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`-verbose` `boolean` ::
+
+Verbose output format
+
+
+
+
*pct stop* `<vmid>` `[OPTIONS]`
Stop the container. This will abruptly stop all processes running in the
`-experimental` `boolean` (default=`0`)::
-The template feature is experimental, set this flag if you know what you
-are doing.
+The template feature is experimental, set this flag if you know what you are doing.
projects / pve-docs.git / blobdiff