X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pct.1-synopsis.adoc;h=a04fa47ee2f5e624d6657f72b0155bd4192afbfe;hb=c5aa7e14b592291fa456e0749fcea4b953704b73;hp=0fea00326f57dd5d4e5fb8296ce8925dbf8922bf;hpb=2489d6df4ac5e916ae18401310bfd1e69c993e55;p=pve-docs.git diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index 0fea003..a04fa47 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,13 +39,12 @@ 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* `` +*pct config* `` `[OPTIONS]` Get container configuration. @@ -53,10 +52,15 @@ Get container configuration. The (unique) ID of the VM. +`--current` `` ('default =' `0`):: + +Get current values (instead of pending values). +`--snapshot` `` :: +Fetch config values from given snapshot. -*pct console* `` +*pct console* `` `[OPTIONS]` Launch a console for the specified container. @@ -64,15 +68,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 +88,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). @@ -117,10 +124,18 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0. Container description. Only used on the configuration web interface. +`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<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. @@ -129,7 +144,7 @@ Set a host name for the container. Ignore errors when extracting the template. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -137,7 +152,7 @@ Lock/unlock the VM. Amount of RAM for the VM in MB. -`--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container mount point. @@ -157,7 +172,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. @@ -173,7 +188,7 @@ Sets the protection flag of the container. This will prevent the CT or CT's disk Mark this as restore task. -`--rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--rootfs` `[volume=] [,acl=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container root. @@ -185,6 +200,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. @@ -197,6 +216,10 @@ Default Storage. Amount of SWAP for the VM in MB. +`--tags` `` :: + +Tags of the Container. This is only meta information. + `--template` `` ('default =' `0`):: Enable/disable Template. @@ -205,17 +228,20 @@ 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.) -`--unused[n]` `` :: +`--unused[n]` `[volume=]` :: Reference to unused volumes. This is used internally, and should not be modified manually. - - - *pct delsnapshot* ` ` `[OPTIONS]` Delete a LXC snapshot. @@ -232,10 +258,7 @@ The name of the snapshot. For removal from config file, even if removing disk snapshots fails. - - - -*pct destroy* `` +*pct destroy* `` `[OPTIONS]` Destroy the container (also delete all uses files). @@ -243,8 +266,13 @@ Destroy the container (also delete all uses files). The (unique) ID of the VM. +`--force` `` ('default =' `0`):: + +Force destroy, even if running. +`--purge` `` ('default =' `0`):: +Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed. *pct df* `` @@ -254,8 +282,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 +290,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 +302,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 +310,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 +318,30 @@ 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]` +*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 +350,6 @@ List all snapshots. The (unique) ID of the VM. - - - *pct migrate* ` ` `[OPTIONS]` Migrate the container to another node. Creates a new migration task. @@ -344,6 +362,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. @@ -360,9 +382,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 +392,41 @@ 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 pending* `` + +Get container configuration, including pending changes. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. *pct pull* ` ` `[OPTIONS]` @@ -403,8 +456,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 +484,30 @@ 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 reboot* `` `[OPTIONS]` + +Reboot the container by shutting it down, and starting it again. Applies +pending changes. + +``: ` (1 - N)` :: + +The (unique) ID of the VM. + +`--timeout` ` (0 - N)` :: + +Wait maximal timeout seconds for the shutdown. + +*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 +517,7 @@ Resize a container mount point. The (unique) ID of the VM. -``: `` :: +``: `` :: The disk you want to resize. @@ -456,8 +529,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 +541,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). @@ -502,10 +577,18 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0. Container description. Only used on the configuration web interface. +`--features` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<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. @@ -514,7 +597,7 @@ Set a host name for the container. Ignore errors when extracting the template. -`--lock` `` :: +`--lock` `` :: Lock/unlock the VM. @@ -522,7 +605,7 @@ Lock/unlock the VM. Amount of RAM for the VM in MB. -`--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container mount point. @@ -542,7 +625,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. @@ -554,7 +637,7 @@ Add the VM to the specified pool. Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. -`--rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--rootfs` `[volume=] [,acl=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container root. @@ -566,6 +649,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. @@ -578,6 +665,10 @@ Default Storage. Amount of SWAP for the VM in MB. +`--tags` `` :: + +Tags of the Container. This is only meta information. + `--template` `` ('default =' `0`):: Enable/disable Template. @@ -586,17 +677,20 @@ 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.) -`--unused[n]` `` :: +`--unused[n]` `[volume=]` :: Reference to unused volumes. This is used internally, and should not be modified manually. - - - *pct resume* `` Resume the container. @@ -605,9 +699,6 @@ Resume the container. The (unique) ID of the VM. - - - *pct rollback* ` ` Rollback LXC state to specified snapshot. @@ -620,9 +711,6 @@ The (unique) ID of the VM. The name of the snapshot. - - - *pct set* `` `[OPTIONS]` Set container options. @@ -631,7 +719,7 @@ Set container options. The (unique) ID of the VM. -`--arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. @@ -671,11 +759,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` `[force_rw_sys=<1|0>] [,fuse=<1|0>] [,keyctl=<1|0>] [,mknod=<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. @@ -683,7 +779,7 @@ Lock/unlock the VM. Amount of RAM for the VM in MB. -`--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--mp[n]` `[volume=] ,mp= [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container mount point. @@ -707,7 +803,11 @@ OS type. This is used to setup configuration inside the container, and correspon Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. -`--rootfs` `[volume=] [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: +`--revert` `` :: + +Revert a pending change. + +`--rootfs` `[volume=] [,acl=<1|0>] [,mountoptions=] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=]` :: Use volume as container root. @@ -723,6 +823,10 @@ Startup and shutdown behavior. Order is a non-negative number defining the gener Amount of SWAP for the VM in MB. +`--tags` `` :: + +Tags of the Container. This is only meta information. + `--template` `` ('default =' `0`):: Enable/disable Template. @@ -735,13 +839,10 @@ Specify the number of tty available to the container Makes the container run as unprivileged user. (Should not be modified manually.) -`--unused[n]` `` :: +`--unused[n]` `[volume=]` :: 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 +860,6 @@ Make sure the Container stops. Wait maximal timeout seconds. - - - *pct snapshot* ` ` `[OPTIONS]` Snapshot a container. @@ -778,9 +876,6 @@ The name of the snapshot. A textual description or comment. - - - *pct start* `` `[OPTIONS]` Start the container. @@ -793,9 +888,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 +900,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 +913,6 @@ The (unique) ID of the VM. Ignore locks - only root is allowed to use this option. - - *pct suspend* `` Suspend the container. @@ -834,10 +921,7 @@ Suspend the container. The (unique) ID of the VM. - - - -*pct template* ` --experimental ` `[OPTIONS]` +*pct template* `` Create a Template. @@ -845,13 +929,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 +937,6 @@ Unlock the VM. The (unique) ID of the VM. - - *pct unmount* `` Unmount the container's filesystem. @@ -871,5 +946,3 @@ Unmount the container's filesystem. The (unique) ID of the VM. - -