X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pct.1-synopsis.adoc;h=433a1c1ae73bf70e6ff179d7f1d4dfb6888df0b5;hp=0fea00326f57dd5d4e5fb8296ce8925dbf8922bf;hb=94958b8b9230d5b9b5e2e70c481f115b18a5fa0b;hpb=2489d6df4ac5e916ae18401310bfd1e69c993e55 diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 0fea003..433a1c1 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 @@ -16,13 +16,9 @@ VMID for the clone. Description for the new CT. -`--experimental` `` ('default =' `0`):: +`--full` `` :: -The clone feature is experimental, set this flag if you know what you are doing. - -`--full` `` ('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 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,11 +35,10 @@ The name of the snapshot. `--storage` `` :: Target storage for full clone. -+ -NOTE: Requires option(s): `full` - +`--target` `` :: +Target node. Only allowed if the original VM is on shared storage. *pct config* `` @@ -53,10 +48,7 @@ Get container configuration. The (unique) ID of the VM. - - - -*pct console* `` +*pct console* `` `[OPTIONS]` Launch a console for the specified container. @@ -64,15 +56,14 @@ 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. - - - *pct create* ` ` `[OPTIONS]` Create or restore a container. @@ -85,10 +76,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)` :: + +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). @@ -117,6 +112,10 @@ 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. @@ -129,7 +128,7 @@ Set a host name for the container. Ignore errors when extracting the template. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -157,7 +156,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. @@ -185,6 +184,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. @@ -213,9 +216,6 @@ Makes the container run as unprivileged user. (Should not be modified manually.) Reference to unused volumes. This is used internally, and should not be modified manually. - - - *pct delsnapshot* ` ` `[OPTIONS]` Delete a LXC snapshot. @@ -232,9 +232,6 @@ The name of the snapshot. For removal from config file, even if removing disk snapshots fails. - - - *pct destroy* `` Destroy the container (also delete all uses files). @@ -243,9 +240,6 @@ Destroy the container (also delete all uses files). The (unique) ID of the VM. - - - *pct df* `` Get the container's current disk usage. @@ -254,8 +248,6 @@ Get the container's current disk usage. The (unique) ID of the VM. - - *pct enter* `` Launch a shell for the specified container. @@ -264,8 +256,6 @@ Launch a shell for the specified container. The (unique) ID of the VM. - - *pct exec* ` []` Launch a command inside the specified container. @@ -278,8 +268,6 @@ The (unique) ID of the VM. Extra arguments as array - - *pct fsck* `` `[OPTIONS]` Run a filesystem check (fsck) on a container volume. @@ -288,7 +276,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 @@ -296,31 +284,22 @@ A volume on which to run the filesystem check Force checking, even if the filesystem seems clean - - - -*pct help* `[]` `[OPTIONS]` +*pct help* `[OPTIONS]` Get help about specified command. -``: `` :: +`--extra-args` `` :: -Command name +Shows help for a specific command `--verbose` `` :: Verbose output format. - - - *pct list* LXC container index (per node). - - - *pct listsnapshot* `` List all snapshots. @@ -329,9 +308,6 @@ List all snapshots. The (unique) ID of the VM. - - - *pct migrate* ` ` `[OPTIONS]` Migrate the container to another node. Creates a new migration task. @@ -360,9 +336,6 @@ Use restart migration Timeout in seconds for shutdown for restart migration - - - *pct mount* `` Mount the container's filesystem on the host. This will hold a lock on the @@ -373,7 +346,29 @@ 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. + +`--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]` @@ -403,8 +398,6 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal). Owner user name or id. - - *pct push* ` ` `[OPTIONS]` Copy a local file to the container. @@ -433,8 +426,17 @@ 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]` @@ -444,7 +446,7 @@ Resize a container mount point. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to resize. @@ -456,8 +458,6 @@ The new size. With the '+' sign the value is added to the actual size of the vol Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. - - *pct restore* ` ` `[OPTIONS]` Create or restore a container. @@ -470,10 +470,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)` :: + +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). @@ -502,6 +506,10 @@ 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. @@ -514,7 +522,7 @@ Set a host name for the container. Ignore errors when extracting the template. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -542,7 +550,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. @@ -566,6 +574,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. @@ -594,9 +606,6 @@ Makes the container run as unprivileged user. (Should not be modified manually.) Reference to unused volumes. This is used internally, and should not be modified manually. - - - *pct resume* `` Resume the container. @@ -605,9 +614,6 @@ Resume the container. The (unique) ID of the VM. - - - *pct rollback* ` ` Rollback LXC state to specified snapshot. @@ -620,9 +626,6 @@ The (unique) ID of the VM. The name of the snapshot. - - - *pct set* `` `[OPTIONS]` Set container options. @@ -631,7 +634,7 @@ Set container options. The (unique) ID of the VM. -`--arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. @@ -671,11 +674,15 @@ 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. + `--hostname` `` :: Set a host name for the container. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -739,9 +746,6 @@ Makes the container run as unprivileged user. (Should not be modified manually.) Reference to unused volumes. This is used internally, and should not be modified manually. - - - *pct shutdown* `` `[OPTIONS]` Shutdown the container. This will trigger a clean shutdown of the @@ -759,9 +763,6 @@ Make sure the Container stops. Wait maximal timeout seconds. - - - *pct snapshot* ` ` `[OPTIONS]` Snapshot a container. @@ -778,9 +779,6 @@ The name of the snapshot. A textual description or comment. - - - *pct start* `` `[OPTIONS]` Start the container. @@ -793,9 +791,6 @@ The (unique) ID of the VM. Ignore locks - only root is allowed to use this option. - - - *pct status* `` `[OPTIONS]` Show CT status. @@ -808,9 +803,6 @@ The (unique) ID of the VM. Verbose output format - - - *pct stop* `` `[OPTIONS]` Stop the container. This will abruptly stop all processes running in the @@ -824,8 +816,6 @@ The (unique) ID of the VM. Ignore locks - only root is allowed to use this option. - - *pct suspend* `` Suspend the container. @@ -834,10 +824,7 @@ Suspend the container. The (unique) ID of the VM. - - - -*pct template* ` --experimental ` `[OPTIONS]` +*pct template* `` Create a Template. @@ -845,13 +832,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. @@ -860,8 +840,6 @@ Unlock the VM. The (unique) ID of the VM. - - *pct unmount* `` Unmount the container's filesystem. @@ -871,5 +849,3 @@ Unmount the container's filesystem. The (unique) ID of the VM. - -