From: Dietmar Maurer Date: Tue, 5 Jan 2016 10:14:03 +0000 (+0100) Subject: add generated -synopsis.adoc files X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=1f554f760e12ff7da82dd3d425d9533a71ca979f add generated -synopsis.adoc files --- diff --git a/pct.1-synopsis.adoc b/pct.1-synopsis.adoc new file mode 100644 index 0000000..f3396be --- /dev/null +++ b/pct.1-synopsis.adoc @@ -0,0 +1,708 @@ +*pct* ` [ARGS] [OPTIONS]` + +*pct config* `` + +Get container configuration. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*pct console* `` + +Launch a console for the specified container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*pct create* ` ` `[OPTIONS]` + +Create or restore a container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +The OS template or backup file. + +`-arch` `(amd64 | i386)` (default=`amd64`):: + +OS architecture type. + +`-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). + +`-console` `boolean` (default=`1`):: + +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. + +`-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. + +NOTE: You can disable fair-scheduler configuration by setting this to 0. + +`-description` `string` :: + +Container description. Only used on the configuration web interface. + +`-force` `boolean` :: + +Allow to overwrite existing container. + +`-hostname` `string` :: + +Set a host name for the container. + +`-ignore-unpack-errors` `boolean` :: + +Ignore errors when extracting the template. + +`-lock` `(backup | migrate | rollback | snapshot)` :: + +Lock/unlock the VM. + +`-memory` `integer (16 - N)` (default=`512`):: + +Amount of RAM for the VM in MB. + +`-mp[n]` `[volume=] [,backup=<[1|0]>] [,mp=] [,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. + +`-net[n]` `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,tag=]` :: + +Specifies network interfaces for the container. + +`-onboot` `boolean` (default=`0`):: + +Specifies whether a VM will be started during system bootup. + +`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` :: + +OS type. Corresponds to lxc setup scripts in +/usr/share/lxc/config/.common.conf. + +`-password` `string` :: + +Sets root password inside container. + +`-pool` `string` :: + +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. + +`-restore` `boolean` :: + +Mark this as restore task. + +`-rootfs` `[volume=] [,backup=<[1|0]>] [,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. + +`-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. + +`-storage` `string` (default=`local`):: + +Default Storage. + +`-swap` `integer (0 - N)` (default=`512`):: + +Amount of SWAP for the VM in MB. + +`-template` `boolean` (default=`0`):: + +Enable/disable Template. + +`-tty` `integer (0 - 6)` (default=`2`):: + +Specify the number of tty available to the container + +`-unprivileged` `boolean` (default=`0`):: + +Makes the container run as unprivileged user. (Should not be modified +manually.) + +`-unused[n]` `string` :: + +Reference to unused volumes. + + + + +*pct delsnapshot* ` ` `[OPTIONS]` + +Delete a LXC snapshot. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +The name of the snapshot. + +`-force` `boolean` :: + +For removal from config file, even if removing disk snapshots fails. + + + + +*pct destroy* `` + +Destroy the container (also delete all uses files). + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*pct enter* `` + +Launch a shell for the specified container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + +*pct exec* ` []` + +Launch a command inside the specified container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `array` :: + +Extra arguments as array + + + +*pct fsck* `` `[OPTIONS]` + +Run a filesystem check (fsck) on a container volume. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-device` `(mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs)` :: + +A volume on which to run the filesystem check + +`-force` `boolean` (default=`0`):: + +Force checking, even if the filesystem seems clean + + + + +*pct help* `[]` `[OPTIONS]` + +Get help about specified command. + +`` `string` :: + +Command name + +`-verbose` `boolean` :: + +Verbose output format. + + + + +*pct list* + +LXC container index (per node). + + + + +*pct listsnapshot* `` + +List all snapshots. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*pct migrate* ` ` `[OPTIONS]` + +Migrate the container to another node. Creates a new migration task. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +Target node. + +`-online` `boolean` :: + +Use online/live migration. + + + +*pct resize* ` ` `[OPTIONS]` + +Resize a container mountpoint. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `(mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs)` :: + +The disk you want to resize. + +`` `\+?\d+(\.\d+)?[KMGT]?` :: + +The new size. With the '+' sign the value is added to the actual size of +the volume and without it, the value is taken as an absolute one. Shrinking +disk size is not supported. + +`-digest` `string` :: + +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. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +The OS template or backup file. + +`-arch` `(amd64 | i386)` (default=`amd64`):: + +OS architecture type. + +`-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). + +`-console` `boolean` (default=`1`):: + +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. + +`-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. + +NOTE: You can disable fair-scheduler configuration by setting this to 0. + +`-description` `string` :: + +Container description. Only used on the configuration web interface. + +`-force` `boolean` :: + +Allow to overwrite existing container. + +`-hostname` `string` :: + +Set a host name for the container. + +`-ignore-unpack-errors` `boolean` :: + +Ignore errors when extracting the template. + +`-lock` `(backup | migrate | rollback | snapshot)` :: + +Lock/unlock the VM. + +`-memory` `integer (16 - N)` (default=`512`):: + +Amount of RAM for the VM in MB. + +`-mp[n]` `[volume=] [,backup=<[1|0]>] [,mp=] [,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. + +`-net[n]` `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,tag=]` :: + +Specifies network interfaces for the container. + +`-onboot` `boolean` (default=`0`):: + +Specifies whether a VM will be started during system bootup. + +`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` :: + +OS type. Corresponds to lxc setup scripts in +/usr/share/lxc/config/.common.conf. + +`-password` `string` :: + +Sets root password inside container. + +`-pool` `string` :: + +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. + +`-rootfs` `[volume=] [,backup=<[1|0]>] [,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. + +`-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. + +`-storage` `string` (default=`local`):: + +Default Storage. + +`-swap` `integer (0 - N)` (default=`512`):: + +Amount of SWAP for the VM in MB. + +`-template` `boolean` (default=`0`):: + +Enable/disable Template. + +`-tty` `integer (0 - 6)` (default=`2`):: + +Specify the number of tty available to the container + +`-unprivileged` `boolean` (default=`0`):: + +Makes the container run as unprivileged user. (Should not be modified +manually.) + +`-unused[n]` `string` :: + +Reference to unused volumes. + + + + +*pct resume* `` + +Resume the container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*pct rollback* ` ` + +Rollback LXC state to specified snapshot. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +The name of the snapshot. + + + + +*pct set* `` `[OPTIONS]` + +Set container options. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-arch` `(amd64 | i386)` (default=`amd64`):: + +OS architecture type. + +`-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). + +`-console` `boolean` (default=`1`):: + +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. + +`-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. + +NOTE: You can disable fair-scheduler configuration by setting this to 0. + +`-delete` `string` :: + +A list of settings you want to delete. + +`-description` `string` :: + +Container description. Only used on the configuration web interface. + +`-digest` `string` :: + +Prevent changes if current configuration file has different SHA1 digest. +This can be used to prevent concurrent modifications. + +`-hostname` `string` :: + +Set a host name for the container. + +`-lock` `(backup | migrate | rollback | snapshot)` :: + +Lock/unlock the VM. + +`-memory` `integer (16 - N)` (default=`512`):: + +Amount of RAM for the VM in MB. + +`-mp[n]` `[volume=] [,backup=<[1|0]>] [,mp=] [,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. + +`-net[n]` `name= [,bridge=>] [,firewall=<[1|0]>] [,gw=] [,gw6=] [,hwaddr=] [,ip=] [,ip6=] [,mtu=] [,tag=]` :: + +Specifies network interfaces for the container. + +`-onboot` `boolean` (default=`0`):: + +Specifies whether a VM will be started during system bootup. + +`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` :: + +OS type. Corresponds to lxc setup scripts in +/usr/share/lxc/config/.common.conf. + +`-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. + +`-rootfs` `[volume=] [,backup=<[1|0]>] [,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. + +`-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. + +`-swap` `integer (0 - N)` (default=`512`):: + +Amount of SWAP for the VM in MB. + +`-template` `boolean` (default=`0`):: + +Enable/disable Template. + +`-tty` `integer (0 - 6)` (default=`2`):: + +Specify the number of tty available to the container + +`-unprivileged` `boolean` (default=`0`):: + +Makes the container run as unprivileged user. (Should not be modified +manually.) + +`-unused[n]` `string` :: + +Reference to unused volumes. + + + + +*pct shutdown* `` `[OPTIONS]` + +Shutdown the container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-forceStop` `boolean` (default=`0`):: + +Make sure the Container stops. + +`-timeout` `integer (0 - N)` (default=`60`):: + +Wait maximal timeout seconds. + + + + +*pct snapshot* ` ` `[OPTIONS]` + +Snapshot a container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +The name of the snapshot. + +`-description` `string` :: + +A textual description or comment. + + + + +*pct start* `` + +Start the container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + +*pct stop* `` + +Stop the container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + +*pct suspend* `` + +Suspend the container. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*pct template* `` + +Create a Template. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*pct unlock* `` + +Unlock the VM. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + diff --git a/pve-firewall.8-synopsis.adoc b/pve-firewall.8-synopsis.adoc new file mode 100644 index 0000000..f46eb5b --- /dev/null +++ b/pve-firewall.8-synopsis.adoc @@ -0,0 +1,100 @@ +*pve-firewall* ` [ARGS] [OPTIONS]` + +*pve-firewall compile* + +Compile and print firewall rules. This is useful for testing. + + + + +*pve-firewall help* `[]` `[OPTIONS]` + +Get help about specified command. + +`` `string` :: + +Command name + +`-verbose` `boolean` :: + +Verbose output format. + + + + +*pve-firewall localnet* + +Print information about local network. + + + +*pve-firewall restart* + +Restart the Proxmox VE firewall service. + + + +*pve-firewall simulate* `[OPTIONS]` + +Simulate firewall rules. This does not simulate kernel 'routing' table. +Instead, this simply assumes that routing from source zone to destination +zone is possible. + +`-dest` `string` :: + +Destination IP address. + +`-dport` `integer` :: + +Destination port. + +`-from` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` (default=`outside`):: + +Source zone. + +`-protocol` `(tcp|udp)` (default=`tcp`):: + +Protocol. + +`-source` `string` :: + +Source IP address. + +`-sport` `integer` :: + +Source port. + +`-to` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` (default=`host`):: + +Destination zone. + +`-verbose` `boolean` (default=`0`):: + +Verbose output. + + + +*pve-firewall start* `[OPTIONS]` + +Start the Proxmox VE firewall service. + +`-debug` `boolean` (default=`0`):: + +Debug mode - stay in foreground + + + +*pve-firewall status* + +Get firewall status. + + + +*pve-firewall stop* + +Stop firewall. This removes all Proxmox VE related iptable rules. The host +is unprotected afterwards. + + + + diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc new file mode 100644 index 0000000..b74d0ef --- /dev/null +++ b/pvesm.1-synopsis.adoc @@ -0,0 +1,428 @@ +*pvesm* ` [ARGS] [OPTIONS]` + +*pvesm add* ` ` `[OPTIONS]` + +Create a new storage. + +`` `(dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool)` :: + +Storage type. + +`` `string` :: + +The storage identifier. + +`-authsupported` `string` :: + +Authsupported. + +`-base` `string` :: + +Base volume. This volume is automatically activated. + +`-blocksize` `string` :: + +block size + +`-comstar_hg` `string` :: + +host group for comstar views + +`-comstar_tg` `string` :: + +target group for comstar views + +`-content` `string` :: + +Allowed content types. Note: value 'rootdir' is used for Containers, and +value 'images' for KVM-Qemu VM's. + +`-disable` `boolean` :: + +Flag to disable the storage. + +`-export` `string` :: + +NFS export path. + +`-format` `string` :: + +Default Image format. + +`-iscsiprovider` `string` :: + +iscsi provider + +`-krbd` `boolean` :: + +Access rbd through krbd kernel module. + +`-maxfiles` `integer (0 - N)` :: + +Maximal number of backup files per VM. Use '0' for unlimted. + +`-monhost` `string` :: + +Monitors daemon ips. + +`-nodes` `string` :: + +List of cluster node names. + +`-nowritecache` `boolean` :: + +disable write caching on the target + +`-options` `string` :: + +NFS mount options (see 'man nfs') + +`-path` `string` :: + +File system path. + +`-pool` `string` :: + +Pool. + +`-portal` `string` :: + +iSCSI portal (IP or DNS name with optional port). + +`-redundancy` `integer (1 - 16)` (default=`2`):: + +The redundancy count specifies the number of nodes to which the resource +should be deployed. It must be at least 1 and at most the number of nodes +in the cluster. + +`-saferemove` `boolean` :: + +Zero-out data when removing LVs. + +`-saferemove_throughput` `string` :: + +Wipe throughput (cstream -t parameter value). + +`-server` `string` :: + +Server IP or DNS name. + +`-server[n]` `string` :: + +Backup volfile server IP or DNS name. ++ +NOTE: Requires option(s): `server` + +`-shared` `boolean` :: + +Mark storage as shared. + +`-sparse` `boolean` :: + +use sparse volumes + +`-target` `string` :: + +iSCSI target. + +`-thinpool` `string` :: + +LVM thin pool LV name. + +`-transport` `(rdma | tcp | unix)` :: + +Gluster transport: tcp or rdma + +`-username` `string` :: + +RBD Id. + +`-vgname` `string` :: + +Volume group name. + +`-volume` `string` :: + +Glusterfs Volume. + + + + +*pvesm alloc* ` ` `[OPTIONS]` + +Allocate disk images. + +`` `string` :: + +The storage identifier. + +`` `integer (1 - N)` :: + +Specify owner VM + +`` `string` :: + +The name of the file to create. + +`` `\d+[MG]?` :: + +Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and +'G' (gigabyte, 1024M) + +`-format` `(qcow2 | raw | subvol)` :: + +no description available ++ +NOTE: Requires option(s): `size` + + + +*pvesm free* `` `[OPTIONS]` + +Delete volume + +`` `string` :: + +Volume identifier + +`-storage` `string` :: + +The storage identifier. + + + + +*pvesm glusterfsscan* `` + +Scan remote GlusterFS server. + +`` `string` :: + +no description available + + + + +*pvesm help* `[]` `[OPTIONS]` + +Get help about specified command. + +`` `string` :: + +Command name + +`-verbose` `boolean` :: + +Verbose output format. + + + + +*pvesm iscsiscan* `-portal ` `[OPTIONS]` + +Scan remote iSCSI server. + +`-portal` `string` :: + +no description available + + + + +*pvesm list* `` `[OPTIONS]` + +List storage content. + +`` `string` :: + +The storage identifier. + +`-content` `string` :: + +Only list content of this type. + +`-vmid` `integer (1 - N)` :: + +Only list images for this VM + + + + +*pvesm lvmscan* + +List local LVM volume groups. + + + +*pvesm nfsscan* `` + +Scan remote NFS server. + +`` `string` :: + +no description available + + + + +*pvesm path* `` + +Get filesystem path for specified volume + +`` `string` :: + +Volume identifier + + + + +*pvesm remove* `` + +Delete storage configuration. + +`` `string` :: + +The storage identifier. + + + +*pvesm set* `` `[OPTIONS]` + +Update storage configuration. + +`` `string` :: + +The storage identifier. + +`-blocksize` `string` :: + +block size + +`-comstar_hg` `string` :: + +host group for comstar views + +`-comstar_tg` `string` :: + +target group for comstar views + +`-content` `string` :: + +Allowed content types. Note: value 'rootdir' is used for Containers, and +value 'images' for KVM-Qemu VM's. + +`-delete` `string` :: + +A list of settings you want to delete. + +`-digest` `string` :: + +Prevent changes if current configuration file has different SHA1 digest. +This can be used to prevent concurrent modifications. + +`-disable` `boolean` :: + +Flag to disable the storage. + +`-format` `string` :: + +Default Image format. + +`-krbd` `boolean` :: + +Access rbd through krbd kernel module. + +`-maxfiles` `integer (0 - N)` :: + +Maximal number of backup files per VM. Use '0' for unlimted. + +`-nodes` `string` :: + +List of cluster node names. + +`-nowritecache` `boolean` :: + +disable write caching on the target + +`-options` `string` :: + +NFS mount options (see 'man nfs') + +`-pool` `string` :: + +Pool. + +`-redundancy` `integer (1 - 16)` (default=`2`):: + +The redundancy count specifies the number of nodes to which the resource +should be deployed. It must be at least 1 and at most the number of nodes +in the cluster. + +`-saferemove` `boolean` :: + +Zero-out data when removing LVs. + +`-saferemove_throughput` `string` :: + +Wipe throughput (cstream -t parameter value). + +`-server` `string` :: + +Server IP or DNS name. + +`-server[n]` `string` :: + +Backup volfile server IP or DNS name. ++ +NOTE: Requires option(s): `server` + +`-shared` `boolean` :: + +Mark storage as shared. + +`-sparse` `boolean` :: + +use sparse volumes + +`-transport` `(rdma | tcp | unix)` :: + +Gluster transport: tcp or rdma + +`-username` `string` :: + +RBD Id. + + + + +*pvesm status* `[OPTIONS]` + +Get status for all datastores. + +`-content` `string` :: + +Only list stores which support this content type. + +`-enabled` `boolean` (default=`0`):: + +Only list stores which are enabled (not disabled in config). + +`-storage` `string` :: + +Only list status for specified storage + +`-target` `string` :: + +If target is different to 'node', we only lists shared storages which +content is accessible on this 'node' and the specified 'target' node. + + + + +*pvesm zfsscan* + +Scan zfs pool list on local node. + + + + diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc new file mode 100644 index 0000000..f19195e --- /dev/null +++ b/pveum.1-synopsis.adoc @@ -0,0 +1,304 @@ +*pveum* ` [ARGS] [OPTIONS]` + +*pveum acldel* ` -roles ` `[OPTIONS]` + +Update Access Control List (add or remove permissions). + +`` `string` :: + +Access control path + +`-groups` `string` :: + +List of groups. + +`-propagate` `boolean` (default=`1`):: + +Allow to propagate (inherit) permissions. + +`-roles` `string` :: + +List of roles. + +`-users` `string` :: + +List of users. + + + +*pveum aclmod* ` -roles ` `[OPTIONS]` + +Update Access Control List (add or remove permissions). + +`` `string` :: + +Access control path + +`-groups` `string` :: + +List of groups. + +`-propagate` `boolean` (default=`1`):: + +Allow to propagate (inherit) permissions. + +`-roles` `string` :: + +List of roles. + +`-users` `string` :: + +List of users. + + + + +*pveum groupadd* `` `[OPTIONS]` + +Create new group. + +`` `string` :: + +no description available + +`-comment` `string` :: + +no description available + + + +*pveum groupdel* `` + +Delete group. + +`` `string` :: + +no description available + + + +*pveum groupmod* `` `[OPTIONS]` + +Update group data. + +`` `string` :: + +no description available + +`-comment` `string` :: + +no description available + + + + +*pveum help* `[]` `[OPTIONS]` + +Get help about specified command. + +`` `string` :: + +Command name + +`-verbose` `boolean` :: + +Verbose output format. + + + + +*pveum passwd* `` + +Change user password. + +`` `string` :: + +User ID + + + + +*pveum roleadd* `` `[OPTIONS]` + +Create new role. + +`` `string` :: + +no description available + +`-privs` `string` :: + +no description available + + + +*pveum roledel* `` + +Delete role. + +`` `string` :: + +no description available + + + +*pveum rolemod* ` -privs ` `[OPTIONS]` + +Create new role. + +`` `string` :: + +no description available + +`-append` `boolean` :: + +no description available ++ +NOTE: Requires option(s): `privs` + +`-privs` `string` :: + +no description available + + + + +*pveum ticket* `` `[OPTIONS]` + +Create or verify authentication ticket. + +`` `string` :: + +User name + +`-otp` `string` :: + +One-time password for Two-factor authentication. + +`-path` `string` :: + +Verify ticket, and check if user have access 'privs' on 'path' ++ +NOTE: Requires option(s): `privs` + +`-privs` `string` :: + +Verify ticket, and check if user have access 'privs' on 'path' ++ +NOTE: Requires option(s): `path` + +`-realm` `string` :: + +You can optionally pass the realm using this parameter. Normally the realm +is simply added to the username @. + + + + +*pveum useradd* `` `[OPTIONS]` + +Create new user. + +`` `string` :: + +User ID + +`-comment` `string` :: + +no description available + +`-email` `string` :: + +no description available + +`-enable` `boolean` (default=`1`):: + +Enable the account (default). You can set this to '0' to disable the accout + +`-expire` `integer (0 - N)` :: + +Account expiration date (seconds since epoch). '0' means no expiration +date. + +`-firstname` `string` :: + +no description available + +`-groups` `string` :: + +no description available + +`-keys` `string` :: + +Keys for two factor auth (yubico). + +`-lastname` `string` :: + +no description available + +`-password` `` :: + +Initial password. + + + +*pveum userdel* `` + +Delete user. + +`` `string` :: + +User ID + + + +*pveum usermod* `` `[OPTIONS]` + +Update user configuration. + +`` `string` :: + +User ID + +`-append` `boolean` :: + +no description available ++ +NOTE: Requires option(s): `groups` + +`-comment` `string` :: + +no description available + +`-email` `string` :: + +no description available + +`-enable` `boolean` :: + +Enable/disable the account. + +`-expire` `integer (0 - N)` :: + +Account expiration date (seconds since epoch). '0' means no expiration +date. + +`-firstname` `string` :: + +no description available + +`-groups` `string` :: + +no description available + +`-keys` `string` :: + +Keys for two factor auth (yubico). + +`-lastname` `string` :: + +no description available + + + + diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc new file mode 100644 index 0000000..ec7223a --- /dev/null +++ b/qm.1-synopsis.adoc @@ -0,0 +1,1261 @@ +*qm* ` [ARGS] [OPTIONS]` + +*qm clone* ` ` `[OPTIONS]` + +Create a copy of virtual machine/template. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `integer (1 - N)` :: + +VMID for the clone. + +`-description` `string` :: + +Description for the new VM. + +`-format` `(qcow2 | raw | vmdk)` :: + +Target format for file storage. ++ +NOTE: Requires option(s): `full` + +`-full` `boolean` (default=`0`):: + +Create a full copy of all disk. This is always done when you clone a normal +VM. For VM templates, we try to create a linked clone by default. + +`-name` `string` :: + +Set a name for the new VM. + +`-pool` `string` :: + +Add the new VM to the specified pool. + +`-snapname` `string` :: + +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. + + + +*qm config* `` `[OPTIONS]` + +Get current virtual machine configuration. This does not include pending +configuration changes (see 'pending' API). + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-current` `boolean` (default=`0`):: + +Get current values (instead of pending values). + + + +*qm create* `` `[OPTIONS]` + +Create or restore a virtual machine. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-acpi` `boolean` (default=`1`):: + +Enable/disable ACPI. + +`-agent` `boolean` (default=`0`):: + +Enable/disable Qemu GuestAgent. + +`-archive` `string` :: + +The backup file. + +`-args` `string` :: + +Note: this option is for experts only. It allows you to pass arbitrary +arguments to kvm, for example: + +args: -no-reboot -no-hpet + +`-autostart` `boolean` (default=`0`):: + +Automatic restart after crash (currently ignored). + +`-balloon` `integer (0 - N)` :: + +Amount of target RAM for the VM in MB. Using zero disables the ballon +driver. + +`-bios` `(ovmf | seabios)` (default=`seabios`):: + +Select BIOS implementation. + +`-boot` `[acdn]{1,4}` (default=`cdn`):: + +Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). + +`-bootdisk` `(ide|sata|scsi|virtio)\d+` :: + +Enable booting from specified disk. + +`-cdrom` `volume` :: + +This is an alias for option -ide2 + +`-cores` `integer (1 - N)` (default=`1`):: + +The number of cores per socket. + +`-cpu` `(486 | Broadwell | Conroe | Haswell | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64)` (default=`kvm64`):: + +Emulated CPU type. + +`-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. + +`-cpuunits` `integer (0 - 500000)` (default=`1000`):: + +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. + +NOTE: You can disable fair-scheduler configuration by setting this to 0. + +`-description` `string` :: + +Description for the VM. Only used on the configuration web interface. This +is saved as comment inside the configuration file. + +`-force` `boolean` :: + +Allow to overwrite existing VM. ++ +NOTE: Requires option(s): `archive` + +`-freeze` `boolean` :: + +Freeze CPU at startup (use 'c' monitor command to start execution). + +`-hostpci[n]` `[host=]HOSTPCIDEVICE [,rombar=on|off] [,pcie=0|1] [,x-vga=on|off]` :: + +Map host pci devices. HOSTPCIDEVICE syntax is: + +'bus:dev.func' (hexadecimal numbers) + +You can us the 'lspci' command to list existing pci devices. + +The 'rombar' option determines whether or not the device's ROM will be +visible in the guest's memory map (default is 'on'). + +Note: This option allows direct access to host hardware. So it is no longer +possible to migrate such machines - use with special care. + +Experimental: user reported problems with this option. + +`-hotplug` `string` (default=`network,disk,usb`):: + +Selectively enable hotplug features. This is a comma separated list of +hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to +disable hotplug completely. Value '1' is an alias for the default +'network,disk,usb'. + +`-ide[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial][,model=model]` :: + +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). + +`-keyboard` `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`):: + +Keybord layout for vnc server. Default is read from the datacenter +configuration file. + +`-kvm` `boolean` (default=`1`):: + +Enable/disable KVM hardware virtualization. + +`-localtime` `boolean` :: + +Set the real time clock to local time. This is enabled by default if ostype +indicates a Microsoft OS. + +`-lock` `(backup | migrate | rollback | snapshot)` :: + +Lock/unlock the VM. + +`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: + +Specific the Qemu machine type. + +`-memory` `integer (16 - N)` (default=`512`):: + +Amount of RAM for the VM in MB. This is the maximum available memory when +you use the balloon device. + +`-migrate_downtime` `number (0 - N)` (default=`0.1`):: + +Set maximum tolerated downtime (in seconds) for migrations. + +`-migrate_speed` `integer (0 - N)` (default=`0`):: + +Set maximum speed (in MB/s) for migrations. Value 0 is no limit. + +`-name` `string` :: + +Set a name for the VM. Only used on the configuration web interface. + +`-net[n]` `MODEL=XX:XX:XX:XX:XX:XX [,bridge=][,queues=][,rate=] [,tag=][,firewall=0|1],link_down=0|1]` :: + +Specify network devices. + +MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 +i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 + +XX:XX:XX:XX:XX:XX should be an unique MAC address. This is +automatically generated if not specified. + +The bridge parameter can be used to automatically add the interface to a +bridge device. The Proxmox VE standard bridge is called 'vmbr0'. + +Option 'rate' is used to limit traffic bandwidth from and to this +interface. It is specified as floating point number, unit is 'Megabytes per +second'. + +If you specify no bridge, we create a kvm 'user' (NATed) network device, +which provides DHCP and DNS services. The following addresses are used: + +10.0.2.2 Gateway +10.0.2.3 DNS Server +10.0.2.4 SMB Server + +The DHCP server assign addresses to the guest starting from 10.0.2.15. + + +`-numa` `boolean` (default=`0`):: + +Enable/disable Numa. + +`-numa[n]` `cpus=[[,hostnodes=] [,policy=]]` :: + +numa topology + +`-onboot` `boolean` (default=`0`):: + +Specifies whether a VM will be started during system bootup. + +`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: + +Used to enable special optimization/features for specific +operating systems: + +other => unspecified OS +wxp => Microsoft Windows XP +w2k => Microsoft Windows 2000 +w2k3 => Microsoft Windows 2003 +w2k8 => Microsoft Windows 2008 +wvista => Microsoft Windows Vista +win7 => Microsoft Windows 7 +win8 => Microsoft Windows 8/2012 +l24 => Linux 2.4 Kernel +l26 => Linux 2.6/3.X Kernel +solaris => solaris/opensolaris/openindiania kernel + +other|l24|l26|solaris ... no special behaviour +wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch + +`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: + +Map host parallel devices (n is 0 to 2). + +Note: This option allows direct access to host hardware. So it is no longer +possible to migrate such machines - use with special care. + +Experimental: user reported problems with this option. + +`-pool` `string` :: + +Add the VM to the specified pool. + +`-protection` `boolean` (default=`0`):: + +Sets the protection flag of the VM. This will prevent the remove operation. + +`-reboot` `boolean` (default=`1`):: + +Allow reboot. If set to '0' the VM exit on reboot. + +`-sata[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial]` :: + +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). + +`-scsi[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,queues=] [,serial=serial]` :: + +Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). + +`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: + +scsi controller model + +`-serial[n]` `(/dev/.+|socket)` :: + +Create a serial device inside the VM (n is 0 to 3), and pass through a host +serial device (i.e. /dev/ttyS0), or create a unix socket on the host side +(use 'qm terminal' to open a terminal connection). + +Note: If you pass through a host serial device, it is no longer possible to +migrate such machines - use with special care. + +Experimental: user reported problems with this option. + +`-shares` `integer (0 - 50000)` (default=`1000`):: + +Amount of memory shares for auto-ballooning. The larger the number is, the +more memory this VM gets. Number is relative to weights of all other +running VMs. Using zero disables auto-ballooning + +`-smbios[n]` `[manufacturer=str][,product=str][,version=str][,serial=str] [,uuid=uuid][,sku=str][,family=str]` :: + +Specify SMBIOS type 1 fields. + +`-smp` `integer (1 - N)` (default=`1`):: + +The number of CPUs. Please use option -sockets instead. + +`-sockets` `integer (1 - N)` (default=`1`):: + +The number of CPU sockets. + +`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: + +Set the initial date of the real time clock. Valid format for date are: +'now' or '2006-06-17T16:01:21' or '2006-06-17'. + +`-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. + +`-storage` `string` :: + +Default storage. + +`-tablet` `boolean` (default=`1`):: + +Enable/disable the usb tablet device. This device is usually needed to +allow absolute mouse positioning with VNC. Else the mouse runs out of sync +with normal VNC clients. If you're running lots of console-only guests on +one host, you may consider disabling this to save some context switches. +This is turned of by default if you use spice (vga=qxl). + +`-tdf` `boolean` (default=`0`):: + +Enable/disable time drift fix. + +`-template` `boolean` (default=`0`):: + +Enable/disable Template. + +`-unique` `boolean` :: + +Assign a unique random ethernet address. ++ +NOTE: Requires option(s): `archive` + +`-unused[n]` `string` :: + +Reference to unused volumes. + +`-usb[n]` `host=HOSTUSBDEVICE|spice` :: + +Configure an USB device (n is 0 to 4). This can be used to +pass-through usb devices to the guest. HOSTUSBDEVICE syntax is: + +'bus-port(.port)*' (decimal numbers) or +'vendor_id:product_id' (hexadeciaml numbers) + +You can use the 'lsusb -t' command to list existing usb devices. + +Note: This option allows direct access to host hardware. So it is no longer +possible to migrate such machines - use with special care. + +The value 'spice' can be used to add a usb redirection devices for spice. + + +`-vcpus` `integer (1 - N)` (default=`0`):: + +Number of hotplugged vcpus. + +`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: + +Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) +then you should use option 'std' or 'vmware'. Default is 'std' for +win8/win7/w2k8, and 'cirrur' for other OS types. Option 'qxl' enables the +SPICE display sever. You can also run without any graphic card using a +serial devive as terminal. + +`-virtio[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,serial=serial]` :: + +Use volume as VIRTIO hard disk (n is 0 to 15). + +`-watchdog` `[[model=]i6300esb|ib700] [,[action=]reset|shutdown|poweroff|pause|debug|none]` :: + +Create a virtual hardware watchdog device. Once enabled (by a guest +action), the watchdog must be periodically polled by an agent inside the +guest or else the guest will be restarted (or execute the action specified) + + + +*qm delsnapshot* ` ` `[OPTIONS]` + +Delete a VM snapshot. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +The name of the snapshot. + +`-force` `boolean` :: + +For removal from config file, even if removing disk snapshots fails. + + + +*qm destroy* `` `[OPTIONS]` + +Destroy the vm (also delete all used/owned volumes). + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + + + + +*qm help* `[]` `[OPTIONS]` + +Get help about specified command. + +`` `string` :: + +Command name + +`-verbose` `boolean` :: + +Verbose output format. + + + + +*qm list* + +Virtual machine index (per node). + + + +*qm migrate* ` ` `[OPTIONS]` + +Migrate virtual machine. Creates a new migration task. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +Target node. + +`-force` `boolean` :: + +Allow to migrate VMs which use local devices. Only root may use this +option. + +`-online` `boolean` :: + +Use online/live migration. + + + + +*qm monitor* `` + +Enter Qemu Monitor interface. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*qm move_disk* ` ` `[OPTIONS]` + +Move volume to different storage. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: + +The disk you want to move. + +`` `string` :: + +Target storage. + +`-delete` `boolean` (default=`0`):: + +Delete the original disk after successful copy. By default the original +disk is kept as unused disk. + +`-digest` `string` :: + +Prevent changes if current configuration file has different SHA1 digest. +This can be used to prevent concurrent modifications. + +`-format` `(qcow2 | raw | vmdk)` :: + +Target Format. + + + + +*qm mtunnel* + +Used by qmigrate - do not use manually. + + + + +*qm pending* `` + +Get virtual machine configuration, including pending changes. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*qm rescan* `[OPTIONS]` + +Rescan all storages and update disk sizes and unused disk images. + +`-vmid` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*qm reset* `` `[OPTIONS]` + +Reset virtual machine. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + + + +*qm resize* ` ` `[OPTIONS]` + +Extend volume size. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: + +The disk you want to resize. + +`` `\+?\d+(\.\d+)?[KMGT]?` :: + +The new size. With the '+' sign the value is added to the actual size of +the volume and without it, the value is taken as an absolute one. Shrinking +disk size is not supported. + +`-digest` `string` :: + +Prevent changes if current configuration file has different SHA1 digest. +This can be used to prevent concurrent modifications. + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + + + +*qm resume* `` `[OPTIONS]` + +Resume virtual machine. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-nocheck` `boolean` :: + +no description available + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + + + +*qm rollback* ` ` + +Rollback VM state to specified snapshot. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +The name of the snapshot. + + + +*qm sendkey* ` ` `[OPTIONS]` + +Send key event to virtual machine. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +The key (qemu monitor encoding). + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + + + +*qm set* `` `[OPTIONS]` + +Set virtual machine options (synchrounous API) - You should consider using +the POST method instead for any actions involving hotplug or storage +allocation. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-acpi` `boolean` (default=`1`):: + +Enable/disable ACPI. + +`-agent` `boolean` (default=`0`):: + +Enable/disable Qemu GuestAgent. + +`-args` `string` :: + +Note: this option is for experts only. It allows you to pass arbitrary +arguments to kvm, for example: + +args: -no-reboot -no-hpet + +`-autostart` `boolean` (default=`0`):: + +Automatic restart after crash (currently ignored). + +`-balloon` `integer (0 - N)` :: + +Amount of target RAM for the VM in MB. Using zero disables the ballon +driver. + +`-bios` `(ovmf | seabios)` (default=`seabios`):: + +Select BIOS implementation. + +`-boot` `[acdn]{1,4}` (default=`cdn`):: + +Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n). + +`-bootdisk` `(ide|sata|scsi|virtio)\d+` :: + +Enable booting from specified disk. + +`-cdrom` `volume` :: + +This is an alias for option -ide2 + +`-cores` `integer (1 - N)` (default=`1`):: + +The number of cores per socket. + +`-cpu` `(486 | Broadwell | Conroe | Haswell | IvyBridge | Nehalem | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | Westmere | athlon | core2duo | coreduo | host | kvm32 | kvm64 | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64)` (default=`kvm64`):: + +Emulated CPU type. + +`-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. + +`-cpuunits` `integer (0 - 500000)` (default=`1000`):: + +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. + +NOTE: You can disable fair-scheduler configuration by setting this to 0. + +`-delete` `string` :: + +A list of settings you want to delete. + +`-description` `string` :: + +Description for the VM. Only used on the configuration web interface. This +is saved as comment inside the configuration file. + +`-digest` `string` :: + +Prevent changes if current configuration file has different SHA1 digest. +This can be used to prevent concurrent modifications. + +`-force` `boolean` :: + +Force physical removal. Without this, we simple remove the disk from the +config file and create an additional configuration entry called +'unused[n]', which contains the volume ID. Unlink of unused[n] always cause +physical removal. ++ +NOTE: Requires option(s): `delete` + +`-freeze` `boolean` :: + +Freeze CPU at startup (use 'c' monitor command to start execution). + +`-hostpci[n]` `[host=]HOSTPCIDEVICE [,rombar=on|off] [,pcie=0|1] [,x-vga=on|off]` :: + +Map host pci devices. HOSTPCIDEVICE syntax is: + +'bus:dev.func' (hexadecimal numbers) + +You can us the 'lspci' command to list existing pci devices. + +The 'rombar' option determines whether or not the device's ROM will be +visible in the guest's memory map (default is 'on'). + +Note: This option allows direct access to host hardware. So it is no longer +possible to migrate such machines - use with special care. + +Experimental: user reported problems with this option. + +`-hotplug` `string` (default=`network,disk,usb`):: + +Selectively enable hotplug features. This is a comma separated list of +hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to +disable hotplug completely. Value '1' is an alias for the default +'network,disk,usb'. + +`-ide[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial][,model=model]` :: + +Use volume as IDE hard disk or CD-ROM (n is 0 to 3). + +`-keyboard` `(da | de | de-ch | en-gb | en-us | es | fi | fr | fr-be | fr-ca | fr-ch | hu | is | it | ja | lt | mk | nl | no | pl | pt | pt-br | sl | sv | tr)` (default=`en-us`):: + +Keybord layout for vnc server. Default is read from the datacenter +configuration file. + +`-kvm` `boolean` (default=`1`):: + +Enable/disable KVM hardware virtualization. + +`-localtime` `boolean` :: + +Set the real time clock to local time. This is enabled by default if ostype +indicates a Microsoft OS. + +`-lock` `(backup | migrate | rollback | snapshot)` :: + +Lock/unlock the VM. + +`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: + +Specific the Qemu machine type. + +`-memory` `integer (16 - N)` (default=`512`):: + +Amount of RAM for the VM in MB. This is the maximum available memory when +you use the balloon device. + +`-migrate_downtime` `number (0 - N)` (default=`0.1`):: + +Set maximum tolerated downtime (in seconds) for migrations. + +`-migrate_speed` `integer (0 - N)` (default=`0`):: + +Set maximum speed (in MB/s) for migrations. Value 0 is no limit. + +`-name` `string` :: + +Set a name for the VM. Only used on the configuration web interface. + +`-net[n]` `MODEL=XX:XX:XX:XX:XX:XX [,bridge=][,queues=][,rate=] [,tag=][,firewall=0|1],link_down=0|1]` :: + +Specify network devices. + +MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 +i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 + +XX:XX:XX:XX:XX:XX should be an unique MAC address. This is +automatically generated if not specified. + +The bridge parameter can be used to automatically add the interface to a +bridge device. The Proxmox VE standard bridge is called 'vmbr0'. + +Option 'rate' is used to limit traffic bandwidth from and to this +interface. It is specified as floating point number, unit is 'Megabytes per +second'. + +If you specify no bridge, we create a kvm 'user' (NATed) network device, +which provides DHCP and DNS services. The following addresses are used: + +10.0.2.2 Gateway +10.0.2.3 DNS Server +10.0.2.4 SMB Server + +The DHCP server assign addresses to the guest starting from 10.0.2.15. + + +`-numa` `boolean` (default=`0`):: + +Enable/disable Numa. + +`-numa[n]` `cpus=[[,hostnodes=] [,policy=]]` :: + +numa topology + +`-onboot` `boolean` (default=`0`):: + +Specifies whether a VM will be started during system bootup. + +`-ostype` `(l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp)` :: + +Used to enable special optimization/features for specific +operating systems: + +other => unspecified OS +wxp => Microsoft Windows XP +w2k => Microsoft Windows 2000 +w2k3 => Microsoft Windows 2003 +w2k8 => Microsoft Windows 2008 +wvista => Microsoft Windows Vista +win7 => Microsoft Windows 7 +win8 => Microsoft Windows 8/2012 +l24 => Linux 2.4 Kernel +l26 => Linux 2.6/3.X Kernel +solaris => solaris/opensolaris/openindiania kernel + +other|l24|l26|solaris ... no special behaviour +wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch + +`-parallel[n]` `/dev/parport\d+|/dev/usb/lp\d+` :: + +Map host parallel devices (n is 0 to 2). + +Note: This option allows direct access to host hardware. So it is no longer +possible to migrate such machines - use with special care. + +Experimental: user reported problems with this option. + +`-protection` `boolean` (default=`0`):: + +Sets the protection flag of the VM. This will prevent the remove operation. + +`-reboot` `boolean` (default=`1`):: + +Allow reboot. If set to '0' the VM exit on reboot. + +`-revert` `string` :: + +Revert a pending change. + +`-sata[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,serial=serial]` :: + +Use volume as SATA hard disk or CD-ROM (n is 0 to 5). + +`-scsi[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,queues=] [,serial=serial]` :: + +Use volume as SCSI hard disk or CD-ROM (n is 0 to 13). + +`-scsihw` `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`):: + +scsi controller model + +`-serial[n]` `(/dev/.+|socket)` :: + +Create a serial device inside the VM (n is 0 to 3), and pass through a host +serial device (i.e. /dev/ttyS0), or create a unix socket on the host side +(use 'qm terminal' to open a terminal connection). + +Note: If you pass through a host serial device, it is no longer possible to +migrate such machines - use with special care. + +Experimental: user reported problems with this option. + +`-shares` `integer (0 - 50000)` (default=`1000`):: + +Amount of memory shares for auto-ballooning. The larger the number is, the +more memory this VM gets. Number is relative to weights of all other +running VMs. Using zero disables auto-ballooning + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + +`-smbios[n]` `[manufacturer=str][,product=str][,version=str][,serial=str] [,uuid=uuid][,sku=str][,family=str]` :: + +Specify SMBIOS type 1 fields. + +`-smp` `integer (1 - N)` (default=`1`):: + +The number of CPUs. Please use option -sockets instead. + +`-sockets` `integer (1 - N)` (default=`1`):: + +The number of CPU sockets. + +`-startdate` `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`):: + +Set the initial date of the real time clock. Valid format for date are: +'now' or '2006-06-17T16:01:21' or '2006-06-17'. + +`-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. + +`-tablet` `boolean` (default=`1`):: + +Enable/disable the usb tablet device. This device is usually needed to +allow absolute mouse positioning with VNC. Else the mouse runs out of sync +with normal VNC clients. If you're running lots of console-only guests on +one host, you may consider disabling this to save some context switches. +This is turned of by default if you use spice (vga=qxl). + +`-tdf` `boolean` (default=`0`):: + +Enable/disable time drift fix. + +`-template` `boolean` (default=`0`):: + +Enable/disable Template. + +`-unused[n]` `string` :: + +Reference to unused volumes. + +`-usb[n]` `host=HOSTUSBDEVICE|spice` :: + +Configure an USB device (n is 0 to 4). This can be used to +pass-through usb devices to the guest. HOSTUSBDEVICE syntax is: + +'bus-port(.port)*' (decimal numbers) or +'vendor_id:product_id' (hexadeciaml numbers) + +You can use the 'lsusb -t' command to list existing usb devices. + +Note: This option allows direct access to host hardware. So it is no longer +possible to migrate such machines - use with special care. + +The value 'spice' can be used to add a usb redirection devices for spice. + + +`-vcpus` `integer (1 - N)` (default=`0`):: + +Number of hotplugged vcpus. + +`-vga` `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` :: + +Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) +then you should use option 'std' or 'vmware'. Default is 'std' for +win8/win7/w2k8, and 'cirrur' for other OS types. Option 'qxl' enables the +SPICE display sever. You can also run without any graphic card using a +serial devive as terminal. + +`-virtio[n]` `[volume=]volume,] [,media=cdrom|disk] [,cyls=c,heads=h,secs=s[,trans=t]] [,snapshot=on|off] [,cache=none|writethrough|writeback|unsafe|directsync] [,format=f] [,backup=yes|no] [,rerror=ignore|report|stop] [,werror=enospc|ignore|report|stop] [,aio=native|threads] [,discard=ignore|on] [,detect_zeroes=on|off] [,iothread=on] [,serial=serial]` :: + +Use volume as VIRTIO hard disk (n is 0 to 15). + +`-watchdog` `[[model=]i6300esb|ib700] [,[action=]reset|shutdown|poweroff|pause|debug|none]` :: + +Create a virtual hardware watchdog device. Once enabled (by a guest +action), the watchdog must be periodically polled by an agent inside the +guest or else the guest will be restarted (or execute the action specified) + + + + +*qm showcmd* `` + +Show command line which is used to start the VM (debug info). + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + + +*qm shutdown* `` `[OPTIONS]` + +Shutdown virtual machine. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-forceStop` `boolean` (default=`0`):: + +Make sure the VM stops. + +`-keepActive` `boolean` (default=`0`):: + +Do not decativate storage volumes. + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + +`-timeout` `integer (0 - N)` :: + +Wait maximal timeout seconds. + + + +*qm snapshot* ` ` `[OPTIONS]` + +Snapshot a VM. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`` `string` :: + +The name of the snapshot. + +`-description` `string` :: + +A textual description or comment. + +`-vmstate` `boolean` :: + +Save the vmstate + + + +*qm start* `` `[OPTIONS]` + +Start virtual machine. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-machine` `(pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?)` :: + +Specific the Qemu machine type. + +`-migratedfrom` `string` :: + +The cluster node name. + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + +`-stateuri` `string` :: + +Some command save/restore state from this location. + + + + +*qm status* `` `[OPTIONS]` + +Show VM status. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-verbose` `boolean` :: + +Verbose output format + + + + +*qm stop* `` `[OPTIONS]` + +Stop virtual machine. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-keepActive` `boolean` (default=`0`):: + +Do not decativate storage volumes. + +`-migratedfrom` `string` :: + +The cluster node name. + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + +`-timeout` `integer (0 - N)` :: + +Wait maximal timeout seconds. + + + +*qm suspend* `` `[OPTIONS]` + +Suspend virtual machine. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-skiplock` `boolean` :: + +Ignore locks - only root is allowed to use this option. + + + +*qm template* `` `[OPTIONS]` + +Create a Template. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-disk` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` :: + +If you want to convert only 1 disk to base image. + + + + +*qm terminal* `` `[OPTIONS]` + +Open a terminal using a serial device (The VM need to have a serial device +configured, for example 'serial0: socket') + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-iface` `(serial0 | serial1 | serial2 | serial3)` :: + +Select the serial device. By default we simply use the first suitable +device. + + + + +*qm unlink* ` -idlist ` `[OPTIONS]` + +Unlink/delete disk images. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-force` `boolean` :: + +Force physical removal. Without this, we simple remove the disk from the +config file and create an additional configuration entry called +'unused[n]', which contains the volume ID. Unlink of unused[n] always cause +physical removal. + +`-idlist` `string` :: + +A list of disk IDs you want to delete. + + + + +*qm unlock* `` + +Unlock the VM. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + +*qm vncproxy* `` + +Proxy VM VNC traffic to stdin/stdout + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + + + +*qm wait* `` `[OPTIONS]` + +Wait until the VM is stopped. + +`` `integer (1 - N)` :: + +The (unique) ID of the VM. + +`-timeout` `integer (1 - N)` :: + +Timeout in seconds. Default is to wait forever. + + + + diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc new file mode 100644 index 0000000..09147c3 --- /dev/null +++ b/vzdump.1-synopsis.adoc @@ -0,0 +1,107 @@ +*vzdump* `help` + +*vzdump* `{}` `[OPTIONS]` + +Create backup. + +`` `string` :: + +The ID of the VM you want to backup. + +`-all` `boolean` (default=`0`):: + +Backup all known VMs on this host. + +`-bwlimit` `integer (0 - N)` :: + +Limit I/O bandwidth (KBytes per second). + +`-compress` `(0 | 1 | gzip | lzo)` (default=`lzo`):: + +Compress dump file. + +`-dumpdir` `string` :: + +Store resulting files to specified directory. + +`-exclude` `string` :: + +exclude specified VMs (assumes --all) + +`-exclude-path` `string` :: + +exclude certain files/directories (shell globs). + +`-ionice` `integer (0 - 8)` :: + +Set CFQ ionice priority. + +`-lockwait` `integer (0 - N)` :: + +Maximal time to wait for the global lock (minutes). + +`-mailnotification` `(always | failure)` (default=`always`):: + +Specify when to send an email + +`-mailto` `string` :: + +no description available + +`-maxfiles` `integer (1 - N)` :: + +Maximal number of backup files per VM. + +`-mode` `(snapshot | stop | suspend)` (default=`stop`):: + +Backup mode. + +`-node` `string` :: + +Only run if executed on this node. + +`-pigz` `integer` (default=`0`):: + +Uses pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as +thread count. + +`-quiet` `boolean` (default=`0`):: + +Be quiet. + +`-remove` `boolean` (default=`1`):: + +Remove old backup files if there are more than 'maxfiles' backup files. + +`-script` `string` :: + +Use specified hook script. + +`-size` `integer (500 - N)` :: + +LVM snapshot size in MB. + +`-stdexcludes` `boolean` (default=`1`):: + +Exclude temorary files and logs. + +`-stdout` `boolean` :: + +Write tar to stdout, not to a file. + +`-stop` `boolean` (default=`0`):: + +Stop runnig backup jobs on this host. + +`-stopwait` `integer (0 - N)` :: + +Maximal time to wait until a VM is stopped (minutes). + +`-storage` `string` :: + +Store resulting file to this storage. + +`-tmpdir` `string` :: + +Store temporary files to specified directory. +