X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pct.1-synopsis.adoc;h=336ee6ea8836d7444ef6c7ca11ad5b4f64eb2b12;hp=3ecb377f878c53425ab7540660a66ce380680bb8;hb=a3e7e4e35055bbbd908a4c0195c8b8c9ca97c71e;hpb=35a75dd36c05f79e9dda81147867878a55d839c1 diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 3ecb377..336ee6e 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -1,6 +1,6 @@ *pct* ` [ARGS] [OPTIONS]` -*pct clone* ` --experimental ` `[OPTIONS]` +*pct clone* ` ` `[OPTIONS]` Create a container clone/copy @@ -12,17 +12,17 @@ The (unique) ID of the VM. VMID for the clone. -`--description` `` :: +`--bwlimit` ` (0 - N)` ('default =' `clone limit from datacenter or storage config`):: -Description for the new CT. +Override I/O bandwidth limit (in KiB/s). -`--experimental` `` ('default =' `0`):: +`--description` `` :: -The clone feature is experimental, set this flag if you know what you are doing. +Description for the new CT. -`--full` `` ('default =' `0`):: +`--full` `` :: -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 disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. `--hostname` `` :: @@ -39,10 +39,12 @@ The name of the snapshot. `--storage` `` :: Target storage for full clone. -+ -NOTE: Requires option(s): `full` -*pct config* `` +`--target` `` :: + +Target node. Only allowed if the original VM is on shared storage. + +*pct config* `` `[OPTIONS]` Get container configuration. @@ -50,7 +52,11 @@ Get container configuration. The (unique) ID of the VM. -*pct console* `` +`--snapshot` `` :: + +Fetch config values from given snapshot. + +*pct console* `` `[OPTIONS]` Launch a console for the specified container. @@ -58,6 +64,10 @@ Launch a console for the specified container. The (unique) ID of the VM. +`--escape` `\^?[a-z]` ('default =' `^a`):: + +Escape sequence prefix. For example to use as the escape sequence pass '^b'. + *pct cpusets* Print the list of assigned CPU sets. @@ -74,10 +84,14 @@ The (unique) ID of the VM. The OS template or backup file. -`--arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. +`--bwlimit` ` (0 - N)` ('default =' `restore limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + `--cmode` `` ('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). @@ -106,10 +120,18 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0. Container description. Only used on the configuration web interface. +`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=] [,nesting=<1|0>]` :: + +Allow containers access to advanced features. + `--force` `` :: Allow to overwrite existing container. +`--hookscript` `` :: + +Script that will be exectued during various steps in the containers lifetime. + `--hostname` `` :: Set a host name for the container. @@ -118,7 +140,7 @@ Set a host name for the container. Ignore errors when extracting the template. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -146,7 +168,7 @@ Specifies whether a VM will be started during system bootup. OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. -`--password` :: +`--password` `` :: Sets root password inside container. @@ -174,6 +196,10 @@ Sets DNS search domains for a container. Create will automatically use the setti Setup public SSH keys (one key per line, OpenSSH format). +`--start` `` ('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. @@ -194,6 +220,12 @@ Enable/disable Template. Specify the number of tty available to the container +`--unique` `` :: + +Assign a unique random ethernet address. ++ +NOTE: Requires option(s): `restore` + `--unprivileged` `` ('default =' `0`):: Makes the container run as unprivileged user. (Should not be modified manually.) @@ -262,7 +294,7 @@ Run a filesystem check (fsck) on a container volume. The (unique) ID of the VM. -`--device` `` :: +`--device` `` :: A volume on which to run the filesystem check @@ -270,6 +302,14 @@ A volume on which to run the filesystem check Force checking, even if the filesystem seems clean +*pct fstrim* `` + +Run fstrim on a chosen CT and its mountpoints. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + *pct help* `[OPTIONS]` Get help about specified command. @@ -306,6 +346,10 @@ The (unique) ID of the VM. Target node. +`--bwlimit` ` (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + `--force` `` :: Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead. @@ -332,6 +376,34 @@ further operations on the container other than start and stop. The (unique) ID of the VM. +*pct move_volume* ` ` `[OPTIONS]` + +Move a rootfs-/mp-volume to a different storage + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +``: `` :: + +Volume which will be moved. + +``: `` :: + +Target Storage. + +`--bwlimit` ` (0 - N)` ('default =' `clone limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + +`--delete` `` ('default =' `0`):: + +Delete the original volume after successful copy. By default the original is kept as an unused volume entry. + +`--digest` `` :: + +Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. + *pct pull* ` ` `[OPTIONS]` Copy a file from the container to the local system. @@ -388,6 +460,18 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal). Owner user name or id. When using a name it must exist inside the container. +*pct rescan* `[OPTIONS]` + +Rescan all storages and update disk sizes and unused disk images. + +`--dryrun` `` ('default =' `0`):: + +Do not actually write changes out to conifg. + +`--vmid` ` (1 - N)` :: + +The (unique) ID of the VM. + *pct resize* ` ` `[OPTIONS]` Resize a container mount point. @@ -396,7 +480,7 @@ Resize a container mount point. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to resize. @@ -420,10 +504,14 @@ The (unique) ID of the VM. The OS template or backup file. -`--arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. +`--bwlimit` ` (0 - N)` ('default =' `restore limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + `--cmode` `` ('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). @@ -452,10 +540,18 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0. Container description. Only used on the configuration web interface. +`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=] [,nesting=<1|0>]` :: + +Allow containers access to advanced features. + `--force` `` :: Allow to overwrite existing container. +`--hookscript` `` :: + +Script that will be exectued during various steps in the containers lifetime. + `--hostname` `` :: Set a host name for the container. @@ -464,7 +560,7 @@ Set a host name for the container. Ignore errors when extracting the template. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -492,7 +588,7 @@ Specifies whether a VM will be started during system bootup. OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. -`--password` :: +`--password` `` :: Sets root password inside container. @@ -516,6 +612,10 @@ Sets DNS search domains for a container. Create will automatically use the setti Setup public SSH keys (one key per line, OpenSSH format). +`--start` `` ('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. @@ -536,6 +636,12 @@ Enable/disable Template. Specify the number of tty available to the container +`--unique` `` :: + +Assign a unique random ethernet address. ++ +NOTE: Requires option(s): `restore` + `--unprivileged` `` ('default =' `0`):: Makes the container run as unprivileged user. (Should not be modified manually.) @@ -572,7 +678,7 @@ Set container options. The (unique) ID of the VM. -`--arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. @@ -612,11 +718,19 @@ Container description. Only used on the configuration web interface. Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. +`--features` `[fuse=<1|0>] [,keyctl=<1|0>] [,mount=] [,nesting=<1|0>]` :: + +Allow containers access to advanced features. + +`--hookscript` `` :: + +Script that will be exectued during various steps in the containers lifetime. + `--hostname` `` :: Set a host name for the container. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -758,7 +872,7 @@ Suspend the container. The (unique) ID of the VM. -*pct template* ` --experimental ` `[OPTIONS]` +*pct template* `` Create a Template. @@ -766,10 +880,6 @@ Create a Template. The (unique) ID of the VM. -`--experimental` `` ('default =' `0`):: - -The template feature is experimental, set this flag if you know what you are doing. - *pct unlock* `` Unlock the VM.