]> git.proxmox.com Git - pve-docs.git/blobdiff - pct.1-synopsis.adoc
certificate-managment.adoc: describe dir change
[pve-docs.git] / pct.1-synopsis.adoc
index 0fea00326f57dd5d4e5fb8296ce8925dbf8922bf..24d1f3d69ec7dc0b4dd355b48b784310f81e4308 100644 (file)
@@ -1,6 +1,6 @@
 *pct* `<COMMAND> [ARGS] [OPTIONS]`
 
-*pct clone* `<vmid> <newid> --experimental <boolean>` `[OPTIONS]`
+*pct clone* `<vmid> <newid>` `[OPTIONS]`
 
 Create a container clone/copy
 
@@ -16,13 +16,9 @@ VMID for the clone.
 
 Description for the new CT.
 
-`--experimental` `<boolean>` ('default =' `0`)::
+`--full` `<boolean>` ::
 
-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 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>` ::
 
@@ -39,11 +35,10 @@ The name of the snapshot.
 `--storage` `<string>` ::
 
 Target storage for full clone.
-+
-NOTE: Requires option(s): `full`
-
 
+`--target` `<string>` ::
 
+Target node. Only allowed if the original VM is on shared storage.
 
 *pct config* `<vmid>`
 
@@ -53,9 +48,6 @@ Get container configuration.
 
 The (unique) ID of the VM.
 
-
-
-
 *pct console* `<vmid>`
 
 Launch a console for the specified container.
@@ -64,15 +56,10 @@ Launch a console for the specified container.
 
 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.
@@ -89,6 +76,10 @@ The OS template or backup file.
 
 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).
@@ -157,7 +148,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/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 
-`--password` ::
+`--password` `<password>` ::
 
 Sets root password inside container.
 
@@ -185,6 +176,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` `<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.
@@ -213,9 +208,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* `<vmid> <snapname>` `[OPTIONS]`
 
 Delete a LXC snapshot.
@@ -232,9 +224,6 @@ The name of the snapshot.
 
 For removal from config file, even if removing disk snapshots fails.
 
-
-
-
 *pct destroy* `<vmid>`
 
 Destroy the container (also delete all uses files).
@@ -243,9 +232,6 @@ Destroy the container (also delete all uses files).
 
 The (unique) ID of the VM.
 
-
-
-
 *pct df* `<vmid>`
 
 Get the container's current disk usage.
@@ -254,8 +240,6 @@ Get the container's current disk usage.
 
 The (unique) ID of the VM.
 
-
-
 *pct enter* `<vmid>`
 
 Launch a shell for the specified container.
@@ -264,8 +248,6 @@ Launch a shell for the specified container.
 
 The (unique) ID of the VM.
 
-
-
 *pct exec* `<vmid> [<extra-args>]`
 
 Launch a command inside the specified container.
@@ -278,8 +260,6 @@ The (unique) ID of the VM.
 
 Extra arguments as array
 
-
-
 *pct fsck* `<vmid>` `[OPTIONS]`
 
 Run a filesystem check (fsck) on a container volume.
@@ -296,31 +276,22 @@ A volume on which to run the filesystem check
 
 Force checking, even if the filesystem seems clean
 
-
-
-
-*pct help* `[<cmd>]` `[OPTIONS]`
+*pct help* `[OPTIONS]`
 
 Get help about specified command.
 
-`<cmd>`: `<string>` ::
+`--extra-args` `<array>` ::
 
-Command name
+Shows help for a specific command
 
 `--verbose` `<boolean>` ::
 
 Verbose output format.
 
-
-
-
 *pct list*
 
 LXC container index (per node).
 
-
-
-
 *pct listsnapshot* `<vmid>`
 
 List all snapshots.
@@ -329,9 +300,6 @@ List all snapshots.
 
 The (unique) ID of the VM.
 
-
-
-
 *pct migrate* `<vmid> <target>` `[OPTIONS]`
 
 Migrate the container to another node. Creates a new migration task.
@@ -360,9 +328,6 @@ Use restart migration
 
 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
@@ -373,7 +338,29 @@ further operations on the container other than start and stop.
 
 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]`
 
@@ -403,8 +390,6 @@ File permissions to use (octal by default, prefix with '0x' for hexadecimal).
 
 Owner user name or id.
 
-
-
 *pct push* `<vmid> <file> <destination>` `[OPTIONS]`
 
 Copy a local file to the container.
@@ -433,9 +418,6 @@ 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 resize* `<vmid> <disk> <size>` `[OPTIONS]`
 
 Resize a container mount point.
@@ -456,8 +438,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* `<vmid> <ostemplate>` `[OPTIONS]`
 
 Create or restore a container.
@@ -474,6 +454,10 @@ The OS template or backup file.
 
 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).
@@ -542,7 +526,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/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
 
-`--password` ::
+`--password` `<password>` ::
 
 Sets root password inside container.
 
@@ -566,6 +550,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` `<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.
@@ -594,9 +582,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* `<vmid>`
 
 Resume the container.
@@ -605,9 +590,6 @@ Resume the container.
 
 The (unique) ID of the VM.
 
-
-
-
 *pct rollback* `<vmid> <snapname>`
 
 Rollback LXC state to specified snapshot.
@@ -620,9 +602,6 @@ The (unique) ID of the VM.
 
 The name of the snapshot.
 
-
-
-
 *pct set* `<vmid>` `[OPTIONS]`
 
 Set container options.
@@ -739,9 +718,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* `<vmid>` `[OPTIONS]`
 
 Shutdown the container. This will trigger a clean shutdown of the
@@ -759,9 +735,6 @@ Make sure the Container stops.
 
 Wait maximal timeout seconds.
 
-
-
-
 *pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
 
 Snapshot a container.
@@ -778,9 +751,6 @@ The name of the snapshot.
 
 A textual description or comment.
 
-
-
-
 *pct start* `<vmid>` `[OPTIONS]`
 
 Start the container.
@@ -793,9 +763,6 @@ The (unique) ID of the VM.
 
 Ignore locks - only root is allowed to use this option.
 
-
-
-
 *pct status* `<vmid>` `[OPTIONS]`
 
 Show CT status.
@@ -808,9 +775,6 @@ The (unique) ID of the VM.
 
 Verbose output format
 
-
-
-
 *pct stop* `<vmid>` `[OPTIONS]`
 
 Stop the container. This will abruptly stop all processes running in the
@@ -824,8 +788,6 @@ The (unique) ID of the VM.
 
 Ignore locks - only root is allowed to use this option.
 
-
-
 *pct suspend* `<vmid>`
 
 Suspend the container.
@@ -834,10 +796,7 @@ Suspend the container.
 
 The (unique) ID of the VM.
 
-
-
-
-*pct template* `<vmid> --experimental <boolean>` `[OPTIONS]`
+*pct template* `<vmid>`
 
 Create a Template.
 
@@ -845,13 +804,6 @@ Create a Template.
 
 The (unique) ID of the VM.
 
-`--experimental` `<boolean>` ('default =' `0`)::
-
-The template feature is experimental, set this flag if you know what you are doing.
-
-
-
-
 *pct unlock* `<vmid>`
 
 Unlock the VM.
@@ -860,8 +812,6 @@ Unlock the VM.
 
 The (unique) ID of the VM.
 
-
-
 *pct unmount* `<vmid>`
 
 Unmount the container's filesystem.
@@ -871,5 +821,3 @@ Unmount the container's filesystem.
 The (unique) ID of the VM.
 
 
-
-