X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pct.1-synopsis.adoc;h=50960334c96f6aa66dac6bf4bdadad94ca9402b4;hp=e8a48465fa655b1492ab5296ee520bd05f529e15;hb=HEAD;hpb=4e7f60c22018b712dc9ed021ac0e3c5e47606444 diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index e8a4846..47e8304 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -4,11 +4,11 @@ Create a container clone/copy -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: VMID for the clone. @@ -36,7 +36,7 @@ Add the new CT to the specified pool. The name of the snapshot. -`--storage` `` :: +`--storage` `` :: Target storage for full clone. @@ -48,7 +48,7 @@ Target node. Only allowed if the original VM is on shared storage. Get container configuration. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -64,7 +64,7 @@ Fetch config values from given snapshot. Launch a console for the specified container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -80,7 +80,7 @@ Print the list of assigned CPU sets. Create or restore a container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -88,7 +88,7 @@ The (unique) ID of the VM. The OS template or backup file. -`--arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. @@ -126,6 +126,10 @@ Try to be more verbose. For now this only enables debug log-level on start. Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. +`--dev[n]` `[[path=]] [,gid=] [,mode=] [,uid=]` :: + +Device to pass through to the container + `--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. @@ -162,7 +166,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G 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= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: +`--net[n]` `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. @@ -210,7 +214,7 @@ Start the CT after its creation finished successfully. 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` `` ('default =' `local`):: +`--storage` `` ('default =' `local`):: Default Storage. @@ -252,7 +256,7 @@ Reference to unused volumes. This is used internally, and should not be modified Delete a LXC snapshot. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -268,7 +272,7 @@ For removal from config file, even if removing disk snapshots fails. Destroy the container (also delete all uses files). -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -288,23 +292,27 @@ Remove container from all related configurations. For example, backup jobs, repl Get the container's current disk usage. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -*pct enter* `` +*pct enter* `` `[OPTIONS]` Launch a shell for the specified container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -*pct exec* ` []` +`--keep-env` `` ('default =' `1`):: + +Keep the current environment. This option will disabled by default with PVE 9. If you rely on a preserved environment, please use this option to be future-proof. + +*pct exec* ` []` `[OPTIONS]` Launch a command inside the specified container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -312,11 +320,15 @@ The (unique) ID of the VM. Extra arguments as array +`--keep-env` `` ('default =' `1`):: + +Keep the current environment. This option will disabled by default with PVE 9. If you rely on a preserved environment, please use this option to be future-proof. + *pct fsck* `` `[OPTIONS]` Run a filesystem check (fsck) on a container volume. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -330,9 +342,10 @@ Force checking, even if the filesystem seems clean *pct fstrim* `` `[OPTIONS]` -Run fstrim on a chosen CT and its mountpoints. +Run fstrim on a chosen CT and its mountpoints, except bind or read-only +mountpoints. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -360,7 +373,7 @@ LXC container index (per node). List all snapshots. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -368,7 +381,7 @@ The (unique) ID of the VM. Migrate the container to another node. Creates a new migration task. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -402,7 +415,7 @@ 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. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -411,7 +424,7 @@ The (unique) ID of the VM. Move a rootfs-/mp-volume to a different storage or to a different container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -419,11 +432,11 @@ The (unique) ID of the VM. Volume which will be moved. -``: `` :: +``: `` :: Target Storage. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -458,7 +471,7 @@ An alias for 'pct move-volume'. Get container configuration, including pending changes. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -466,7 +479,7 @@ The (unique) ID of the VM. Copy a file from the container to the local system. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -494,7 +507,7 @@ Owner user name or id. Copy a local file to the container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -523,7 +536,7 @@ Owner user name or id. When using a name it must exist inside the container. Reboot the container by shutting it down, and starting it again. Applies pending changes. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -531,6 +544,51 @@ The (unique) ID of the VM. Wait maximal timeout seconds for the shutdown. +*pct remote-migrate* ` [] --target-bridge --target-storage ` `[OPTIONS]` + +Migrate container to a remote cluster. Creates a new migration task. +EXPERIMENTAL feature! + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: ` (100 - 999999999)` :: + +The (unique) ID of the VM. + +``: `apitoken= ,host=
[,fingerprint=] [,port=]` :: + +Remote target endpoint + +`--bwlimit` ` (0 - N)` ('default =' `migrate limit from datacenter or storage config`):: + +Override I/O bandwidth limit (in KiB/s). + +`--delete` `` ('default =' `0`):: + +Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state. + +`--online` `` :: + +Use online/live migration. + +`--restart` `` :: + +Use restart migration + +`--target-bridge` `` :: + +Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. + +`--target-storage` `` :: + +Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. + +`--timeout` `` ('default =' `180`):: + +Timeout in seconds for shutdown for restart migration + *pct rescan* `[OPTIONS]` Rescan all storages and update disk sizes and unused disk images. @@ -539,7 +597,7 @@ Rescan all storages and update disk sizes and unused disk images. Do not actually write changes out to conifg. -`--vmid` ` (1 - N)` :: +`--vmid` ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -547,7 +605,7 @@ The (unique) ID of the VM. Resize a container mount point. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -567,7 +625,7 @@ Prevent changes if current configuration file has different SHA1 digest. This ca Create or restore a container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -575,7 +633,7 @@ The (unique) ID of the VM. The OS template or backup file. -`--arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. @@ -613,6 +671,10 @@ Try to be more verbose. For now this only enables debug log-level on start. Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. +`--dev[n]` `[[path=]] [,gid=] [,mode=] [,uid=]` :: + +Device to pass through to the container + `--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. @@ -649,7 +711,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G 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= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: +`--net[n]` `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. @@ -693,7 +755,7 @@ Start the CT after its creation finished successfully. 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` `` ('default =' `local`):: +`--storage` `` ('default =' `local`):: Default Storage. @@ -735,7 +797,7 @@ Reference to unused volumes. This is used internally, and should not be modified Resume the container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -743,7 +805,7 @@ The (unique) ID of the VM. Rollback LXC state to specified snapshot. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -759,11 +821,11 @@ Whether the container should get started after rolling back successfully Set container options. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. -`--arch` `` ('default =' `amd64`):: +`--arch` `` ('default =' `amd64`):: OS architecture type. @@ -801,6 +863,10 @@ A list of settings you want to delete. Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. +`--dev[n]` `[[path=]] [,gid=] [,mode=] [,uid=]` :: + +Device to pass through to the container + `--digest` `` :: Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. @@ -833,7 +899,7 @@ Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_G 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= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: +`--net[n]` `name= [,bridge=] [,firewall=<1|0>] [,gw=] [,gw6=] [,hwaddr=] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,link_down=<1|0>] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. @@ -898,7 +964,7 @@ Reference to unused volumes. This is used internally, and should not be modified Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -914,7 +980,7 @@ Wait maximal timeout seconds. Snapshot a container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -930,7 +996,7 @@ A textual description or comment. Start the container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -946,7 +1012,7 @@ Ignore locks - only root is allowed to use this option. Show CT status. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -959,10 +1025,14 @@ Verbose output format Stop the container. This will abruptly stop all processes running in the container. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. +`--overrule-shutdown` `` ('default =' `0`):: + +Try to abort active 'vzshutdown' tasks before stopping. + `--skiplock` `` :: Ignore locks - only root is allowed to use this option. @@ -971,7 +1041,7 @@ Ignore locks - only root is allowed to use this option. Suspend the container. This is experimental. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -979,7 +1049,7 @@ The (unique) ID of the VM. Create a Template. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -987,7 +1057,7 @@ The (unique) ID of the VM. Unlock the VM. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM. @@ -995,7 +1065,7 @@ The (unique) ID of the VM. Unmount the container's filesystem. -``: ` (1 - N)` :: +``: ` (100 - 999999999)` :: The (unique) ID of the VM.