From: Dietmar Maurer Date: Thu, 7 Apr 2016 06:20:32 +0000 (+0200) Subject: update synopsis files X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=9b3e4991113526213b75551d302c8d73deb0b6ed update synopsis files --- diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc index f3396be..4b517d7 100644 --- a/pct.1-synopsis.adoc +++ b/pct.1-synopsis.adoc @@ -1,5 +1,52 @@ *pct* ` [ARGS] [OPTIONS]` +*pct clone* ` -experimental ` `[OPTIONS]` + +Create a container clone/copy + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `integer (1 - N)` :: + +VMID for the clone. + +`-description` `string` :: + +Description for the new CT. + +`-experimental` `boolean` (default=`0`):: + +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. + +`-hostname` `string` :: + +Set a hostname for the new CT. + +`-pool` `string` :: + +Add the new CT to the specified pool. + +`-snapname` `string` :: + +The name of the snapshot. + +`-storage` `string` :: + +Target storage for full clone. ++ +NOTE: Requires option(s): `full` + + + + *pct config* `` Get container configuration. @@ -51,15 +98,17 @@ Attach a console device (/dev/console) to the container. `-cpulimit` `number (0 - 128)` (default=`0`):: -Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2' -CPU time. Value '0' indicates no CPU limit. +Limit of CPU usage. ++ +NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' +indicates no CPU limit. `-cpuunits` `integer (0 - 500000)` (default=`1024`):: CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to -weights of all the other running VMs. - +the weights of all the other running VMs. ++ NOTE: You can disable fair-scheduler configuration by setting this to 0. `-description` `string` :: @@ -86,16 +135,16 @@ Lock/unlock the VM. Amount of RAM for the VM in MB. -`-mp[n]` `[volume=] [,backup=<[1|0]>] [,mp=] [,size=]` :: +`-mp[n]` `mp=, [volume=] [,acl=] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=] [,size=]` :: Use volume as container mount point (experimental feature). `-nameserver` `string` :: Sets DNS server IP address for a container. Create will automatically use -the setting from the host if you neither set searchdomain or nameserver. +the setting from the host if you neither set searchdomain nor nameserver. -`-net[n]` `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,tag=]` :: +`-net[n]` `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. @@ -103,12 +152,14 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` :: +`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: -OS type. Corresponds to lxc setup scripts in -/usr/share/lxc/config/.common.conf. +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` `string` :: +`-password` :: Sets root password inside container. @@ -118,21 +169,25 @@ Add the VM to the specified pool. `-protection` `boolean` (default=`0`):: -Sets the protection flag of the container. This will prevent the remove -operation. This will prevent the CT or CT's disk remove/update operation. +Sets the protection flag of the container. This will prevent the CT or CT's +disk remove/update operation. `-restore` `boolean` :: Mark this as restore task. -`-rootfs` `[volume=] [,backup=<[1|0]>] [,size=]` :: +`-rootfs` `[volume=] [,acl=] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=] [,size=]` :: Use volume as container root. `-searchdomain` `string` :: Sets DNS search domains for a container. Create will automatically use the -setting from the host if you neither set searchdomain or nameserver. +setting from the host if you neither set searchdomain nor nameserver. + +`-ssh-public-keys` `filepath` :: + +Setup public SSH keys (one key per line, OpenSSH format). `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: @@ -287,12 +342,93 @@ The (unique) ID of the VM. Target node. +`-force` `boolean` :: + +Force migration despite local bind / device mounts. WARNING: identical bind +/ device mounts need to be available on the target node. + `-online` `boolean` :: Use online/live migration. + +*pct mount* `` + +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. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + +*pct pull* ` ` `[OPTIONS]` + +Copy a file from the container to the local system. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +Path to a file inside the container to pull. + +`` `string` :: + +Destination + +`-group` `string` :: + +Owner group name or id. + +`-perms` `string` :: + +File permissions to use. + +`-user` `string` :: + +Owner user name or id. + + + +*pct push* ` ` `[OPTIONS]` + +Copy a local file to the container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +Path to a local file. + +`` `string` :: + +Destination inside the container to write to. + +`-group` `string` :: + +Owner group name or id. When using a name it must exist inside the +container. + +`-perms` `string` :: + +File permissions to use. + +`-user` `string` :: + +Owner user name or id. When using a name it must exist inside the +container. + + + + *pct resize* ` ` `[OPTIONS]` Resize a container mountpoint. @@ -347,15 +483,17 @@ Attach a console device (/dev/console) to the container. `-cpulimit` `number (0 - 128)` (default=`0`):: -Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2' -CPU time. Value '0' indicates no CPU limit. +Limit of CPU usage. ++ +NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' +indicates no CPU limit. `-cpuunits` `integer (0 - 500000)` (default=`1024`):: CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to -weights of all the other running VMs. - +the weights of all the other running VMs. ++ NOTE: You can disable fair-scheduler configuration by setting this to 0. `-description` `string` :: @@ -382,16 +520,16 @@ Lock/unlock the VM. Amount of RAM for the VM in MB. -`-mp[n]` `[volume=] [,backup=<[1|0]>] [,mp=] [,size=]` :: +`-mp[n]` `mp=, [volume=] [,acl=] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=] [,size=]` :: Use volume as container mount point (experimental feature). `-nameserver` `string` :: Sets DNS server IP address for a container. Create will automatically use -the setting from the host if you neither set searchdomain or nameserver. +the setting from the host if you neither set searchdomain nor nameserver. -`-net[n]` `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,tag=]` :: +`-net[n]` `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. @@ -399,12 +537,14 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` :: +`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: -OS type. Corresponds to lxc setup scripts in -/usr/share/lxc/config/.common.conf. +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` `string` :: +`-password` :: Sets root password inside container. @@ -414,17 +554,21 @@ Add the VM to the specified pool. `-protection` `boolean` (default=`0`):: -Sets the protection flag of the container. This will prevent the remove -operation. This will prevent the CT or CT's disk remove/update operation. +Sets the protection flag of the container. This will prevent the CT or CT's +disk remove/update operation. -`-rootfs` `[volume=] [,backup=<[1|0]>] [,size=]` :: +`-rootfs` `[volume=] [,acl=] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=] [,size=]` :: Use volume as container root. `-searchdomain` `string` :: Sets DNS search domains for a container. Create will automatically use the -setting from the host if you neither set searchdomain or nameserver. +setting from the host if you neither set searchdomain nor nameserver. + +`-ssh-public-keys` `filepath` :: + +Setup public SSH keys (one key per line, OpenSSH format). `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: @@ -512,15 +656,17 @@ Attach a console device (/dev/console) to the container. `-cpulimit` `number (0 - 128)` (default=`0`):: -Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2' -CPU time. Value '0' indicates no CPU limit. +Limit of CPU usage. ++ +NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' +indicates no CPU limit. `-cpuunits` `integer (0 - 500000)` (default=`1024`):: CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to -weights of all the other running VMs. - +the weights of all the other running VMs. ++ NOTE: You can disable fair-scheduler configuration by setting this to 0. `-delete` `string` :: @@ -548,16 +694,16 @@ Lock/unlock the VM. Amount of RAM for the VM in MB. -`-mp[n]` `[volume=] [,backup=<[1|0]>] [,mp=] [,size=]` :: +`-mp[n]` `mp=, [volume=] [,acl=] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=] [,size=]` :: Use volume as container mount point (experimental feature). `-nameserver` `string` :: Sets DNS server IP address for a container. Create will automatically use -the setting from the host if you neither set searchdomain or nameserver. +the setting from the host if you neither set searchdomain nor nameserver. -`-net[n]` `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,tag=]` :: +`-net[n]` `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,rate=] [,tag=] [,trunks=] [,type=]` :: Specifies network interfaces for the container. @@ -565,24 +711,26 @@ Specifies network interfaces for the container. Specifies whether a VM will be started during system bootup. -`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` :: +`-ostype` `(alpine | archlinux | centos | debian | fedora | opensuse | ubuntu | unmanaged)` :: -OS type. Corresponds to lxc setup scripts in -/usr/share/lxc/config/.common.conf. +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. `-protection` `boolean` (default=`0`):: -Sets the protection flag of the container. This will prevent the remove -operation. This will prevent the CT or CT's disk remove/update operation. +Sets the protection flag of the container. This will prevent the CT or CT's +disk remove/update operation. -`-rootfs` `[volume=] [,backup=<[1|0]>] [,size=]` :: +`-rootfs` `[volume=] [,acl=] [,backup=<[1|0]>] [,quota=<[0|1]>] [,ro=] [,size=]` :: Use volume as container root. `-searchdomain` `string` :: Sets DNS search domains for a container. Create will automatically use the -setting from the host if you neither set searchdomain or nameserver. +setting from the host if you neither set searchdomain nor nameserver. `-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` :: @@ -617,7 +765,8 @@ Reference to unused volumes. *pct shutdown* `` `[OPTIONS]` -Shutdown the container. +Shutdown the container. This will trigger a clean shutdown of the +container, see lxc-stop(1) for details. `` `integer (1 - N)` :: @@ -653,7 +802,7 @@ A textual description or comment. -*pct start* `` +*pct start* `` `[OPTIONS]` Start the container. @@ -661,16 +810,25 @@ Start the container. The (unique) ID of the VM. +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + -*pct stop* `` +*pct stop* `` `[OPTIONS]` -Stop the container. +Stop the container. This will abruptly stop all processes running in the +container. `` `integer (1 - N)` :: The (unique) ID of the VM. +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + *pct suspend* `` @@ -684,7 +842,7 @@ The (unique) ID of the VM. -*pct template* `` +*pct template* ` -experimental ` `[OPTIONS]` Create a Template. @@ -692,6 +850,11 @@ 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. + @@ -705,4 +868,14 @@ The (unique) ID of the VM. +*pct unmount* `` + +Unmount the container's filesystem. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + diff --git a/pveam.1-synopsis.adoc b/pveam.1-synopsis.adoc index 8c19431..526b717 100644 --- a/pveam.1-synopsis.adoc +++ b/pveam.1-synopsis.adoc @@ -1,5 +1,16 @@ *pveam* ` [ARGS] [OPTIONS]` +*pveam available* `[OPTIONS]` + +List available templates. + +`-section` `(system | turnkeylinux)` :: + +Restrict list to specified section. + + + + *pveam download* `