output-format.adoc: fix typo

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

*pct* `<COMMAND> [ARGS] [OPTIONS]`

*pct clone* `<vmid> <newid>` `[OPTIONS]`

Create a container clone/copy

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<newid>`: `<integer> (1 - N)` ::

VMID for the clone.

`--description` `<string>` ::

Description for the new CT.

`--full` `<boolean>` ::

Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.

`--hostname` `<string>` ::

Set a hostname for the new CT.

`--pool` `<string>` ::

Add the new CT to the specified pool.

`--snapname` `<string>` ::

The name of the snapshot.

`--storage` `<string>` ::

Target storage for full clone.

`--target` `<string>` ::

Target node. Only allowed if the original VM is on shared storage.

*pct config* `<vmid>`

Get container configuration.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*pct console* `<vmid>`

Launch a console for the specified container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*pct cpusets*

Print the list of assigned CPU sets.

*pct create* `<vmid> <ostemplate>` `[OPTIONS]`

Create or restore a container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<ostemplate>`: `<string>` ::

The OS template or backup file.

`--arch` `<amd64 | i386>` ('default =' `amd64`)::

OS architecture type.

`--bwlimit` `<number> (0 - N)` ::

Override i/o bandwidth limit (in KiB/s).

`--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` `<boolean>` ('default =' `1`)::

Attach a console device (/dev/console) to the container.

`--cores` `<integer> (1 - 128)` ::

The number of cores assigned to the container. A container can use all available cores by default.

`--cpulimit` `<number> (0 - 128)` ('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`)::

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.

`--description` `<string>` ::

Container description. Only used on the configuration web interface.

`--force` `<boolean>` ::

Allow to overwrite existing container.

`--hostname` `<string>` ::

Set a host name for the container.

`--ignore-unpack-errors` `<boolean>` ::

Ignore errors when extracting the template.

`--lock` `<backup | migrate | rollback | snapshot>` ::

Lock/unlock the VM.

`--memory` `<integer> (16 - N)` ('default =' `512`)::

Amount of RAM for the VM in MB.

`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::

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.

`--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>]` ::

Specifies network interfaces for the container.

`--onboot` `<boolean>` ('default =' `0`)::

Specifies whether a VM will be started during system bootup.

`--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.

`--password` `<password>` ::

Sets root password inside container.

`--pool` `<string>` ::

Add the VM to the specified pool.

`--protection` `<boolean>` ('default =' `0`)::

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=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<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.

`--ssh-public-keys` `<filepath>` ::

Setup public SSH keys (one key per line, OpenSSH format).

`--start` `<boolean>` ('default =' `0`)::

Start the CT after its creation finished successfully.

`--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.

`--storage` `<string>` ('default =' `local`)::

Default Storage.

`--swap` `<integer> (0 - N)` ('default =' `512`)::

Amount of SWAP for the VM in MB.

`--template` `<boolean>` ('default =' `0`)::

Enable/disable Template.

`--tty` `<integer> (0 - 6)` ('default =' `2`)::

Specify the number of tty available to the container

`--unprivileged` `<boolean>` ('default =' `0`)::

Makes the container run as unprivileged user. (Should not be modified manually.)

`--unused[n]` `<string>` ::

Reference to unused volumes. This is used internally, and should not be modified manually.

*pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`

Delete a LXC snapshot.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<snapname>`: `<string>` ::

The name of the snapshot.

`--force` `<boolean>` ::

For removal from config file, even if removing disk snapshots fails.

*pct destroy* `<vmid>`

Destroy the container (also delete all uses files).

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*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.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*pct exec* `<vmid> [<extra-args>]`

Launch a command inside the specified container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<extra-args>`: `<array>` ::

Extra arguments as array

*pct fsck* `<vmid>` `[OPTIONS]`

Run a filesystem check (fsck) on a container volume.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`--device` `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::

A volume on which to run the filesystem check

`--force` `<boolean>` ('default =' `0`)::

Force checking, even if the filesystem seems clean

*pct help* `[OPTIONS]`

Get help about specified command.

`--extra-args` `<array>` ::

Shows help for a specific command

`--verbose` `<boolean>` ::

Verbose output format.

*pct list*

LXC container index (per node).

*pct listsnapshot* `<vmid>`

List all snapshots.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*pct migrate* `<vmid> <target>` `[OPTIONS]`

Migrate the container to another node. Creates a new migration task.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<target>`: `<string>` ::

Target node.

`--force` `<boolean>` ::

Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.

`--online` `<boolean>` ::

Use online/live migration.

`--restart` `<boolean>` ::

Use restart migration

`--timeout` `<integer>` ('default =' `180`)::

Timeout in seconds for shutdown for restart migration

*pct mount* `<vmid>`

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)` ::

The (unique) ID of the VM.

*pct move_volume* `<vmid> <volume> <storage>` `[OPTIONS]`

Move a rootfs-/mp-volume to a different storage

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<volume>`: `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::

Volume which will be moved.

`<storage>`: `<string>` ::

Target Storage.

`--delete` `<boolean>` ('default =' `0`)::

Delete the original volume after successful copy. By default the original is kept as an unused volume entry.

`--digest` `<string>` ::

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

*pct pull* `<vmid> <path> <destination>` `[OPTIONS]`

Copy a file from the container to the local system.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<path>`: `<string>` ::

Path to a file inside the container to pull.

`<destination>`: `<string>` ::

Destination

`--group` `<string>` ::

Owner group name or id.

`--perms` `<string>` ::

File permissions to use (octal by default, prefix with '0x' for hexadecimal).

`--user` `<string>` ::

Owner user name or id.

*pct push* `<vmid> <file> <destination>` `[OPTIONS]`

Copy a local file to the container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<file>`: `<string>` ::

Path to a local file.

`<destination>`: `<string>` ::

Destination inside the container to write to.

`--group` `<string>` ::

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).

`--user` `<string>` ::

Owner user name or id. When using a name it must exist inside the container.

*pct resize* `<vmid> <disk> <size>` `[OPTIONS]`

Resize a container mount point.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<disk>`: `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::

The disk you want to resize.

`<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.

`--digest` `<string>` ::

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

*pct restore* `<vmid> <ostemplate>` `[OPTIONS]`

Create or restore a container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<ostemplate>`: `<string>` ::

The OS template or backup file.

`--arch` `<amd64 | i386>` ('default =' `amd64`)::

OS architecture type.

`--bwlimit` `<number> (0 - N)` ::

Override i/o bandwidth limit (in KiB/s).

`--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` `<boolean>` ('default =' `1`)::

Attach a console device (/dev/console) to the container.

`--cores` `<integer> (1 - 128)` ::

The number of cores assigned to the container. A container can use all available cores by default.

`--cpulimit` `<number> (0 - 128)` ('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`)::

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.

`--description` `<string>` ::

Container description. Only used on the configuration web interface.

`--force` `<boolean>` ::

Allow to overwrite existing container.

`--hostname` `<string>` ::

Set a host name for the container.

`--ignore-unpack-errors` `<boolean>` ::

Ignore errors when extracting the template.

`--lock` `<backup | migrate | rollback | snapshot>` ::

Lock/unlock the VM.

`--memory` `<integer> (16 - N)` ('default =' `512`)::

Amount of RAM for the VM in MB.

`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::

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.

`--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>]` ::

Specifies network interfaces for the container.

`--onboot` `<boolean>` ('default =' `0`)::

Specifies whether a VM will be started during system bootup.

`--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.

`--password` `<password>` ::

Sets root password inside container.

`--pool` `<string>` ::

Add the VM to the specified pool.

`--protection` `<boolean>` ('default =' `0`)::

Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.

`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<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.

`--ssh-public-keys` `<filepath>` ::

Setup public SSH keys (one key per line, OpenSSH format).

`--start` `<boolean>` ('default =' `0`)::

Start the CT after its creation finished successfully.

`--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.

`--storage` `<string>` ('default =' `local`)::

Default Storage.

`--swap` `<integer> (0 - N)` ('default =' `512`)::

Amount of SWAP for the VM in MB.

`--template` `<boolean>` ('default =' `0`)::

Enable/disable Template.

`--tty` `<integer> (0 - 6)` ('default =' `2`)::

Specify the number of tty available to the container

`--unprivileged` `<boolean>` ('default =' `0`)::

Makes the container run as unprivileged user. (Should not be modified manually.)

`--unused[n]` `<string>` ::

Reference to unused volumes. This is used internally, and should not be modified manually.

*pct resume* `<vmid>`

Resume the container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*pct rollback* `<vmid> <snapname>`

Rollback LXC state to specified snapshot.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<snapname>`: `<string>` ::

The name of the snapshot.

*pct set* `<vmid>` `[OPTIONS]`

Set container options.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`--arch` `<amd64 | i386>` ('default =' `amd64`)::

OS architecture type.

`--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` `<boolean>` ('default =' `1`)::

Attach a console device (/dev/console) to the container.

`--cores` `<integer> (1 - 128)` ::

The number of cores assigned to the container. A container can use all available cores by default.

`--cpulimit` `<number> (0 - 128)` ('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`)::

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.

`--delete` `<string>` ::

A list of settings you want to delete.

`--description` `<string>` ::

Container description. Only used on the configuration web interface.

`--digest` `<string>` ::

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

`--hostname` `<string>` ::

Set a host name for the container.

`--lock` `<backup | migrate | rollback | snapshot>` ::

Lock/unlock the VM.

`--memory` `<integer> (16 - N)` ('default =' `512`)::

Amount of RAM for the VM in MB.

`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::

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.

`--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>]` ::

Specifies network interfaces for the container.

`--onboot` `<boolean>` ('default =' `0`)::

Specifies whether a VM will be started during system bootup.

`--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.

`--protection` `<boolean>` ('default =' `0`)::

Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.

`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<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.

`--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.

`--swap` `<integer> (0 - N)` ('default =' `512`)::

Amount of SWAP for the VM in MB.

`--template` `<boolean>` ('default =' `0`)::

Enable/disable Template.

`--tty` `<integer> (0 - 6)` ('default =' `2`)::

Specify the number of tty available to the container

`--unprivileged` `<boolean>` ('default =' `0`)::

Makes the container run as unprivileged user. (Should not be modified manually.)

`--unused[n]` `<string>` ::

Reference to unused volumes. This is used internally, and should not be modified manually.

*pct shutdown* `<vmid>` `[OPTIONS]`

Shutdown the container. This will trigger a clean shutdown of the
container, see lxc-stop(1) for details.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`--forceStop` `<boolean>` ('default =' `0`)::

Make sure the Container stops.

`--timeout` `<integer> (0 - N)` ('default =' `60`)::

Wait maximal timeout seconds.

*pct snapshot* `<vmid> <snapname>` `[OPTIONS]`

Snapshot a container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`<snapname>`: `<string>` ::

The name of the snapshot.

`--description` `<string>` ::

A textual description or comment.

*pct start* `<vmid>` `[OPTIONS]`

Start the container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`--skiplock` `<boolean>` ::

Ignore locks - only root is allowed to use this option.

*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
container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

`--skiplock` `<boolean>` ::

Ignore locks - only root is allowed to use this option.

*pct suspend* `<vmid>`

Suspend the container.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*pct template* `<vmid>`

Create a Template.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*pct unlock* `<vmid>`

Unlock the VM.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*pct unmount* `<vmid>`

Unmount the container's filesystem.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.