mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-06-14 03:55:15 +00:00
update generated docs
This commit is contained in:
Dietmar Maurer
parent
37ea112ef9
commit
013dc89ffc
File diff suppressed because it is too large
Load Diff
@ -1,12 +1,12 @@
|
||||
`console`: `(applet | html5 | vv)` ::
|
||||
`console`: `<applet | html5 | vv>` ::
|
||||
|
||||
Select the default Console viewer. You can either use the builtin java applet (VNC), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC).
|
||||
|
||||
`email_from`: `string` ::
|
||||
`email_from`: `<string>` ::
|
||||
|
||||
Specify email address to send notification from (default is root@$hostname)
|
||||
|
||||
`fencing`: `(both | hardware | watchdog)` (default=`watchdog`)::
|
||||
`fencing`: `<both | hardware | watchdog>` ('default =' `watchdog`)::
|
||||
|
||||
Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.
|
||||
+
|
||||
@ -16,11 +16,11 @@ WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP
|
||||
|
||||
Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')
|
||||
|
||||
`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)` ::
|
||||
`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 keybord layout for vnc server.
|
||||
|
||||
`language`: `(de | en)` ::
|
||||
`language`: `<de | en>` ::
|
||||
|
||||
Default GUI language.
|
||||
|
||||
@ -28,7 +28,7 @@ Default GUI language.
|
||||
|
||||
Prefix for autogenerated MAC addresses.
|
||||
|
||||
`max_workers`: `integer (1 - N)` ::
|
||||
`max_workers`: `<integer> (1 - N)` ::
|
||||
|
||||
Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.
|
||||
|
||||
@ -40,11 +40,11 @@ For cluster wide migration settings.
|
||||
|
||||
CIDR of the (sub) network that is used for migration.
|
||||
|
||||
`type`=`(insecure | secure)` (default=`secure`);;
|
||||
`type`=`<insecure | secure>` ('default =' `secure`);;
|
||||
|
||||
Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
|
||||
|
||||
`migration_unsecure`: `boolean` ::
|
||||
`migration_unsecure`: `<boolean>` ::
|
||||
|
||||
Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead!
|
||||
|
||||
|
||||
@ -4,31 +4,31 @@
|
||||
|
||||
Create a new HA resource.
|
||||
|
||||
`<sid>` `<type>:<name>` ::
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
|
||||
|
||||
`-comment` `string` ::
|
||||
`-comment` `<string>` ::
|
||||
|
||||
Description.
|
||||
|
||||
`-group` `string` ::
|
||||
`-group` `<string>` ::
|
||||
|
||||
The HA group identifier.
|
||||
|
||||
`-max_relocate` `integer (0 - N)` (default=`1`)::
|
||||
`-max_relocate` `<integer> (0 - N)` ('default =' `1`)::
|
||||
|
||||
Maximal number of service relocate tries when a service failes to start.
|
||||
|
||||
`-max_restart` `integer (0 - N)` (default=`1`)::
|
||||
`-max_restart` `<integer> (0 - N)` ('default =' `1`)::
|
||||
|
||||
Maximal number of tries to restart the service on a node after its start failed.
|
||||
|
||||
`-state` `(disabled | enabled)` (default=`enabled`)::
|
||||
`-state` `<disabled | enabled>` ('default =' `enabled`)::
|
||||
|
||||
Resource state.
|
||||
|
||||
`-type` `(ct | vm)` ::
|
||||
`-type` `<ct | vm>` ::
|
||||
|
||||
Resource type.
|
||||
|
||||
@ -38,7 +38,7 @@ Resource type.
|
||||
|
||||
List HA resources.
|
||||
|
||||
`-type` `(ct | vm)` ::
|
||||
`-type` `<ct | vm>` ::
|
||||
|
||||
Only list resources of specific type
|
||||
|
||||
@ -49,7 +49,7 @@ Only list resources of specific type
|
||||
|
||||
Disable a HA resource.
|
||||
|
||||
`<sid>` `<type>:<name>` ::
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
|
||||
|
||||
@ -59,7 +59,7 @@ HA resource ID. This consists of a resource type followed by a resource specific
|
||||
|
||||
Enable a HA resource.
|
||||
|
||||
`<sid>` `<type>:<name>` ::
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
|
||||
|
||||
@ -70,11 +70,11 @@ HA resource ID. This consists of a resource type followed by a resource specific
|
||||
|
||||
Create a new HA group.
|
||||
|
||||
`<group>` `string` ::
|
||||
`<group>`: `<string>` ::
|
||||
|
||||
The HA group identifier.
|
||||
|
||||
`-comment` `string` ::
|
||||
`-comment` `<string>` ::
|
||||
|
||||
Description.
|
||||
|
||||
@ -82,15 +82,15 @@ Description.
|
||||
|
||||
List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').
|
||||
|
||||
`-nofailback` `boolean` (default=`0`)::
|
||||
`-nofailback` `<boolean>` ('default =' `0`)::
|
||||
|
||||
The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.
|
||||
|
||||
`-restricted` `boolean` (default=`0`)::
|
||||
`-restricted` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.
|
||||
|
||||
`-type` `(group)` ::
|
||||
`-type` `<group>` ::
|
||||
|
||||
Group type.
|
||||
|
||||
@ -106,7 +106,7 @@ Get HA groups.
|
||||
|
||||
Delete ha group configuration.
|
||||
|
||||
`<group>` `string` ::
|
||||
`<group>`: `<string>` ::
|
||||
|
||||
The HA group identifier.
|
||||
|
||||
@ -116,19 +116,19 @@ The HA group identifier.
|
||||
|
||||
Update ha group configuration.
|
||||
|
||||
`<group>` `string` ::
|
||||
`<group>`: `<string>` ::
|
||||
|
||||
The HA group identifier.
|
||||
|
||||
`-comment` `string` ::
|
||||
`-comment` `<string>` ::
|
||||
|
||||
Description.
|
||||
|
||||
`-delete` `string` ::
|
||||
`-delete` `<string>` ::
|
||||
|
||||
A list of settings you want to delete.
|
||||
|
||||
`-digest` `string` ::
|
||||
`-digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
@ -136,11 +136,11 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
|
||||
|
||||
List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback').
|
||||
|
||||
`-nofailback` `boolean` (default=`0`)::
|
||||
`-nofailback` `<boolean>` ('default =' `0`)::
|
||||
|
||||
The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.
|
||||
|
||||
`-restricted` `boolean` (default=`0`)::
|
||||
`-restricted` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member.
|
||||
|
||||
@ -151,11 +151,11 @@ Services on unrestricted groups may run on any cluster members if all group memb
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -166,11 +166,11 @@ Verbose output format.
|
||||
|
||||
Request resource migration (online) to another node.
|
||||
|
||||
`<sid>` `<type>:<name>` ::
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
|
||||
|
||||
`<node>` `string` ::
|
||||
`<node>`: `<string>` ::
|
||||
|
||||
The cluster node name.
|
||||
|
||||
@ -181,11 +181,11 @@ The cluster node name.
|
||||
Request resource relocatzion to another node. This stops the service on the
|
||||
old node, and restarts it on the target node.
|
||||
|
||||
`<sid>` `<type>:<name>` ::
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
|
||||
|
||||
`<node>` `string` ::
|
||||
`<node>`: `<string>` ::
|
||||
|
||||
The cluster node name.
|
||||
|
||||
@ -195,7 +195,7 @@ The cluster node name.
|
||||
|
||||
Delete resource configuration.
|
||||
|
||||
`<sid>` `<type>:<name>` ::
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
|
||||
|
||||
@ -205,35 +205,35 @@ HA resource ID. This consists of a resource type followed by a resource specific
|
||||
|
||||
Update resource configuration.
|
||||
|
||||
`<sid>` `<type>:<name>` ::
|
||||
`<sid>`: `<type>:<name>` ::
|
||||
|
||||
HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).
|
||||
|
||||
`-comment` `string` ::
|
||||
`-comment` `<string>` ::
|
||||
|
||||
Description.
|
||||
|
||||
`-delete` `string` ::
|
||||
`-delete` `<string>` ::
|
||||
|
||||
A list of settings you want to delete.
|
||||
|
||||
`-digest` `string` ::
|
||||
`-digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`-group` `string` ::
|
||||
`-group` `<string>` ::
|
||||
|
||||
The HA group identifier.
|
||||
|
||||
`-max_relocate` `integer (0 - N)` (default=`1`)::
|
||||
`-max_relocate` `<integer> (0 - N)` ('default =' `1`)::
|
||||
|
||||
Maximal number of service relocate tries when a service failes to start.
|
||||
|
||||
`-max_restart` `integer (0 - N)` (default=`1`)::
|
||||
`-max_restart` `<integer> (0 - N)` ('default =' `1`)::
|
||||
|
||||
Maximal number of tries to restart the service on a node after its start failed.
|
||||
|
||||
`-state` `(disabled | enabled)` (default=`enabled`)::
|
||||
`-state` `<disabled | enabled>` ('default =' `enabled`)::
|
||||
|
||||
Resource state.
|
||||
|
||||
@ -244,7 +244,7 @@ Resource state.
|
||||
|
||||
Display HA manger status.
|
||||
|
||||
`-verbose` `boolean` (default=`0`)::
|
||||
`-verbose` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Verbose output. Include complete CRM and LRM status (JSON).
|
||||
|
||||
|
||||
@ -2,11 +2,11 @@
|
||||
|
||||
`mp[n]`: `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]`
|
||||
|
||||
`acl`: `boolean` ::
|
||||
`acl`: `<boolean>` ::
|
||||
|
||||
Explicitly enable or disable ACL support.
|
||||
|
||||
`backup`: `boolean` ::
|
||||
`backup`: `<boolean>` ::
|
||||
|
||||
Whether to include the mount point in backups (only used for volume mount points).
|
||||
|
||||
@ -16,15 +16,15 @@ Path to the mount point as seen from inside the container.
|
||||
+
|
||||
NOTE: Must not contain any symlinks for security reasons.
|
||||
|
||||
`quota`: `boolean` ::
|
||||
`quota`: `<boolean>` ::
|
||||
|
||||
Enable user quotas inside the container (not supported with zfs subvolumes)
|
||||
|
||||
`ro`: `boolean` ::
|
||||
`ro`: `<boolean>` ::
|
||||
|
||||
Read-only mount point
|
||||
|
||||
`shared`: `boolean` (default=`0`)::
|
||||
`shared`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Mark this non-volume mount point as available on all nodes.
|
||||
+
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
Bridge to attach the network device to.
|
||||
|
||||
`firewall`: `boolean` ::
|
||||
`firewall`: `<boolean>` ::
|
||||
|
||||
Controls whether this interface's firewall rules should be used.
|
||||
|
||||
@ -28,7 +28,7 @@ IPv4 address in CIDR format.
|
||||
|
||||
IPv6 address in CIDR format.
|
||||
|
||||
`mtu`: `integer (64 - N)` ::
|
||||
`mtu`: `<integer> (64 - N)` ::
|
||||
|
||||
Maximum transfer unit of the interface. (lxc.network.mtu)
|
||||
|
||||
@ -40,7 +40,7 @@ Name of the network device as seen from inside the container. (lxc.network.name)
|
||||
|
||||
Apply rate limiting to the interface
|
||||
|
||||
`tag`: `integer (1 - 4094)` ::
|
||||
`tag`: `<integer> (1 - 4094)` ::
|
||||
|
||||
VLAN tag for this interface.
|
||||
|
||||
@ -48,7 +48,7 @@ VLAN tag for this interface.
|
||||
|
||||
VLAN ids to pass through the interface
|
||||
|
||||
`type`: `(veth)` ::
|
||||
`type`: `<veth>` ::
|
||||
|
||||
Network interface type.
|
||||
|
||||
|
||||
@ -4,39 +4,39 @@
|
||||
|
||||
Create a container clone/copy
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<newid>` `integer (1 - N)` ::
|
||||
`<newid>`: `<integer> (1 - N)` ::
|
||||
|
||||
VMID for the clone.
|
||||
|
||||
`-description` `string` ::
|
||||
`-description` `<string>` ::
|
||||
|
||||
Description for the new CT.
|
||||
|
||||
`-experimental` `boolean` (default=`0`)::
|
||||
`-experimental` `<boolean>` ('default =' `0`)::
|
||||
|
||||
The clone feature is experimental, set this flag if you know what you are doing.
|
||||
|
||||
`-full` `boolean` (default=`0`)::
|
||||
`-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` ::
|
||||
`-hostname` `<string>` ::
|
||||
|
||||
Set a hostname for the new CT.
|
||||
|
||||
`-pool` `string` ::
|
||||
`-pool` `<string>` ::
|
||||
|
||||
Add the new CT to the specified pool.
|
||||
|
||||
`-snapname` `string` ::
|
||||
`-snapname` `<string>` ::
|
||||
|
||||
The name of the snapshot.
|
||||
|
||||
`-storage` `string` ::
|
||||
`-storage` `<string>` ::
|
||||
|
||||
Target storage for full clone.
|
||||
+
|
||||
@ -49,7 +49,7 @@ NOTE: Requires option(s): `full`
|
||||
|
||||
Get container configuration.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -60,7 +60,7 @@ The (unique) ID of the VM.
|
||||
|
||||
Launch a console for the specified container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -77,63 +77,63 @@ Print the list of assigned CPU sets.
|
||||
|
||||
Create or restore a container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<ostemplate>` `string` ::
|
||||
`<ostemplate>`: `<string>` ::
|
||||
|
||||
The OS template or backup file.
|
||||
|
||||
`-arch` `(amd64 | i386)` (default=`amd64`)::
|
||||
`-arch` `<amd64 | i386>` ('default =' `amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
`-cmode` `(console | shell | tty)` (default=`tty`)::
|
||||
`-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`)::
|
||||
`-console` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`-cores` `integer (1 - 128)` ::
|
||||
`-cores` `<integer> (1 - 128)` ::
|
||||
|
||||
The number of cores assigned to the container. A container can use all available cores by default.
|
||||
|
||||
`-cpulimit` `number (0 - 128)` (default=`0`)::
|
||||
`-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
|
||||
|
||||
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`)::
|
||||
`-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 the weights of all the other running VMs.
|
||||
+
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`-description` `string` ::
|
||||
`-description` `<string>` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`-force` `boolean` ::
|
||||
`-force` `<boolean>` ::
|
||||
|
||||
Allow to overwrite existing container.
|
||||
|
||||
`-hostname` `string` ::
|
||||
`-hostname` `<string>` ::
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`-ignore-unpack-errors` `boolean` ::
|
||||
`-ignore-unpack-errors` `<boolean>` ::
|
||||
|
||||
Ignore errors when extracting the template.
|
||||
|
||||
`-lock` `(backup | migrate | rollback | snapshot)` ::
|
||||
`-lock` `<backup | migrate | rollback | snapshot>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`-memory` `integer (16 - N)` (default=`512`)::
|
||||
`-memory` `<integer> (16 - N)` ('default =' `512`)::
|
||||
|
||||
Amount of RAM for the VM in MB.
|
||||
|
||||
@ -141,7 +141,7 @@ Amount of RAM for the VM in MB.
|
||||
|
||||
Use volume as container mount point.
|
||||
|
||||
`-nameserver` `string` ::
|
||||
`-nameserver` `<string>` ::
|
||||
|
||||
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
|
||||
|
||||
@ -149,11 +149,11 @@ Sets DNS server IP address for a container. Create will automatically use the se
|
||||
|
||||
Specifies network interfaces for the container.
|
||||
|
||||
`-onboot` `boolean` (default=`0`)::
|
||||
`-onboot` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`-ostype` `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` ::
|
||||
`-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
|
||||
OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
|
||||
|
||||
@ -161,15 +161,15 @@ OS type. This is used to setup configuration inside the container, and correspon
|
||||
|
||||
Sets root password inside container.
|
||||
|
||||
`-pool` `string` ::
|
||||
`-pool` `<string>` ::
|
||||
|
||||
Add the VM to the specified pool.
|
||||
|
||||
`-protection` `boolean` (default=`0`)::
|
||||
`-protection` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
|
||||
|
||||
`-restore` `boolean` ::
|
||||
`-restore` `<boolean>` ::
|
||||
|
||||
Mark this as restore task.
|
||||
|
||||
@ -177,11 +177,11 @@ Mark this as restore task.
|
||||
|
||||
Use volume as container root.
|
||||
|
||||
`-searchdomain` `string` ::
|
||||
`-searchdomain` `<string>` ::
|
||||
|
||||
Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
|
||||
|
||||
`-ssh-public-keys` `filepath` ::
|
||||
`-ssh-public-keys` `<string>` ::
|
||||
|
||||
Setup public SSH keys (one key per line, OpenSSH format).
|
||||
|
||||
@ -189,27 +189,27 @@ Setup public SSH keys (one key per line, OpenSSH format).
|
||||
|
||||
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`)::
|
||||
`-storage` `<string>` ('default =' `local`)::
|
||||
|
||||
Default Storage.
|
||||
|
||||
`-swap` `integer (0 - N)` (default=`512`)::
|
||||
`-swap` `<integer> (0 - N)` ('default =' `512`)::
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`-template` `boolean` (default=`0`)::
|
||||
`-template` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`-tty` `integer (0 - 6)` (default=`2`)::
|
||||
`-tty` `<integer> (0 - 6)` ('default =' `2`)::
|
||||
|
||||
Specify the number of tty available to the container
|
||||
|
||||
`-unprivileged` `boolean` (default=`0`)::
|
||||
`-unprivileged` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Makes the container run as unprivileged user. (Should not be modified manually.)
|
||||
|
||||
`-unused[n]` `string` ::
|
||||
`-unused[n]` `<string>` ::
|
||||
|
||||
Reference to unused volumes. This is used internally, and should not be modified manually.
|
||||
|
||||
@ -220,15 +220,15 @@ Reference to unused volumes. This is used internally, and should not be modified
|
||||
|
||||
Delete a LXC snapshot.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<snapname>` `string` ::
|
||||
`<snapname>`: `<string>` ::
|
||||
|
||||
The name of the snapshot.
|
||||
|
||||
`-force` `boolean` ::
|
||||
`-force` `<boolean>` ::
|
||||
|
||||
For removal from config file, even if removing disk snapshots fails.
|
||||
|
||||
@ -239,7 +239,7 @@ For removal from config file, even if removing disk snapshots fails.
|
||||
|
||||
Destroy the container (also delete all uses files).
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -250,7 +250,7 @@ The (unique) ID of the VM.
|
||||
|
||||
Get the container's current disk usage.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -260,7 +260,7 @@ The (unique) ID of the VM.
|
||||
|
||||
Launch a shell for the specified container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -270,11 +270,11 @@ The (unique) ID of the VM.
|
||||
|
||||
Launch a command inside the specified container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<extra-args>` `array` ::
|
||||
`<extra-args>`: `<array>` ::
|
||||
|
||||
Extra arguments as array
|
||||
|
||||
@ -284,15 +284,15 @@ Extra arguments as array
|
||||
|
||||
Run a filesystem check (fsck) on a container volume.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-device` `(mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs)` ::
|
||||
`-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` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Force checking, even if the filesystem seems clean
|
||||
|
||||
@ -303,11 +303,11 @@ Force checking, even if the filesystem seems clean
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -325,7 +325,7 @@ LXC container index (per node).
|
||||
|
||||
List all snapshots.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -336,19 +336,19 @@ The (unique) ID of the VM.
|
||||
|
||||
Migrate the container to another node. Creates a new migration task.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<target>` `string` ::
|
||||
`<target>`: `<string>` ::
|
||||
|
||||
Target node.
|
||||
|
||||
`-force` `boolean` ::
|
||||
`-force` `<boolean>` ::
|
||||
|
||||
Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
|
||||
|
||||
`-online` `boolean` ::
|
||||
`-online` `<boolean>` ::
|
||||
|
||||
Use online/live migration.
|
||||
|
||||
@ -361,7 +361,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.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -371,27 +371,27 @@ The (unique) ID of the VM.
|
||||
|
||||
Copy a file from the container to the local system.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<path>` `string` ::
|
||||
`<path>`: `<string>` ::
|
||||
|
||||
Path to a file inside the container to pull.
|
||||
|
||||
`<destination>` `string` ::
|
||||
`<destination>`: `<string>` ::
|
||||
|
||||
Destination
|
||||
|
||||
`-group` `string` ::
|
||||
`-group` `<string>` ::
|
||||
|
||||
Owner group name or id.
|
||||
|
||||
`-perms` `string` ::
|
||||
`-perms` `<string>` ::
|
||||
|
||||
File permissions to use (octal by default, prefix with '0x' for hexadecimal).
|
||||
|
||||
`-user` `string` ::
|
||||
`-user` `<string>` ::
|
||||
|
||||
Owner user name or id.
|
||||
|
||||
@ -401,27 +401,27 @@ Owner user name or id.
|
||||
|
||||
Copy a local file to the container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<file>` `string` ::
|
||||
`<file>`: `<string>` ::
|
||||
|
||||
Path to a local file.
|
||||
|
||||
`<destination>` `string` ::
|
||||
`<destination>`: `<string>` ::
|
||||
|
||||
Destination inside the container to write to.
|
||||
|
||||
`-group` `string` ::
|
||||
`-group` `<string>` ::
|
||||
|
||||
Owner group name or id. When using a name it must exist inside the container.
|
||||
|
||||
`-perms` `string` ::
|
||||
`-perms` `<string>` ::
|
||||
|
||||
File permissions to use (octal by default, prefix with '0x' for hexadecimal).
|
||||
|
||||
`-user` `string` ::
|
||||
`-user` `<string>` ::
|
||||
|
||||
Owner user name or id. When using a name it must exist inside the container.
|
||||
|
||||
@ -432,19 +432,19 @@ Owner user name or id. When using a name it must exist inside the container.
|
||||
|
||||
Resize a container mount point.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<disk>` `(mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs)` ::
|
||||
`<disk>`: `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
|
||||
|
||||
The disk you want to resize.
|
||||
|
||||
`<size>` `\+?\d+(\.\d+)?[KMGT]?` ::
|
||||
`<size>`: `\+?\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` ::
|
||||
`-digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
@ -454,63 +454,63 @@ Prevent changes if current configuration file has different SHA1 digest. This ca
|
||||
|
||||
Create or restore a container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<ostemplate>` `string` ::
|
||||
`<ostemplate>`: `<string>` ::
|
||||
|
||||
The OS template or backup file.
|
||||
|
||||
`-arch` `(amd64 | i386)` (default=`amd64`)::
|
||||
`-arch` `<amd64 | i386>` ('default =' `amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
`-cmode` `(console | shell | tty)` (default=`tty`)::
|
||||
`-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`)::
|
||||
`-console` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`-cores` `integer (1 - 128)` ::
|
||||
`-cores` `<integer> (1 - 128)` ::
|
||||
|
||||
The number of cores assigned to the container. A container can use all available cores by default.
|
||||
|
||||
`-cpulimit` `number (0 - 128)` (default=`0`)::
|
||||
`-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
|
||||
|
||||
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`)::
|
||||
`-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 the weights of all the other running VMs.
|
||||
+
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`-description` `string` ::
|
||||
`-description` `<string>` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`-force` `boolean` ::
|
||||
`-force` `<boolean>` ::
|
||||
|
||||
Allow to overwrite existing container.
|
||||
|
||||
`-hostname` `string` ::
|
||||
`-hostname` `<string>` ::
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`-ignore-unpack-errors` `boolean` ::
|
||||
`-ignore-unpack-errors` `<boolean>` ::
|
||||
|
||||
Ignore errors when extracting the template.
|
||||
|
||||
`-lock` `(backup | migrate | rollback | snapshot)` ::
|
||||
`-lock` `<backup | migrate | rollback | snapshot>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`-memory` `integer (16 - N)` (default=`512`)::
|
||||
`-memory` `<integer> (16 - N)` ('default =' `512`)::
|
||||
|
||||
Amount of RAM for the VM in MB.
|
||||
|
||||
@ -518,7 +518,7 @@ Amount of RAM for the VM in MB.
|
||||
|
||||
Use volume as container mount point.
|
||||
|
||||
`-nameserver` `string` ::
|
||||
`-nameserver` `<string>` ::
|
||||
|
||||
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
|
||||
|
||||
@ -526,11 +526,11 @@ Sets DNS server IP address for a container. Create will automatically use the se
|
||||
|
||||
Specifies network interfaces for the container.
|
||||
|
||||
`-onboot` `boolean` (default=`0`)::
|
||||
`-onboot` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`-ostype` `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` ::
|
||||
`-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
|
||||
OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
|
||||
|
||||
@ -538,11 +538,11 @@ OS type. This is used to setup configuration inside the container, and correspon
|
||||
|
||||
Sets root password inside container.
|
||||
|
||||
`-pool` `string` ::
|
||||
`-pool` `<string>` ::
|
||||
|
||||
Add the VM to the specified pool.
|
||||
|
||||
`-protection` `boolean` (default=`0`)::
|
||||
`-protection` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
|
||||
|
||||
@ -550,11 +550,11 @@ Sets the protection flag of the container. This will prevent the CT or CT's disk
|
||||
|
||||
Use volume as container root.
|
||||
|
||||
`-searchdomain` `string` ::
|
||||
`-searchdomain` `<string>` ::
|
||||
|
||||
Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
|
||||
|
||||
`-ssh-public-keys` `filepath` ::
|
||||
`-ssh-public-keys` `<string>` ::
|
||||
|
||||
Setup public SSH keys (one key per line, OpenSSH format).
|
||||
|
||||
@ -562,27 +562,27 @@ Setup public SSH keys (one key per line, OpenSSH format).
|
||||
|
||||
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`)::
|
||||
`-storage` `<string>` ('default =' `local`)::
|
||||
|
||||
Default Storage.
|
||||
|
||||
`-swap` `integer (0 - N)` (default=`512`)::
|
||||
`-swap` `<integer> (0 - N)` ('default =' `512`)::
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`-template` `boolean` (default=`0`)::
|
||||
`-template` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`-tty` `integer (0 - 6)` (default=`2`)::
|
||||
`-tty` `<integer> (0 - 6)` ('default =' `2`)::
|
||||
|
||||
Specify the number of tty available to the container
|
||||
|
||||
`-unprivileged` `boolean` (default=`0`)::
|
||||
`-unprivileged` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Makes the container run as unprivileged user. (Should not be modified manually.)
|
||||
|
||||
`-unused[n]` `string` ::
|
||||
`-unused[n]` `<string>` ::
|
||||
|
||||
Reference to unused volumes. This is used internally, and should not be modified manually.
|
||||
|
||||
@ -593,7 +593,7 @@ Reference to unused volumes. This is used internally, and should not be modified
|
||||
|
||||
Resume the container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -604,11 +604,11 @@ The (unique) ID of the VM.
|
||||
|
||||
Rollback LXC state to specified snapshot.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<snapname>` `string` ::
|
||||
`<snapname>`: `<string>` ::
|
||||
|
||||
The name of the snapshot.
|
||||
|
||||
@ -619,59 +619,59 @@ The name of the snapshot.
|
||||
|
||||
Set container options.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-arch` `(amd64 | i386)` (default=`amd64`)::
|
||||
`-arch` `<amd64 | i386>` ('default =' `amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
`-cmode` `(console | shell | tty)` (default=`tty`)::
|
||||
`-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`)::
|
||||
`-console` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`-cores` `integer (1 - 128)` ::
|
||||
`-cores` `<integer> (1 - 128)` ::
|
||||
|
||||
The number of cores assigned to the container. A container can use all available cores by default.
|
||||
|
||||
`-cpulimit` `number (0 - 128)` (default=`0`)::
|
||||
`-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
|
||||
|
||||
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`)::
|
||||
`-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 the weights of all the other running VMs.
|
||||
+
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`-delete` `string` ::
|
||||
`-delete` `<string>` ::
|
||||
|
||||
A list of settings you want to delete.
|
||||
|
||||
`-description` `string` ::
|
||||
`-description` `<string>` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`-digest` `string` ::
|
||||
`-digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`-hostname` `string` ::
|
||||
`-hostname` `<string>` ::
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`-lock` `(backup | migrate | rollback | snapshot)` ::
|
||||
`-lock` `<backup | migrate | rollback | snapshot>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`-memory` `integer (16 - N)` (default=`512`)::
|
||||
`-memory` `<integer> (16 - N)` ('default =' `512`)::
|
||||
|
||||
Amount of RAM for the VM in MB.
|
||||
|
||||
@ -679,7 +679,7 @@ Amount of RAM for the VM in MB.
|
||||
|
||||
Use volume as container mount point.
|
||||
|
||||
`-nameserver` `string` ::
|
||||
`-nameserver` `<string>` ::
|
||||
|
||||
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
|
||||
|
||||
@ -687,15 +687,15 @@ Sets DNS server IP address for a container. Create will automatically use the se
|
||||
|
||||
Specifies network interfaces for the container.
|
||||
|
||||
`-onboot` `boolean` (default=`0`)::
|
||||
`-onboot` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`-ostype` `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` ::
|
||||
`-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
|
||||
OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
|
||||
|
||||
`-protection` `boolean` (default=`0`)::
|
||||
`-protection` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
|
||||
|
||||
@ -703,7 +703,7 @@ Sets the protection flag of the container. This will prevent the CT or CT's disk
|
||||
|
||||
Use volume as container root.
|
||||
|
||||
`-searchdomain` `string` ::
|
||||
`-searchdomain` `<string>` ::
|
||||
|
||||
Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
|
||||
|
||||
@ -711,23 +711,23 @@ Sets DNS search domains for a container. Create will automatically use the setti
|
||||
|
||||
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`)::
|
||||
`-swap` `<integer> (0 - N)` ('default =' `512`)::
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`-template` `boolean` (default=`0`)::
|
||||
`-template` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`-tty` `integer (0 - 6)` (default=`2`)::
|
||||
`-tty` `<integer> (0 - 6)` ('default =' `2`)::
|
||||
|
||||
Specify the number of tty available to the container
|
||||
|
||||
`-unprivileged` `boolean` (default=`0`)::
|
||||
`-unprivileged` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Makes the container run as unprivileged user. (Should not be modified manually.)
|
||||
|
||||
`-unused[n]` `string` ::
|
||||
`-unused[n]` `<string>` ::
|
||||
|
||||
Reference to unused volumes. This is used internally, and should not be modified manually.
|
||||
|
||||
@ -739,15 +739,15 @@ 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.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-forceStop` `boolean` (default=`0`)::
|
||||
`-forceStop` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Make sure the Container stops.
|
||||
|
||||
`-timeout` `integer (0 - N)` (default=`60`)::
|
||||
`-timeout` `<integer> (0 - N)` ('default =' `60`)::
|
||||
|
||||
Wait maximal timeout seconds.
|
||||
|
||||
@ -758,15 +758,15 @@ Wait maximal timeout seconds.
|
||||
|
||||
Snapshot a container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<snapname>` `string` ::
|
||||
`<snapname>`: `<string>` ::
|
||||
|
||||
The name of the snapshot.
|
||||
|
||||
`-description` `string` ::
|
||||
`-description` `<string>` ::
|
||||
|
||||
A textual description or comment.
|
||||
|
||||
@ -777,11 +777,11 @@ A textual description or comment.
|
||||
|
||||
Start the container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-skiplock` `boolean` ::
|
||||
`-skiplock` `<boolean>` ::
|
||||
|
||||
Ignore locks - only root is allowed to use this option.
|
||||
|
||||
@ -792,11 +792,11 @@ Ignore locks - only root is allowed to use this option.
|
||||
|
||||
Show CT status.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format
|
||||
|
||||
@ -808,11 +808,11 @@ Verbose output format
|
||||
Stop the container. This will abruptly stop all processes running in the
|
||||
container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-skiplock` `boolean` ::
|
||||
`-skiplock` `<boolean>` ::
|
||||
|
||||
Ignore locks - only root is allowed to use this option.
|
||||
|
||||
@ -822,7 +822,7 @@ Ignore locks - only root is allowed to use this option.
|
||||
|
||||
Suspend the container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -833,11 +833,11 @@ The (unique) ID of the VM.
|
||||
|
||||
Create a Template.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-experimental` `boolean` (default=`0`)::
|
||||
`-experimental` `<boolean>` ('default =' `0`)::
|
||||
|
||||
The template feature is experimental, set this flag if you know what you are doing.
|
||||
|
||||
@ -848,7 +848,7 @@ The template feature is experimental, set this flag if you know what you are doi
|
||||
|
||||
Unlock the VM.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
@ -858,7 +858,7 @@ The (unique) ID of the VM.
|
||||
|
||||
Unmount the container's filesystem.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
@ -1,44 +1,44 @@
|
||||
`arch`: `(amd64 | i386)` (default=`amd64`)::
|
||||
`arch`: `<amd64 | i386>` ('default =' `amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
`cmode`: `(console | shell | tty)` (default=`tty`)::
|
||||
`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`)::
|
||||
`console`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`cores`: `integer (1 - 128)` ::
|
||||
`cores`: `<integer> (1 - 128)` ::
|
||||
|
||||
The number of cores assigned to the container. A container can use all available cores by default.
|
||||
|
||||
`cpulimit`: `number (0 - 128)` (default=`0`)::
|
||||
`cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
|
||||
|
||||
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`)::
|
||||
`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 the weights of all the other running VMs.
|
||||
+
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`description`: `string` ::
|
||||
`description`: `<string>` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`hostname`: `string` ::
|
||||
`hostname`: `<string>` ::
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`lock`: `(backup | migrate | rollback | snapshot)` ::
|
||||
`lock`: `<backup | migrate | rollback | snapshot>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`memory`: `integer (16 - N)` (default=`512`)::
|
||||
`memory`: `<integer> (16 - N)` ('default =' `512`)::
|
||||
|
||||
Amount of RAM for the VM in MB.
|
||||
|
||||
@ -46,11 +46,11 @@ Amount of RAM for the VM in MB.
|
||||
|
||||
Use volume as container mount point.
|
||||
|
||||
`acl`=`boolean` ;;
|
||||
`acl`=`<boolean>` ;;
|
||||
|
||||
Explicitly enable or disable ACL support.
|
||||
|
||||
`backup`=`boolean` ;;
|
||||
`backup`=`<boolean>` ;;
|
||||
|
||||
Whether to include the mount point in backups (only used for volume mount points).
|
||||
|
||||
@ -60,15 +60,15 @@ Path to the mount point as seen from inside the container.
|
||||
+
|
||||
NOTE: Must not contain any symlinks for security reasons.
|
||||
|
||||
`quota`=`boolean` ;;
|
||||
`quota`=`<boolean>` ;;
|
||||
|
||||
Enable user quotas inside the container (not supported with zfs subvolumes)
|
||||
|
||||
`ro`=`boolean` ;;
|
||||
`ro`=`<boolean>` ;;
|
||||
|
||||
Read-only mount point
|
||||
|
||||
`shared`=`boolean` (default=`0`);;
|
||||
`shared`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Mark this non-volume mount point as available on all nodes.
|
||||
+
|
||||
@ -82,7 +82,7 @@ Volume size (read only value).
|
||||
|
||||
Volume, device or directory to mount into the container.
|
||||
|
||||
`nameserver`: `string` ::
|
||||
`nameserver`: `<string>` ::
|
||||
|
||||
Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
|
||||
|
||||
@ -94,7 +94,7 @@ Specifies network interfaces for the container.
|
||||
|
||||
Bridge to attach the network device to.
|
||||
|
||||
`firewall`=`boolean` ;;
|
||||
`firewall`=`<boolean>` ;;
|
||||
|
||||
Controls whether this interface's firewall rules should be used.
|
||||
|
||||
@ -118,7 +118,7 @@ IPv4 address in CIDR format.
|
||||
|
||||
IPv6 address in CIDR format.
|
||||
|
||||
`mtu`=`integer (64 - N)` ;;
|
||||
`mtu`=`<integer> (64 - N)` ;;
|
||||
|
||||
Maximum transfer unit of the interface. (lxc.network.mtu)
|
||||
|
||||
@ -130,7 +130,7 @@ Name of the network device as seen from inside the container. (lxc.network.name)
|
||||
|
||||
Apply rate limiting to the interface
|
||||
|
||||
`tag`=`integer (1 - 4094)` ;;
|
||||
`tag`=`<integer> (1 - 4094)` ;;
|
||||
|
||||
VLAN tag for this interface.
|
||||
|
||||
@ -138,19 +138,19 @@ VLAN tag for this interface.
|
||||
|
||||
VLAN ids to pass through the interface
|
||||
|
||||
`type`=`(veth)` ;;
|
||||
`type`=`<veth>` ;;
|
||||
|
||||
Network interface type.
|
||||
|
||||
`onboot`: `boolean` (default=`0`)::
|
||||
`onboot`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`ostype`: `(alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged)` ::
|
||||
`ostype`: `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
|
||||
|
||||
OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.
|
||||
|
||||
`protection`: `boolean` (default=`0`)::
|
||||
`protection`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.
|
||||
|
||||
@ -158,19 +158,19 @@ Sets the protection flag of the container. This will prevent the CT or CT's disk
|
||||
|
||||
Use volume as container root.
|
||||
|
||||
`acl`=`boolean` ;;
|
||||
`acl`=`<boolean>` ;;
|
||||
|
||||
Explicitly enable or disable ACL support.
|
||||
|
||||
`quota`=`boolean` ;;
|
||||
`quota`=`<boolean>` ;;
|
||||
|
||||
Enable user quotas inside the container (not supported with zfs subvolumes)
|
||||
|
||||
`ro`=`boolean` ;;
|
||||
`ro`=`<boolean>` ;;
|
||||
|
||||
Read-only mount point
|
||||
|
||||
`shared`=`boolean` (default=`0`);;
|
||||
`shared`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Mark this non-volume mount point as available on all nodes.
|
||||
+
|
||||
@ -184,7 +184,7 @@ Volume size (read only value).
|
||||
|
||||
Volume, device or directory to mount into the container.
|
||||
|
||||
`searchdomain`: `string` ::
|
||||
`searchdomain`: `<string>` ::
|
||||
|
||||
Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
|
||||
|
||||
@ -192,23 +192,23 @@ Sets DNS search domains for a container. Create will automatically use the setti
|
||||
|
||||
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`)::
|
||||
`swap`: `<integer> (0 - N)` ('default =' `512`)::
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`template`: `boolean` (default=`0`)::
|
||||
`template`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`tty`: `integer (0 - 6)` (default=`2`)::
|
||||
`tty`: `<integer> (0 - 6)` ('default =' `2`)::
|
||||
|
||||
Specify the number of tty available to the container
|
||||
|
||||
`unprivileged`: `boolean` (default=`0`)::
|
||||
`unprivileged`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Makes the container run as unprivileged user. (Should not be modified manually.)
|
||||
|
||||
`unused[n]`: `string` ::
|
||||
`unused[n]`: `<string>` ::
|
||||
|
||||
Reference to unused volumes. This is used internally, and should not be modified manually.
|
||||
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
`enable`: `integer (0 - N)` ::
|
||||
`enable`: `<integer> (0 - N)` ::
|
||||
|
||||
Enable or disable the firewall cluster wide.
|
||||
|
||||
`policy_in`: `(ACCEPT | DROP | REJECT)` ::
|
||||
`policy_in`: `<ACCEPT | DROP | REJECT>` ::
|
||||
|
||||
Input policy.
|
||||
|
||||
`policy_out`: `(ACCEPT | DROP | REJECT)` ::
|
||||
`policy_out`: `<ACCEPT | DROP | REJECT>` ::
|
||||
|
||||
Output policy.
|
||||
|
||||
|
||||
@ -1,40 +1,40 @@
|
||||
`enable`: `boolean` ::
|
||||
`enable`: `<boolean>` ::
|
||||
|
||||
Enable host firewall rules.
|
||||
|
||||
`log_level_in`: `(alert | crit | debug | emerg | err | info | nolog | notice | warning)` ::
|
||||
`log_level_in`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
|
||||
|
||||
Log level for incoming traffic.
|
||||
|
||||
`log_level_out`: `(alert | crit | debug | emerg | err | info | nolog | notice | warning)` ::
|
||||
`log_level_out`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
|
||||
|
||||
Log level for outgoing traffic.
|
||||
|
||||
`ndp`: `boolean` ::
|
||||
`ndp`: `<boolean>` ::
|
||||
|
||||
Enable NDP.
|
||||
|
||||
`nf_conntrack_max`: `integer (32768 - N)` ::
|
||||
`nf_conntrack_max`: `<integer> (32768 - N)` ::
|
||||
|
||||
Maximum number of tracked connections.
|
||||
|
||||
`nf_conntrack_tcp_timeout_established`: `integer (7875 - N)` ::
|
||||
`nf_conntrack_tcp_timeout_established`: `<integer> (7875 - N)` ::
|
||||
|
||||
Conntrack established timeout.
|
||||
|
||||
`nosmurfs`: `boolean` ::
|
||||
`nosmurfs`: `<boolean>` ::
|
||||
|
||||
Enable SMURFS filter.
|
||||
|
||||
`smurf_log_level`: `(alert | crit | debug | emerg | err | info | nolog | notice | warning)` ::
|
||||
`smurf_log_level`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
|
||||
|
||||
Log level for SMURFS filter.
|
||||
|
||||
`tcp_flags_log_level`: `(alert | crit | debug | emerg | err | info | nolog | notice | warning)` ::
|
||||
`tcp_flags_log_level`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
|
||||
|
||||
Log level for illegal tcp flags filter.
|
||||
|
||||
`tcpflags`: `boolean` ::
|
||||
`tcpflags`: `<boolean>` ::
|
||||
|
||||
Filter illegal combinations of TCP flags.
|
||||
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
`-dest` `string` ::
|
||||
`-dest` `<string>` ::
|
||||
|
||||
Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.
|
||||
|
||||
`-dport` `string` ::
|
||||
`-dport` `<string>` ::
|
||||
|
||||
Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.
|
||||
|
||||
`-iface` `string` ::
|
||||
`-iface` `<string>` ::
|
||||
|
||||
Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.
|
||||
|
||||
`-proto` `string` ::
|
||||
`-proto` `<string>` ::
|
||||
|
||||
IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.
|
||||
|
||||
`-source` `string` ::
|
||||
`-source` `<string>` ::
|
||||
|
||||
Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.
|
||||
|
||||
`-sport` `string` ::
|
||||
`-sport` `<string>` ::
|
||||
|
||||
Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.
|
||||
|
||||
|
||||
@ -1,40 +1,40 @@
|
||||
`dhcp`: `boolean` ::
|
||||
`dhcp`: `<boolean>` ::
|
||||
|
||||
Enable DHCP.
|
||||
|
||||
`enable`: `boolean` ::
|
||||
`enable`: `<boolean>` ::
|
||||
|
||||
Enable/disable firewall rules.
|
||||
|
||||
`ipfilter`: `boolean` ::
|
||||
`ipfilter`: `<boolean>` ::
|
||||
|
||||
Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.
|
||||
|
||||
`log_level_in`: `(alert | crit | debug | emerg | err | info | nolog | notice | warning)` ::
|
||||
`log_level_in`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
|
||||
|
||||
Log level for incoming traffic.
|
||||
|
||||
`log_level_out`: `(alert | crit | debug | emerg | err | info | nolog | notice | warning)` ::
|
||||
`log_level_out`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
|
||||
|
||||
Log level for outgoing traffic.
|
||||
|
||||
`macfilter`: `boolean` ::
|
||||
`macfilter`: `<boolean>` ::
|
||||
|
||||
Enable/disable MAC address filter.
|
||||
|
||||
`ndp`: `boolean` ::
|
||||
`ndp`: `<boolean>` ::
|
||||
|
||||
Enable NDP.
|
||||
|
||||
`policy_in`: `(ACCEPT | DROP | REJECT)` ::
|
||||
`policy_in`: `<ACCEPT | DROP | REJECT>` ::
|
||||
|
||||
Input policy.
|
||||
|
||||
`policy_out`: `(ACCEPT | DROP | REJECT)` ::
|
||||
`policy_out`: `<ACCEPT | DROP | REJECT>` ::
|
||||
|
||||
Output policy.
|
||||
|
||||
`radv`: `boolean` ::
|
||||
`radv`: `<boolean>` ::
|
||||
|
||||
Allow sending Router Advertisement.
|
||||
|
||||
|
||||
@ -11,11 +11,11 @@ Compile and print firewall rules. This is useful for testing.
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -40,35 +40,35 @@ 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` ::
|
||||
`-dest` `<string>` ::
|
||||
|
||||
Destination IP address.
|
||||
|
||||
`-dport` `integer` ::
|
||||
`-dport` `<integer>` ::
|
||||
|
||||
Destination port.
|
||||
|
||||
`-from` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` (default=`outside`)::
|
||||
`-from` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `outside`)::
|
||||
|
||||
Source zone.
|
||||
|
||||
`-protocol` `(tcp|udp)` (default=`tcp`)::
|
||||
`-protocol` `(tcp|udp)` ('default =' `tcp`)::
|
||||
|
||||
Protocol.
|
||||
|
||||
`-source` `string` ::
|
||||
`-source` `<string>` ::
|
||||
|
||||
Source IP address.
|
||||
|
||||
`-sport` `integer` ::
|
||||
`-sport` `<integer>` ::
|
||||
|
||||
Source port.
|
||||
|
||||
`-to` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` (default=`host`)::
|
||||
`-to` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `host`)::
|
||||
|
||||
Destination zone.
|
||||
|
||||
`-verbose` `boolean` (default=`0`)::
|
||||
`-verbose` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Verbose output.
|
||||
|
||||
@ -78,7 +78,7 @@ Verbose output.
|
||||
|
||||
Start the Proxmox VE firewall service.
|
||||
|
||||
`-debug` `boolean` (default=`0`)::
|
||||
`-debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Debug mode - stay in foreground
|
||||
|
||||
|
||||
@ -4,11 +4,11 @@
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -19,7 +19,7 @@ Verbose output format.
|
||||
|
||||
Start the daemon.
|
||||
|
||||
`-debug` `boolean` (default=`0`)::
|
||||
`-debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Debug mode - stay in foreground
|
||||
|
||||
|
||||
@ -4,11 +4,11 @@
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -19,7 +19,7 @@ Verbose output format.
|
||||
|
||||
Start the daemon.
|
||||
|
||||
`-debug` `boolean` (default=`0`)::
|
||||
`-debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Debug mode - stay in foreground
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
List available templates.
|
||||
|
||||
`-section` `(system | turnkeylinux)` ::
|
||||
`-section` `<system | turnkeylinux>` ::
|
||||
|
||||
Restrict list to specified section.
|
||||
|
||||
@ -15,11 +15,11 @@ Restrict list to specified section.
|
||||
|
||||
Download appliance templates.
|
||||
|
||||
`<storage>` `string` ::
|
||||
`<storage>`: `<string>` ::
|
||||
|
||||
The storage where the template will be stored
|
||||
|
||||
`<template>` `string` ::
|
||||
`<template>`: `<string>` ::
|
||||
|
||||
The template wich will downloaded
|
||||
|
||||
@ -30,11 +30,11 @@ The template wich will downloaded
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -45,7 +45,7 @@ Verbose output format.
|
||||
|
||||
Get list of all templates on storage
|
||||
|
||||
`<storage>` `string` ::
|
||||
`<storage>`: `<string>` ::
|
||||
|
||||
Only list templates on specified storage
|
||||
|
||||
@ -55,7 +55,7 @@ Only list templates on specified storage
|
||||
|
||||
Remove a template.
|
||||
|
||||
`<template_path>` `string` ::
|
||||
`<template_path>`: `<string>` ::
|
||||
|
||||
The template to remove.
|
||||
|
||||
|
||||
@ -11,15 +11,15 @@ Create Ceph Monitor
|
||||
|
||||
Create OSD
|
||||
|
||||
`<dev>` `string` ::
|
||||
`<dev>`: `<string>` ::
|
||||
|
||||
Block device name.
|
||||
|
||||
`-fstype` `(btrfs | ext4 | xfs)` (default=`xfs`)::
|
||||
`-fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
|
||||
|
||||
File system type.
|
||||
|
||||
`-journal_dev` `string` ::
|
||||
`-journal_dev` `<string>` ::
|
||||
|
||||
Block device name for journal.
|
||||
|
||||
@ -30,23 +30,23 @@ Block device name for journal.
|
||||
|
||||
Create POOL
|
||||
|
||||
`<name>` `string` ::
|
||||
`<name>`: `<string>` ::
|
||||
|
||||
The name of the pool. It must be unique.
|
||||
|
||||
`-crush_ruleset` `integer (0 - 32768)` (default=`0`)::
|
||||
`-crush_ruleset` `<integer> (0 - 32768)` ('default =' `0`)::
|
||||
|
||||
The ruleset to use for mapping object placement in the cluster.
|
||||
|
||||
`-min_size` `integer (1 - 3)` (default=`1`)::
|
||||
`-min_size` `<integer> (1 - 3)` ('default =' `1`)::
|
||||
|
||||
Minimum number of replicas per object
|
||||
|
||||
`-pg_num` `integer (8 - 32768)` (default=`64`)::
|
||||
`-pg_num` `<integer> (8 - 32768)` ('default =' `64`)::
|
||||
|
||||
Number of placement groups.
|
||||
|
||||
`-size` `integer (1 - 3)` (default=`2`)::
|
||||
`-size` `<integer> (1 - 3)` ('default =' `2`)::
|
||||
|
||||
Number of replicas per object
|
||||
|
||||
@ -56,7 +56,7 @@ Number of replicas per object
|
||||
|
||||
Destroy Ceph monitor.
|
||||
|
||||
`<monid>` `integer` ::
|
||||
`<monid>`: `<integer>` ::
|
||||
|
||||
Monitor ID
|
||||
|
||||
@ -67,11 +67,11 @@ Monitor ID
|
||||
|
||||
Destroy OSD
|
||||
|
||||
`<osdid>` `integer` ::
|
||||
`<osdid>`: `<integer>` ::
|
||||
|
||||
OSD ID
|
||||
|
||||
`-cleanup` `boolean` (default=`0`)::
|
||||
`-cleanup` `<boolean>` ('default =' `0`)::
|
||||
|
||||
If set, we remove partition table entries.
|
||||
|
||||
@ -82,11 +82,11 @@ If set, we remove partition table entries.
|
||||
|
||||
Destroy pool
|
||||
|
||||
`<name>` `string` ::
|
||||
`<name>`: `<string>` ::
|
||||
|
||||
The name of the pool. It must be unique.
|
||||
|
||||
`-force` `boolean` (default=`0`)::
|
||||
`-force` `<boolean>` ('default =' `0`)::
|
||||
|
||||
If true, destroys pool even if in use
|
||||
|
||||
@ -97,11 +97,11 @@ If true, destroys pool even if in use
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -112,17 +112,17 @@ Verbose output format.
|
||||
|
||||
Create initial ceph default configuration and setup symlinks.
|
||||
|
||||
`-network` `string` ::
|
||||
`-network` `<string>` ::
|
||||
|
||||
Use specific network for all ceph related traffic
|
||||
|
||||
`-pg_bits` `integer (6 - 14)` (default=`6`)::
|
||||
`-pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
|
||||
|
||||
Placement group bits, used to specify the default number of placement groups.
|
||||
+
|
||||
NOTE: 'osd pool default pg num' does not work for default pools.
|
||||
|
||||
`-size` `integer (1 - 3)` (default=`2`)::
|
||||
`-size` `<integer> (1 - 3)` ('default =' `2`)::
|
||||
|
||||
Number of replicas per object
|
||||
|
||||
@ -133,7 +133,7 @@ Number of replicas per object
|
||||
|
||||
Install ceph related packages.
|
||||
|
||||
`-version` `(hammer)` ::
|
||||
`-version` `<hammer>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -158,7 +158,7 @@ Destroy ceph related data and configuration files.
|
||||
|
||||
Start ceph services.
|
||||
|
||||
`<service>` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
|
||||
`<service>`: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
|
||||
|
||||
Ceph service name.
|
||||
|
||||
@ -174,7 +174,7 @@ Get ceph status.
|
||||
|
||||
Stop ceph services.
|
||||
|
||||
`<service>` `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
|
||||
`<service>`: `(mon|mds|osd)\.[A-Za-z0-9]{1,32}` ::
|
||||
|
||||
Ceph service name.
|
||||
|
||||
|
||||
@ -4,27 +4,27 @@
|
||||
|
||||
Adds the current node to an existing cluster.
|
||||
|
||||
`<hostname>` `string` ::
|
||||
`<hostname>`: `<string>` ::
|
||||
|
||||
Hostname (or IP) of an existing cluster member.
|
||||
|
||||
`-force` `boolean` ::
|
||||
`-force` `<boolean>` ::
|
||||
|
||||
Do not throw error if node already exists.
|
||||
|
||||
`-nodeid` `integer (1 - N)` ::
|
||||
`-nodeid` `<integer> (1 - N)` ::
|
||||
|
||||
Node id for this node.
|
||||
|
||||
`-ring0_addr` `string` ::
|
||||
`-ring0_addr` `<string>` ::
|
||||
|
||||
Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
|
||||
|
||||
`-ring1_addr` `string` ::
|
||||
`-ring1_addr` `<string>` ::
|
||||
|
||||
Hostname (or IP) of the corosync ring1 address, this needs an valid configured ring 1 interface in the cluster.
|
||||
|
||||
`-votes` `integer (0 - N)` ::
|
||||
`-votes` `<integer> (0 - N)` ::
|
||||
|
||||
Number of votes for this node
|
||||
|
||||
@ -34,27 +34,27 @@ Number of votes for this node
|
||||
|
||||
Adds a node to the cluster configuration.
|
||||
|
||||
`<node>` `string` ::
|
||||
`<node>`: `<string>` ::
|
||||
|
||||
The cluster node name.
|
||||
|
||||
`-force` `boolean` ::
|
||||
`-force` `<boolean>` ::
|
||||
|
||||
Do not throw error if node already exists.
|
||||
|
||||
`-nodeid` `integer (1 - N)` ::
|
||||
`-nodeid` `<integer> (1 - N)` ::
|
||||
|
||||
Node id for this node.
|
||||
|
||||
`-ring0_addr` `string` ::
|
||||
`-ring0_addr` `<string>` ::
|
||||
|
||||
Hostname (or IP) of the corosync ring0 address of this node. Defaults to nodes hostname.
|
||||
|
||||
`-ring1_addr` `string` ::
|
||||
`-ring1_addr` `<string>` ::
|
||||
|
||||
Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.
|
||||
|
||||
`-votes` `integer (0 - N)` ::
|
||||
`-votes` `<integer> (0 - N)` ::
|
||||
|
||||
Number of votes for this node
|
||||
|
||||
@ -64,35 +64,35 @@ Number of votes for this node
|
||||
|
||||
Generate new cluster configuration.
|
||||
|
||||
`<clustername>` `string` ::
|
||||
`<clustername>`: `<string>` ::
|
||||
|
||||
The name of the cluster.
|
||||
|
||||
`-bindnet0_addr` `string` ::
|
||||
`-bindnet0_addr` `<string>` ::
|
||||
|
||||
This specifies the network address the corosync ring 0 executive should bind to and defaults to the local IP address of the node.
|
||||
|
||||
`-bindnet1_addr` `string` ::
|
||||
`-bindnet1_addr` `<string>` ::
|
||||
|
||||
This specifies the network address the corosync ring 1 executive should bind to and is optional.
|
||||
|
||||
`-nodeid` `integer (1 - N)` ::
|
||||
`-nodeid` `<integer> (1 - N)` ::
|
||||
|
||||
Node id for this node.
|
||||
|
||||
`-ring0_addr` `string` ::
|
||||
`-ring0_addr` `<string>` ::
|
||||
|
||||
Hostname (or IP) of the corosync ring0 address of this node. Defaults to the hostname of the node.
|
||||
|
||||
`-ring1_addr` `string` ::
|
||||
`-ring1_addr` `<string>` ::
|
||||
|
||||
Hostname (or IP) of the corosync ring1 address, this needs an valid bindnet1_addr.
|
||||
|
||||
`-rrp_mode` `(active | none | passive)` (default=`none`)::
|
||||
`-rrp_mode` `<active | none | passive>` ('default =' `none`)::
|
||||
|
||||
This specifies the mode of redundant ring, which may be none, active or passive. Using multiple interfaces only allows 'active' or 'passive'.
|
||||
|
||||
`-votes` `integer (1 - N)` ::
|
||||
`-votes` `<integer> (1 - N)` ::
|
||||
|
||||
Number of votes for this node.
|
||||
|
||||
@ -102,7 +102,7 @@ Number of votes for this node.
|
||||
|
||||
Removes a node to the cluster configuration.
|
||||
|
||||
`<node>` `string` ::
|
||||
`<node>`: `<string>` ::
|
||||
|
||||
Hostname or IP of the corosync ring0 address of this node.
|
||||
|
||||
@ -112,7 +112,7 @@ Hostname or IP of the corosync ring0 address of this node.
|
||||
|
||||
Tells corosync a new value of expected votes.
|
||||
|
||||
`<expected>` `integer (1 - N)` ::
|
||||
`<expected>`: `<integer> (1 - N)` ::
|
||||
|
||||
Expected votes
|
||||
|
||||
@ -123,11 +123,11 @@ Expected votes
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -138,7 +138,7 @@ Verbose output format.
|
||||
|
||||
Generate new cryptographic key for corosync.
|
||||
|
||||
`<filename>` `string` ::
|
||||
`<filename>`: `<string>` ::
|
||||
|
||||
Output file name
|
||||
|
||||
@ -148,11 +148,11 @@ Output file name
|
||||
|
||||
Used by VM/CT migration - do not use manually.
|
||||
|
||||
`-get_migration_ip` `boolean` (default=`0`)::
|
||||
`-get_migration_ip` `<boolean>` ('default =' `0`)::
|
||||
|
||||
return the migration IP, if configured
|
||||
|
||||
`-migration_network` `string` ::
|
||||
`-migration_network` `<string>` ::
|
||||
|
||||
the migration network used to detect the local migration IP
|
||||
|
||||
@ -174,11 +174,11 @@ Displays the local view of the cluster status.
|
||||
|
||||
Update node certificates (and generate all needed files/directories).
|
||||
|
||||
`-force` `boolean` ::
|
||||
`-force` `<boolean>` ::
|
||||
|
||||
Force generation of new SSL certifate.
|
||||
|
||||
`-silent` `boolean` ::
|
||||
`-silent` `<boolean>` ::
|
||||
|
||||
Ignore errors (i.e. when cluster has no quorum).
|
||||
|
||||
|
||||
@ -4,11 +4,11 @@
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -25,7 +25,7 @@ Restart the daemon (or start if not running).
|
||||
|
||||
Start the daemon.
|
||||
|
||||
`-debug` `boolean` (default=`0`)::
|
||||
`-debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Debug mode - stay in foreground
|
||||
|
||||
|
||||
@ -4,11 +4,11 @@
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -25,7 +25,7 @@ Restart the daemon (or start if not running).
|
||||
|
||||
Start the daemon.
|
||||
|
||||
`-debug` `boolean` (default=`0`)::
|
||||
`-debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Debug mode - stay in foreground
|
||||
|
||||
|
||||
@ -4,155 +4,155 @@
|
||||
|
||||
Create a new storage.
|
||||
|
||||
`<type>` `(dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool)` ::
|
||||
`<type>`: `<dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool>` ::
|
||||
|
||||
Storage type.
|
||||
|
||||
`<storage>` `string` ::
|
||||
`<storage>`: `<string>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
`-authsupported` `string` ::
|
||||
`-authsupported` `<string>` ::
|
||||
|
||||
Authsupported.
|
||||
|
||||
`-base` `string` ::
|
||||
`-base` `<string>` ::
|
||||
|
||||
Base volume. This volume is automatically activated.
|
||||
|
||||
`-blocksize` `string` ::
|
||||
`-blocksize` `<string>` ::
|
||||
|
||||
block size
|
||||
|
||||
`-comstar_hg` `string` ::
|
||||
`-comstar_hg` `<string>` ::
|
||||
|
||||
host group for comstar views
|
||||
|
||||
`-comstar_tg` `string` ::
|
||||
`-comstar_tg` `<string>` ::
|
||||
|
||||
target group for comstar views
|
||||
|
||||
`-content` `string` ::
|
||||
`-content` `<string>` ::
|
||||
|
||||
Allowed content types.
|
||||
+
|
||||
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
|
||||
|
||||
`-disable` `boolean` ::
|
||||
`-disable` `<boolean>` ::
|
||||
|
||||
Flag to disable the storage.
|
||||
|
||||
`-export` `string` ::
|
||||
`-export` `<string>` ::
|
||||
|
||||
NFS export path.
|
||||
|
||||
`-format` `string` ::
|
||||
`-format` `<string>` ::
|
||||
|
||||
Default image format.
|
||||
|
||||
`-is_mountpoint` `boolean` (default=`no`)::
|
||||
`-is_mountpoint` `<boolean>` ('default =' `no`)::
|
||||
|
||||
Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
|
||||
|
||||
`-iscsiprovider` `string` ::
|
||||
`-iscsiprovider` `<string>` ::
|
||||
|
||||
iscsi provider
|
||||
|
||||
`-krbd` `boolean` ::
|
||||
`-krbd` `<boolean>` ::
|
||||
|
||||
Access rbd through krbd kernel module.
|
||||
|
||||
`-maxfiles` `integer (0 - N)` ::
|
||||
`-maxfiles` `<integer> (0 - N)` ::
|
||||
|
||||
Maximal number of backup files per VM. Use '0' for unlimted.
|
||||
|
||||
`-mkdir` `boolean` (default=`yes`)::
|
||||
`-mkdir` `<boolean>` ('default =' `yes`)::
|
||||
|
||||
Create the directory if it doesn't exist.
|
||||
|
||||
`-monhost` `string` ::
|
||||
`-monhost` `<string>` ::
|
||||
|
||||
Monitors daemon ips.
|
||||
|
||||
`-nodes` `string` ::
|
||||
`-nodes` `<string>` ::
|
||||
|
||||
List of cluster node names.
|
||||
|
||||
`-nowritecache` `boolean` ::
|
||||
`-nowritecache` `<boolean>` ::
|
||||
|
||||
disable write caching on the target
|
||||
|
||||
`-options` `string` ::
|
||||
`-options` `<string>` ::
|
||||
|
||||
NFS mount options (see 'man nfs')
|
||||
|
||||
`-path` `string` ::
|
||||
`-path` `<string>` ::
|
||||
|
||||
File system path.
|
||||
|
||||
`-pool` `string` ::
|
||||
`-pool` `<string>` ::
|
||||
|
||||
Pool.
|
||||
|
||||
`-portal` `string` ::
|
||||
`-portal` `<string>` ::
|
||||
|
||||
iSCSI portal (IP or DNS name with optional port).
|
||||
|
||||
`-redundancy` `integer (1 - 16)` (default=`2`)::
|
||||
`-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` ::
|
||||
`-saferemove` `<boolean>` ::
|
||||
|
||||
Zero-out data when removing LVs.
|
||||
|
||||
`-saferemove_throughput` `string` ::
|
||||
`-saferemove_throughput` `<string>` ::
|
||||
|
||||
Wipe throughput (cstream -t parameter value).
|
||||
|
||||
`-server` `string` ::
|
||||
`-server` `<string>` ::
|
||||
|
||||
Server IP or DNS name.
|
||||
|
||||
`-server2` `string` ::
|
||||
`-server2` `<string>` ::
|
||||
|
||||
Backup volfile server IP or DNS name.
|
||||
+
|
||||
NOTE: Requires option(s): `server`
|
||||
|
||||
`-shared` `boolean` ::
|
||||
`-shared` `<boolean>` ::
|
||||
|
||||
Mark storage as shared.
|
||||
|
||||
`-sparse` `boolean` ::
|
||||
`-sparse` `<boolean>` ::
|
||||
|
||||
use sparse volumes
|
||||
|
||||
`-tagged_only` `boolean` ::
|
||||
`-tagged_only` `<boolean>` ::
|
||||
|
||||
Only use logical volumes tagged with 'pve-vm-ID'.
|
||||
|
||||
`-target` `string` ::
|
||||
`-target` `<string>` ::
|
||||
|
||||
iSCSI target.
|
||||
|
||||
`-thinpool` `string` ::
|
||||
`-thinpool` `<string>` ::
|
||||
|
||||
LVM thin pool LV name.
|
||||
|
||||
`-transport` `(rdma | tcp | unix)` ::
|
||||
`-transport` `<rdma | tcp | unix>` ::
|
||||
|
||||
Gluster transport: tcp or rdma
|
||||
|
||||
`-username` `string` ::
|
||||
`-username` `<string>` ::
|
||||
|
||||
RBD Id.
|
||||
|
||||
`-vgname` `string` ::
|
||||
`-vgname` `<string>` ::
|
||||
|
||||
Volume group name.
|
||||
|
||||
`-volume` `string` ::
|
||||
`-volume` `<string>` ::
|
||||
|
||||
Glusterfs Volume.
|
||||
|
||||
@ -163,23 +163,23 @@ Glusterfs Volume.
|
||||
|
||||
Allocate disk images.
|
||||
|
||||
`<storage>` `string` ::
|
||||
`<storage>`: `<string>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
Specify owner VM
|
||||
|
||||
`<filename>` `string` ::
|
||||
`<filename>`: `<string>` ::
|
||||
|
||||
The name of the file to create.
|
||||
|
||||
`<size>` `\d+[MG]?` ::
|
||||
`<size>`: `\d+[MG]?` ::
|
||||
|
||||
Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)
|
||||
|
||||
`-format` `(qcow2 | raw | subvol)` ::
|
||||
`-format` `<qcow2 | raw | subvol>` ::
|
||||
|
||||
no description available
|
||||
+
|
||||
@ -192,7 +192,7 @@ NOTE: Requires option(s): `size`
|
||||
|
||||
Extract configuration from vzdump backup archive.
|
||||
|
||||
`<volume>` `string` ::
|
||||
`<volume>`: `<string>` ::
|
||||
|
||||
Volume identifier
|
||||
|
||||
@ -203,11 +203,11 @@ Volume identifier
|
||||
|
||||
Delete volume
|
||||
|
||||
`<volume>` `string` ::
|
||||
`<volume>`: `<string>` ::
|
||||
|
||||
Volume identifier
|
||||
|
||||
`-storage` `string` ::
|
||||
`-storage` `<string>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -218,7 +218,7 @@ The storage identifier.
|
||||
|
||||
Scan remote GlusterFS server.
|
||||
|
||||
`<server>` `string` ::
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -229,11 +229,11 @@ no description available
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -244,7 +244,7 @@ Verbose output format.
|
||||
|
||||
Scan remote iSCSI server.
|
||||
|
||||
`-portal` `string` ::
|
||||
`-portal` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -255,15 +255,15 @@ no description available
|
||||
|
||||
List storage content.
|
||||
|
||||
`<storage>` `string` ::
|
||||
`<storage>`: `<string>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
`-content` `string` ::
|
||||
`-content` `<string>` ::
|
||||
|
||||
Only list content of this type.
|
||||
|
||||
`-vmid` `integer (1 - N)` ::
|
||||
`-vmid` `<integer> (1 - N)` ::
|
||||
|
||||
Only list images for this VM
|
||||
|
||||
@ -280,7 +280,7 @@ List local LVM volume groups.
|
||||
|
||||
List local LVM Thin Pools.
|
||||
|
||||
`<vg>` `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
|
||||
`<vg>`: `[a-zA-Z0-9\.\+\_][a-zA-Z0-9\.\+\_\-]+` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -290,7 +290,7 @@ no description available
|
||||
|
||||
Scan remote NFS server.
|
||||
|
||||
`<server>` `string` ::
|
||||
`<server>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -301,7 +301,7 @@ no description available
|
||||
|
||||
Get filesystem path for specified volume
|
||||
|
||||
`<volume>` `string` ::
|
||||
`<volume>`: `<string>` ::
|
||||
|
||||
Volume identifier
|
||||
|
||||
@ -312,7 +312,7 @@ Volume identifier
|
||||
|
||||
Delete storage configuration.
|
||||
|
||||
`<storage>` `string` ::
|
||||
`<storage>`: `<string>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
@ -322,115 +322,115 @@ The storage identifier.
|
||||
|
||||
Update storage configuration.
|
||||
|
||||
`<storage>` `string` ::
|
||||
`<storage>`: `<string>` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
`-blocksize` `string` ::
|
||||
`-blocksize` `<string>` ::
|
||||
|
||||
block size
|
||||
|
||||
`-comstar_hg` `string` ::
|
||||
`-comstar_hg` `<string>` ::
|
||||
|
||||
host group for comstar views
|
||||
|
||||
`-comstar_tg` `string` ::
|
||||
`-comstar_tg` `<string>` ::
|
||||
|
||||
target group for comstar views
|
||||
|
||||
`-content` `string` ::
|
||||
`-content` `<string>` ::
|
||||
|
||||
Allowed content types.
|
||||
+
|
||||
NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
|
||||
|
||||
`-delete` `string` ::
|
||||
`-delete` `<string>` ::
|
||||
|
||||
A list of settings you want to delete.
|
||||
|
||||
`-digest` `string` ::
|
||||
`-digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`-disable` `boolean` ::
|
||||
`-disable` `<boolean>` ::
|
||||
|
||||
Flag to disable the storage.
|
||||
|
||||
`-format` `string` ::
|
||||
`-format` `<string>` ::
|
||||
|
||||
Default image format.
|
||||
|
||||
`-is_mountpoint` `boolean` (default=`no`)::
|
||||
`-is_mountpoint` `<boolean>` ('default =' `no`)::
|
||||
|
||||
Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.
|
||||
|
||||
`-krbd` `boolean` ::
|
||||
`-krbd` `<boolean>` ::
|
||||
|
||||
Access rbd through krbd kernel module.
|
||||
|
||||
`-maxfiles` `integer (0 - N)` ::
|
||||
`-maxfiles` `<integer> (0 - N)` ::
|
||||
|
||||
Maximal number of backup files per VM. Use '0' for unlimted.
|
||||
|
||||
`-mkdir` `boolean` (default=`yes`)::
|
||||
`-mkdir` `<boolean>` ('default =' `yes`)::
|
||||
|
||||
Create the directory if it doesn't exist.
|
||||
|
||||
`-nodes` `string` ::
|
||||
`-nodes` `<string>` ::
|
||||
|
||||
List of cluster node names.
|
||||
|
||||
`-nowritecache` `boolean` ::
|
||||
`-nowritecache` `<boolean>` ::
|
||||
|
||||
disable write caching on the target
|
||||
|
||||
`-options` `string` ::
|
||||
`-options` `<string>` ::
|
||||
|
||||
NFS mount options (see 'man nfs')
|
||||
|
||||
`-pool` `string` ::
|
||||
`-pool` `<string>` ::
|
||||
|
||||
Pool.
|
||||
|
||||
`-redundancy` `integer (1 - 16)` (default=`2`)::
|
||||
`-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` ::
|
||||
`-saferemove` `<boolean>` ::
|
||||
|
||||
Zero-out data when removing LVs.
|
||||
|
||||
`-saferemove_throughput` `string` ::
|
||||
`-saferemove_throughput` `<string>` ::
|
||||
|
||||
Wipe throughput (cstream -t parameter value).
|
||||
|
||||
`-server` `string` ::
|
||||
`-server` `<string>` ::
|
||||
|
||||
Server IP or DNS name.
|
||||
|
||||
`-server2` `string` ::
|
||||
`-server2` `<string>` ::
|
||||
|
||||
Backup volfile server IP or DNS name.
|
||||
+
|
||||
NOTE: Requires option(s): `server`
|
||||
|
||||
`-shared` `boolean` ::
|
||||
`-shared` `<boolean>` ::
|
||||
|
||||
Mark storage as shared.
|
||||
|
||||
`-sparse` `boolean` ::
|
||||
`-sparse` `<boolean>` ::
|
||||
|
||||
use sparse volumes
|
||||
|
||||
`-tagged_only` `boolean` ::
|
||||
`-tagged_only` `<boolean>` ::
|
||||
|
||||
Only use logical volumes tagged with 'pve-vm-ID'.
|
||||
|
||||
`-transport` `(rdma | tcp | unix)` ::
|
||||
`-transport` `<rdma | tcp | unix>` ::
|
||||
|
||||
Gluster transport: tcp or rdma
|
||||
|
||||
`-username` `string` ::
|
||||
`-username` `<string>` ::
|
||||
|
||||
RBD Id.
|
||||
|
||||
@ -441,19 +441,19 @@ RBD Id.
|
||||
|
||||
Get status for all datastores.
|
||||
|
||||
`-content` `string` ::
|
||||
`-content` `<string>` ::
|
||||
|
||||
Only list stores which support this content type.
|
||||
|
||||
`-enabled` `boolean` (default=`0`)::
|
||||
`-enabled` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Only list stores which are enabled (not disabled in config).
|
||||
|
||||
`-storage` `string` ::
|
||||
`-storage` `<string>` ::
|
||||
|
||||
Only list status for specified storage
|
||||
|
||||
`-target` `string` ::
|
||||
`-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.
|
||||
|
||||
|
||||
@ -4,11 +4,11 @@
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -25,7 +25,7 @@ Restart the daemon (or start if not running).
|
||||
|
||||
Start the daemon.
|
||||
|
||||
`-debug` `boolean` (default=`0`)::
|
||||
`-debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Debug mode - stay in foreground
|
||||
|
||||
|
||||
@ -11,11 +11,11 @@ Read subscription info.
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -26,7 +26,7 @@ Verbose output format.
|
||||
|
||||
Set subscription key.
|
||||
|
||||
`<key>` `string` ::
|
||||
`<key>`: `<string>` ::
|
||||
|
||||
Proxmox VE subscription key
|
||||
|
||||
@ -36,7 +36,7 @@ Proxmox VE subscription key
|
||||
|
||||
Update subscription info.
|
||||
|
||||
`-force` `boolean` (default=`0`)::
|
||||
`-force` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Always connect to server, even if we have up to date info inside local cache.
|
||||
|
||||
|
||||
@ -4,23 +4,23 @@
|
||||
|
||||
Update Access Control List (add or remove permissions).
|
||||
|
||||
`<path>` `string` ::
|
||||
`<path>`: `<string>` ::
|
||||
|
||||
Access control path
|
||||
|
||||
`-groups` `string` ::
|
||||
`-groups` `<string>` ::
|
||||
|
||||
List of groups.
|
||||
|
||||
`-propagate` `boolean` (default=`1`)::
|
||||
`-propagate` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Allow to propagate (inherit) permissions.
|
||||
|
||||
`-roles` `string` ::
|
||||
`-roles` `<string>` ::
|
||||
|
||||
List of roles.
|
||||
|
||||
`-users` `string` ::
|
||||
`-users` `<string>` ::
|
||||
|
||||
List of users.
|
||||
|
||||
@ -30,23 +30,23 @@ List of users.
|
||||
|
||||
Update Access Control List (add or remove permissions).
|
||||
|
||||
`<path>` `string` ::
|
||||
`<path>`: `<string>` ::
|
||||
|
||||
Access control path
|
||||
|
||||
`-groups` `string` ::
|
||||
`-groups` `<string>` ::
|
||||
|
||||
List of groups.
|
||||
|
||||
`-propagate` `boolean` (default=`1`)::
|
||||
`-propagate` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Allow to propagate (inherit) permissions.
|
||||
|
||||
`-roles` `string` ::
|
||||
`-roles` `<string>` ::
|
||||
|
||||
List of roles.
|
||||
|
||||
`-users` `string` ::
|
||||
`-users` `<string>` ::
|
||||
|
||||
List of users.
|
||||
|
||||
@ -57,11 +57,11 @@ List of users.
|
||||
|
||||
Create new group.
|
||||
|
||||
`<groupid>` `string` ::
|
||||
`<groupid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-comment` `string` ::
|
||||
`-comment` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -71,7 +71,7 @@ no description available
|
||||
|
||||
Delete group.
|
||||
|
||||
`<groupid>` `string` ::
|
||||
`<groupid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -81,11 +81,11 @@ no description available
|
||||
|
||||
Update group data.
|
||||
|
||||
`<groupid>` `string` ::
|
||||
`<groupid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-comment` `string` ::
|
||||
`-comment` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -96,11 +96,11 @@ no description available
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -111,7 +111,7 @@ Verbose output format.
|
||||
|
||||
Change user password.
|
||||
|
||||
`<userid>` `string` ::
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
@ -122,11 +122,11 @@ User ID
|
||||
|
||||
Create new role.
|
||||
|
||||
`<roleid>` `string` ::
|
||||
`<roleid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-privs` `string` ::
|
||||
`-privs` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -136,7 +136,7 @@ no description available
|
||||
|
||||
Delete role.
|
||||
|
||||
`<roleid>` `string` ::
|
||||
`<roleid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -146,17 +146,17 @@ no description available
|
||||
|
||||
Create new role.
|
||||
|
||||
`<roleid>` `string` ::
|
||||
`<roleid>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-append` `boolean` ::
|
||||
`-append` `<boolean>` ::
|
||||
|
||||
no description available
|
||||
+
|
||||
NOTE: Requires option(s): `privs`
|
||||
|
||||
`-privs` `string` ::
|
||||
`-privs` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -167,27 +167,27 @@ no description available
|
||||
|
||||
Create or verify authentication ticket.
|
||||
|
||||
`<username>` `string` ::
|
||||
`<username>`: `<string>` ::
|
||||
|
||||
User name
|
||||
|
||||
`-otp` `string` ::
|
||||
`-otp` `<string>` ::
|
||||
|
||||
One-time password for Two-factor authentication.
|
||||
|
||||
`-path` `string` ::
|
||||
`-path` `<string>` ::
|
||||
|
||||
Verify ticket, and check if user have access 'privs' on 'path'
|
||||
+
|
||||
NOTE: Requires option(s): `privs`
|
||||
|
||||
`-privs` `string` ::
|
||||
`-privs` `<string>` ::
|
||||
|
||||
Verify ticket, and check if user have access 'privs' on 'path'
|
||||
+
|
||||
NOTE: Requires option(s): `path`
|
||||
|
||||
`-realm` `string` ::
|
||||
`-realm` `<string>` ::
|
||||
|
||||
You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.
|
||||
|
||||
@ -198,39 +198,39 @@ You can optionally pass the realm using this parameter. Normally the realm is si
|
||||
|
||||
Create new user.
|
||||
|
||||
`<userid>` `string` ::
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
`-comment` `string` ::
|
||||
`-comment` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-email` `string` ::
|
||||
`-email` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-enable` `boolean` (default=`1`)::
|
||||
`-enable` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Enable the account (default). You can set this to '0' to disable the accout
|
||||
|
||||
`-expire` `integer (0 - N)` ::
|
||||
`-expire` `<integer> (0 - N)` ::
|
||||
|
||||
Account expiration date (seconds since epoch). '0' means no expiration date.
|
||||
|
||||
`-firstname` `string` ::
|
||||
`-firstname` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-groups` `string` ::
|
||||
`-groups` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-keys` `string` ::
|
||||
`-keys` `<string>` ::
|
||||
|
||||
Keys for two factor auth (yubico).
|
||||
|
||||
`-lastname` `string` ::
|
||||
`-lastname` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
@ -244,7 +244,7 @@ Initial password.
|
||||
|
||||
Delete user.
|
||||
|
||||
`<userid>` `string` ::
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
@ -254,45 +254,45 @@ User ID
|
||||
|
||||
Update user configuration.
|
||||
|
||||
`<userid>` `string` ::
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
`-append` `boolean` ::
|
||||
`-append` `<boolean>` ::
|
||||
|
||||
no description available
|
||||
+
|
||||
NOTE: Requires option(s): `groups`
|
||||
|
||||
`-comment` `string` ::
|
||||
`-comment` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-email` `string` ::
|
||||
`-email` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-enable` `boolean` ::
|
||||
`-enable` `<boolean>` ::
|
||||
|
||||
Enable/disable the account.
|
||||
|
||||
`-expire` `integer (0 - N)` ::
|
||||
`-expire` `<integer> (0 - N)` ::
|
||||
|
||||
Account expiration date (seconds since epoch). '0' means no expiration date.
|
||||
|
||||
`-firstname` `string` ::
|
||||
`-firstname` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-groups` `string` ::
|
||||
`-groups` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-keys` `string` ::
|
||||
`-keys` `<string>` ::
|
||||
|
||||
Keys for two factor auth (yubico).
|
||||
|
||||
`-lastname` `string` ::
|
||||
`-lastname` `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,12 +1,12 @@
|
||||
`acpi`: `boolean` (default=`1`)::
|
||||
`acpi`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Enable/disable ACPI.
|
||||
|
||||
`agent`: `boolean` (default=`0`)::
|
||||
`agent`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Qemu GuestAgent.
|
||||
|
||||
`args`: `string` ::
|
||||
`args`: `<string>` ::
|
||||
|
||||
Arbitrary arguments passed to kvm, for example:
|
||||
+
|
||||
@ -14,19 +14,19 @@ args: -no-reboot -no-hpet
|
||||
+
|
||||
NOTE: this option is for experts only.
|
||||
|
||||
`autostart`: `boolean` (default=`0`)::
|
||||
`autostart`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Automatic restart after crash (currently ignored).
|
||||
|
||||
`balloon`: `integer (0 - N)` ::
|
||||
`balloon`: `<integer> (0 - N)` ::
|
||||
|
||||
Amount of target RAM for the VM in MB. Using zero disables the ballon driver.
|
||||
|
||||
`bios`: `(ovmf | seabios)` (default=`seabios`)::
|
||||
`bios`: `<ovmf | seabios>` ('default =' `seabios`)::
|
||||
|
||||
Select BIOS implementation.
|
||||
|
||||
`boot`: `[acdn]{1,4}` (default=`cdn`)::
|
||||
`boot`: `[acdn]{1,4}` ('default =' `cdn`)::
|
||||
|
||||
Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
|
||||
|
||||
@ -34,43 +34,43 @@ Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n).
|
||||
|
||||
Enable booting from specified disk.
|
||||
|
||||
`cdrom`: `volume` ::
|
||||
`cdrom`: `<volume>` ::
|
||||
|
||||
This is an alias for option -ide2
|
||||
|
||||
`cores`: `integer (1 - N)` (default=`1`)::
|
||||
`cores`: `<integer> (1 - N)` ('default =' `1`)::
|
||||
|
||||
The number of cores per socket.
|
||||
|
||||
`cpu`: `[cputype=]<cputype> [,hidden=<1|0>]` ::
|
||||
`cpu`: `[cputype=]<enum> [,hidden=<1|0>]` ::
|
||||
|
||||
Emulated CPU type.
|
||||
|
||||
`cputype`=`<cputype>` (default=`kvm64`);;
|
||||
`cputype`=`<486 | Broadwell | Broadwell-noTSX | Conroe | Haswell | Haswell-noTSX | 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.
|
||||
|
||||
`hidden`=`boolean` (default=`0`);;
|
||||
`hidden`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Do not identify as a KVM virtual machine.
|
||||
|
||||
`cpulimit`: `number (0 - 128)` (default=`0`)::
|
||||
`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`)::
|
||||
`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` ::
|
||||
`description`: `<string>` ::
|
||||
|
||||
Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
|
||||
|
||||
`efidisk0`: `[file=]<volume> [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,size=<DiskSize>]` ::
|
||||
`efidisk0`: `[file=]<volume> [,format=<enum>] [,size=<DiskSize>]` ::
|
||||
|
||||
Configure a Disk for storing EFI vars
|
||||
|
||||
@ -78,7 +78,7 @@ Configure a Disk for storing EFI vars
|
||||
|
||||
The drive's backing volume.
|
||||
|
||||
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
|
||||
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
|
||||
|
||||
The drive's backing file's data format.
|
||||
|
||||
@ -86,7 +86,7 @@ The drive's backing file's data format.
|
||||
|
||||
Disk size. This is purely informational and has no effect.
|
||||
|
||||
`freeze`: `boolean` ::
|
||||
`freeze`: `<boolean>` ::
|
||||
|
||||
Freeze CPU at startup (use 'c' monitor command to start execution).
|
||||
|
||||
@ -108,35 +108,35 @@ of PCI virtual functions of the host. HOSTPCIID syntax is:
|
||||
+
|
||||
You can us the 'lspci' command to list existing PCI devices.
|
||||
|
||||
`pcie`=`boolean` (default=`0`);;
|
||||
`pcie`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Choose the PCI-express bus (needs the 'q35' machine model).
|
||||
|
||||
`rombar`=`boolean` (default=`1`);;
|
||||
`rombar`=`<boolean>` ('default =' `1`);;
|
||||
|
||||
Specify whether or not the device's ROM will be visible in the guest's memory map.
|
||||
|
||||
`x-vga`=`boolean` (default=`0`);;
|
||||
`x-vga`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Enable vfio-vga device support.
|
||||
|
||||
`hotplug`: `string` (default=`network,disk,usb`)::
|
||||
`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'.
|
||||
|
||||
`hugepages`: `(1024 | 2 | any)` ::
|
||||
`hugepages`: `<1024 | 2 | any>` ::
|
||||
|
||||
Enable/disable hugepages memory.
|
||||
|
||||
`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
|
||||
`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
|
||||
|
||||
`aio`=`(native | threads)` ;;
|
||||
`aio`=`<native | threads>` ;;
|
||||
|
||||
AIO type to use.
|
||||
|
||||
`backup`=`boolean` ;;
|
||||
`backup`=`<boolean>` ;;
|
||||
|
||||
Whether the drive should be included when making backups.
|
||||
|
||||
@ -164,19 +164,19 @@ Maximum write speed in bytes per second.
|
||||
|
||||
Maximum length of write I/O bursts in seconds.
|
||||
|
||||
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
|
||||
`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
|
||||
|
||||
The drive's cache mode
|
||||
|
||||
`cyls`=`integer` ;;
|
||||
`cyls`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific cylinder count.
|
||||
|
||||
`detect_zeroes`=`boolean` ;;
|
||||
`detect_zeroes`=`<boolean>` ;;
|
||||
|
||||
Controls whether to detect and try to optimize writes of zeroes.
|
||||
|
||||
`discard`=`(ignore | on)` ;;
|
||||
`discard`=`<ignore | on>` ;;
|
||||
|
||||
Controls whether to pass discard/trim requests to the underlying storage.
|
||||
|
||||
@ -184,11 +184,11 @@ Controls whether to pass discard/trim requests to the underlying storage.
|
||||
|
||||
The drive's backing volume.
|
||||
|
||||
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
|
||||
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
|
||||
|
||||
The drive's backing file's data format.
|
||||
|
||||
`heads`=`integer` ;;
|
||||
`heads`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific head count.
|
||||
|
||||
@ -252,7 +252,7 @@ Maximum write speed in megabytes per second.
|
||||
|
||||
Maximum unthrottled write pool in megabytes per second.
|
||||
|
||||
`media`=`(cdrom | disk)` (default=`disk`);;
|
||||
`media`=`<cdrom | disk>` ('default =' `disk`);;
|
||||
|
||||
The drive's media type.
|
||||
|
||||
@ -260,11 +260,11 @@ The drive's media type.
|
||||
|
||||
The drive's reported model name, url-encoded, up to 40 bytes long.
|
||||
|
||||
`rerror`=`(ignore | report | stop)` ;;
|
||||
`rerror`=`<ignore | report | stop>` ;;
|
||||
|
||||
Read error action.
|
||||
|
||||
`secs`=`integer` ;;
|
||||
`secs`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific sector count.
|
||||
|
||||
@ -276,31 +276,31 @@ The drive's reported serial number, url-encoded, up to 20 bytes long.
|
||||
|
||||
Disk size. This is purely informational and has no effect.
|
||||
|
||||
`snapshot`=`boolean` ;;
|
||||
`snapshot`=`<boolean>` ;;
|
||||
|
||||
Whether the drive should be included when making snapshots.
|
||||
|
||||
`trans`=`(auto | lba | none)` ;;
|
||||
`trans`=`<auto | lba | none>` ;;
|
||||
|
||||
Force disk geometry bios translation mode.
|
||||
|
||||
`werror`=`(enospc | ignore | report | stop)` ;;
|
||||
`werror`=`<enospc | ignore | report | stop>` ;;
|
||||
|
||||
Write error action.
|
||||
|
||||
`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`)::
|
||||
`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 '/etc/pve/datacenter.conf' configuration file.
|
||||
|
||||
`kvm`: `boolean` (default=`1`)::
|
||||
`kvm`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Enable/disable KVM hardware virtualization.
|
||||
|
||||
`localtime`: `boolean` ::
|
||||
`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`: `<backup | migrate | rollback | snapshot>` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
@ -308,23 +308,23 @@ Lock/unlock the VM.
|
||||
|
||||
Specific the Qemu machine type.
|
||||
|
||||
`memory`: `integer (16 - N)` (default=`512`)::
|
||||
`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`)::
|
||||
`migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
|
||||
|
||||
Set maximum tolerated downtime (in seconds) for migrations.
|
||||
|
||||
`migrate_speed`: `integer (0 - N)` (default=`0`)::
|
||||
`migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
|
||||
|
||||
Set maximum speed (in MB/s) for migrations. Value 0 is no limit.
|
||||
|
||||
`name`: `string` ::
|
||||
`name`: `<string>` ::
|
||||
|
||||
Set a name for the VM. Only used on the configuration web interface.
|
||||
|
||||
`net[n]`: `[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
`net[n]`: `[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
|
||||
Specify network devices.
|
||||
|
||||
@ -343,11 +343,11 @@ are used:
|
||||
+
|
||||
The DHCP server assign addresses to the guest starting from 10.0.2.15.
|
||||
|
||||
`firewall`=`boolean` ;;
|
||||
`firewall`=`<boolean>` ;;
|
||||
|
||||
Whether this interface should be protected by the firewall.
|
||||
|
||||
`link_down`=`boolean` ;;
|
||||
`link_down`=`<boolean>` ;;
|
||||
|
||||
Whether this interface should be disconnected (like pulling the plug).
|
||||
|
||||
@ -355,19 +355,19 @@ Whether this interface should be disconnected (like pulling the plug).
|
||||
|
||||
MAC address. That address must be unique withing your network. This is automatically generated if not specified.
|
||||
|
||||
`model`=`<model>` ;;
|
||||
`model`=`<e1000 | e1000-82540em | e1000-82544gc | e1000-82545em | i82551 | i82557b | i82559er | ne2k_isa | ne2k_pci | pcnet | rtl8139 | virtio | vmxnet3>` ;;
|
||||
|
||||
Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.
|
||||
|
||||
`queues`=`integer (0 - 16)` ;;
|
||||
`queues`=`<integer> (0 - 16)` ;;
|
||||
|
||||
Number of packet queues to be used on the device.
|
||||
|
||||
`rate`=`number (0 - N)` ;;
|
||||
`rate`=`<number> (0 - N)` ;;
|
||||
|
||||
Rate limit in mbps (megabytes per second) as floating point number.
|
||||
|
||||
`tag`=`integer (1 - 4094)` ;;
|
||||
`tag`=`<integer> (1 - 4094)` ;;
|
||||
|
||||
VLAN tag to apply to packets on this interface.
|
||||
|
||||
@ -375,7 +375,7 @@ VLAN tag to apply to packets on this interface.
|
||||
|
||||
VLAN trunks to pass through this interface.
|
||||
|
||||
`numa`: `boolean` (default=`0`)::
|
||||
`numa`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable NUMA.
|
||||
|
||||
@ -391,19 +391,19 @@ CPUs accessing this NUMA node.
|
||||
|
||||
Host NUMA nodes to use.
|
||||
|
||||
`memory`=`number` ;;
|
||||
`memory`=`<number>` ;;
|
||||
|
||||
Amount of memory this NUMA node provides.
|
||||
|
||||
`policy`=`(bind | interleave | preferred)` ;;
|
||||
`policy`=`<bind | interleave | preferred>` ;;
|
||||
|
||||
NUMA allocation policy.
|
||||
|
||||
`onboot`: `boolean` (default=`0`)::
|
||||
`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)` ::
|
||||
`ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp>` ::
|
||||
|
||||
Specify guest operating system. This is used to enable special
|
||||
optimization/features for specific operating systems:
|
||||
@ -429,23 +429,23 @@ NOTE: This option allows direct access to host hardware. So it is no longer poss
|
||||
+
|
||||
CAUTION: Experimental! User reported problems with this option.
|
||||
|
||||
`protection`: `boolean` (default=`0`)::
|
||||
`protection`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.
|
||||
|
||||
`reboot`: `boolean` (default=`1`)::
|
||||
`reboot`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Allow reboot. If set to '0' the VM exit on reboot.
|
||||
|
||||
`sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
|
||||
`sata[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
Use volume as SATA hard disk or CD-ROM (n is 0 to 5).
|
||||
|
||||
`aio`=`(native | threads)` ;;
|
||||
`aio`=`<native | threads>` ;;
|
||||
|
||||
AIO type to use.
|
||||
|
||||
`backup`=`boolean` ;;
|
||||
`backup`=`<boolean>` ;;
|
||||
|
||||
Whether the drive should be included when making backups.
|
||||
|
||||
@ -473,19 +473,19 @@ Maximum write speed in bytes per second.
|
||||
|
||||
Maximum length of write I/O bursts in seconds.
|
||||
|
||||
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
|
||||
`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
|
||||
|
||||
The drive's cache mode
|
||||
|
||||
`cyls`=`integer` ;;
|
||||
`cyls`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific cylinder count.
|
||||
|
||||
`detect_zeroes`=`boolean` ;;
|
||||
`detect_zeroes`=`<boolean>` ;;
|
||||
|
||||
Controls whether to detect and try to optimize writes of zeroes.
|
||||
|
||||
`discard`=`(ignore | on)` ;;
|
||||
`discard`=`<ignore | on>` ;;
|
||||
|
||||
Controls whether to pass discard/trim requests to the underlying storage.
|
||||
|
||||
@ -493,11 +493,11 @@ Controls whether to pass discard/trim requests to the underlying storage.
|
||||
|
||||
The drive's backing volume.
|
||||
|
||||
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
|
||||
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
|
||||
|
||||
The drive's backing file's data format.
|
||||
|
||||
`heads`=`integer` ;;
|
||||
`heads`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific head count.
|
||||
|
||||
@ -561,15 +561,15 @@ Maximum write speed in megabytes per second.
|
||||
|
||||
Maximum unthrottled write pool in megabytes per second.
|
||||
|
||||
`media`=`(cdrom | disk)` (default=`disk`);;
|
||||
`media`=`<cdrom | disk>` ('default =' `disk`);;
|
||||
|
||||
The drive's media type.
|
||||
|
||||
`rerror`=`(ignore | report | stop)` ;;
|
||||
`rerror`=`<ignore | report | stop>` ;;
|
||||
|
||||
Read error action.
|
||||
|
||||
`secs`=`integer` ;;
|
||||
`secs`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific sector count.
|
||||
|
||||
@ -581,27 +581,27 @@ The drive's reported serial number, url-encoded, up to 20 bytes long.
|
||||
|
||||
Disk size. This is purely informational and has no effect.
|
||||
|
||||
`snapshot`=`boolean` ;;
|
||||
`snapshot`=`<boolean>` ;;
|
||||
|
||||
Whether the drive should be included when making snapshots.
|
||||
|
||||
`trans`=`(auto | lba | none)` ;;
|
||||
`trans`=`<auto | lba | none>` ;;
|
||||
|
||||
Force disk geometry bios translation mode.
|
||||
|
||||
`werror`=`(enospc | ignore | report | stop)` ;;
|
||||
`werror`=`<enospc | ignore | report | stop>` ;;
|
||||
|
||||
Write error action.
|
||||
|
||||
`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
|
||||
`scsi[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).
|
||||
|
||||
`aio`=`(native | threads)` ;;
|
||||
`aio`=`<native | threads>` ;;
|
||||
|
||||
AIO type to use.
|
||||
|
||||
`backup`=`boolean` ;;
|
||||
`backup`=`<boolean>` ;;
|
||||
|
||||
Whether the drive should be included when making backups.
|
||||
|
||||
@ -629,19 +629,19 @@ Maximum write speed in bytes per second.
|
||||
|
||||
Maximum length of write I/O bursts in seconds.
|
||||
|
||||
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
|
||||
`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
|
||||
|
||||
The drive's cache mode
|
||||
|
||||
`cyls`=`integer` ;;
|
||||
`cyls`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific cylinder count.
|
||||
|
||||
`detect_zeroes`=`boolean` ;;
|
||||
`detect_zeroes`=`<boolean>` ;;
|
||||
|
||||
Controls whether to detect and try to optimize writes of zeroes.
|
||||
|
||||
`discard`=`(ignore | on)` ;;
|
||||
`discard`=`<ignore | on>` ;;
|
||||
|
||||
Controls whether to pass discard/trim requests to the underlying storage.
|
||||
|
||||
@ -649,11 +649,11 @@ Controls whether to pass discard/trim requests to the underlying storage.
|
||||
|
||||
The drive's backing volume.
|
||||
|
||||
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
|
||||
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
|
||||
|
||||
The drive's backing file's data format.
|
||||
|
||||
`heads`=`integer` ;;
|
||||
`heads`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific head count.
|
||||
|
||||
@ -693,7 +693,7 @@ Maximum length of write I/O bursts in seconds.
|
||||
|
||||
Maximum unthrottled write I/O pool in operations per second.
|
||||
|
||||
`iothread`=`boolean` ;;
|
||||
`iothread`=`<boolean>` ;;
|
||||
|
||||
Whether to use iothreads for this drive
|
||||
|
||||
@ -721,15 +721,15 @@ Maximum write speed in megabytes per second.
|
||||
|
||||
Maximum unthrottled write pool in megabytes per second.
|
||||
|
||||
`media`=`(cdrom | disk)` (default=`disk`);;
|
||||
`media`=`<cdrom | disk>` ('default =' `disk`);;
|
||||
|
||||
The drive's media type.
|
||||
|
||||
`queues`=`integer (2 - N)` ;;
|
||||
`queues`=`<integer> (2 - N)` ;;
|
||||
|
||||
Number of queues.
|
||||
|
||||
`secs`=`integer` ;;
|
||||
`secs`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific sector count.
|
||||
|
||||
@ -741,19 +741,19 @@ The drive's reported serial number, url-encoded, up to 20 bytes long.
|
||||
|
||||
Disk size. This is purely informational and has no effect.
|
||||
|
||||
`snapshot`=`boolean` ;;
|
||||
`snapshot`=`<boolean>` ;;
|
||||
|
||||
Whether the drive should be included when making snapshots.
|
||||
|
||||
`trans`=`(auto | lba | none)` ;;
|
||||
`trans`=`<auto | lba | none>` ;;
|
||||
|
||||
Force disk geometry bios translation mode.
|
||||
|
||||
`werror`=`(enospc | ignore | report | stop)` ;;
|
||||
`werror`=`<enospc | ignore | report | stop>` ;;
|
||||
|
||||
Write error action.
|
||||
|
||||
`scsihw`: `(lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single)` (default=`lsi`)::
|
||||
`scsihw`: `<lsi | lsi53c810 | megasas | pvscsi | virtio-scsi-pci | virtio-scsi-single>` ('default =' `lsi`)::
|
||||
|
||||
SCSI controller model
|
||||
|
||||
@ -767,7 +767,7 @@ NOTE: If you pass through a host serial device, it is no longer possible to migr
|
||||
+
|
||||
CAUTION: Experimental! User reported problems with this option.
|
||||
|
||||
`shares`: `integer (0 - 50000)` (default=`1000`)::
|
||||
`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
|
||||
|
||||
@ -803,15 +803,15 @@ Set SMBIOS1 UUID.
|
||||
|
||||
Set SMBIOS1 version.
|
||||
|
||||
`smp`: `integer (1 - N)` (default=`1`)::
|
||||
`smp`: `<integer> (1 - N)` ('default =' `1`)::
|
||||
|
||||
The number of CPUs. Please use option -sockets instead.
|
||||
|
||||
`sockets`: `integer (1 - N)` (default=`1`)::
|
||||
`sockets`: `<integer> (1 - N)` ('default =' `1`)::
|
||||
|
||||
The number of CPU sockets.
|
||||
|
||||
`startdate`: `(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)` (default=`now`)::
|
||||
`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'.
|
||||
|
||||
@ -819,19 +819,19 @@ Set the initial date of the real time clock. Valid format for date are: 'now' or
|
||||
|
||||
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`)::
|
||||
`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 off by default if you use spice (-vga=qxl).
|
||||
|
||||
`tdf`: `boolean` (default=`0`)::
|
||||
`tdf`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable time drift fix.
|
||||
|
||||
`template`: `boolean` (default=`0`)::
|
||||
`template`: `<boolean>` ('default =' `0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`unused[n]`: `string` ::
|
||||
`unused[n]`: `<string>` ::
|
||||
|
||||
Reference to unused volumes. This is used internally, and should not be modified manually.
|
||||
|
||||
@ -853,27 +853,27 @@ NOTE: This option allows direct access to host hardware. So it is no longer poss
|
||||
+
|
||||
The value 'spice' can be used to add a usb redirection devices for spice.
|
||||
|
||||
`usb3`=`boolean` (default=`0`);;
|
||||
`usb3`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).
|
||||
|
||||
`vcpus`: `integer (1 - N)` (default=`0`)::
|
||||
`vcpus`: `<integer> (1 - N)` ('default =' `0`)::
|
||||
|
||||
Number of hotplugged vcpus.
|
||||
|
||||
`vga`: `(cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware)` ::
|
||||
`vga`: `<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | vmware>` ::
|
||||
|
||||
Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.
|
||||
|
||||
`virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<raw|cow|qcow|qed|qcow2|vmdk|cloop>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]` ::
|
||||
`virtio[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_length=<seconds>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_length=<seconds>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
Use volume as VIRTIO hard disk (n is 0 to 15).
|
||||
|
||||
`aio`=`(native | threads)` ;;
|
||||
`aio`=`<native | threads>` ;;
|
||||
|
||||
AIO type to use.
|
||||
|
||||
`backup`=`boolean` ;;
|
||||
`backup`=`<boolean>` ;;
|
||||
|
||||
Whether the drive should be included when making backups.
|
||||
|
||||
@ -901,19 +901,19 @@ Maximum write speed in bytes per second.
|
||||
|
||||
Maximum length of write I/O bursts in seconds.
|
||||
|
||||
`cache`=`(directsync | none | unsafe | writeback | writethrough)` ;;
|
||||
`cache`=`<directsync | none | unsafe | writeback | writethrough>` ;;
|
||||
|
||||
The drive's cache mode
|
||||
|
||||
`cyls`=`integer` ;;
|
||||
`cyls`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific cylinder count.
|
||||
|
||||
`detect_zeroes`=`boolean` ;;
|
||||
`detect_zeroes`=`<boolean>` ;;
|
||||
|
||||
Controls whether to detect and try to optimize writes of zeroes.
|
||||
|
||||
`discard`=`(ignore | on)` ;;
|
||||
`discard`=`<ignore | on>` ;;
|
||||
|
||||
Controls whether to pass discard/trim requests to the underlying storage.
|
||||
|
||||
@ -921,11 +921,11 @@ Controls whether to pass discard/trim requests to the underlying storage.
|
||||
|
||||
The drive's backing volume.
|
||||
|
||||
`format`=`(cloop | cow | qcow | qcow2 | qed | raw | vmdk)` ;;
|
||||
`format`=`<cloop | cow | qcow | qcow2 | qed | raw | vmdk>` ;;
|
||||
|
||||
The drive's backing file's data format.
|
||||
|
||||
`heads`=`integer` ;;
|
||||
`heads`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific head count.
|
||||
|
||||
@ -965,7 +965,7 @@ Maximum length of write I/O bursts in seconds.
|
||||
|
||||
Maximum unthrottled write I/O pool in operations per second.
|
||||
|
||||
`iothread`=`boolean` ;;
|
||||
`iothread`=`<boolean>` ;;
|
||||
|
||||
Whether to use iothreads for this drive
|
||||
|
||||
@ -993,15 +993,15 @@ Maximum write speed in megabytes per second.
|
||||
|
||||
Maximum unthrottled write pool in megabytes per second.
|
||||
|
||||
`media`=`(cdrom | disk)` (default=`disk`);;
|
||||
`media`=`<cdrom | disk>` ('default =' `disk`);;
|
||||
|
||||
The drive's media type.
|
||||
|
||||
`rerror`=`(ignore | report | stop)` ;;
|
||||
`rerror`=`<ignore | report | stop>` ;;
|
||||
|
||||
Read error action.
|
||||
|
||||
`secs`=`integer` ;;
|
||||
`secs`=`<integer>` ;;
|
||||
|
||||
Force the drive's physical geometry to have a specific sector count.
|
||||
|
||||
@ -1013,27 +1013,27 @@ The drive's reported serial number, url-encoded, up to 20 bytes long.
|
||||
|
||||
Disk size. This is purely informational and has no effect.
|
||||
|
||||
`snapshot`=`boolean` ;;
|
||||
`snapshot`=`<boolean>` ;;
|
||||
|
||||
Whether the drive should be included when making snapshots.
|
||||
|
||||
`trans`=`(auto | lba | none)` ;;
|
||||
`trans`=`<auto | lba | none>` ;;
|
||||
|
||||
Force disk geometry bios translation mode.
|
||||
|
||||
`werror`=`(enospc | ignore | report | stop)` ;;
|
||||
`werror`=`<enospc | ignore | report | stop>` ;;
|
||||
|
||||
Write error action.
|
||||
|
||||
`watchdog`: `[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]` ::
|
||||
`watchdog`: `[[model=]<i6300esb|ib700>] [,action=<enum>]` ::
|
||||
|
||||
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 watchdog will reset the guest (or execute the respective action specified)
|
||||
|
||||
`action`=`(debug | none | pause | poweroff | reset | shutdown)` ;;
|
||||
`action`=`<debug | none | pause | poweroff | reset | shutdown>` ;;
|
||||
|
||||
The action to perform if after activation the guest fails to poll the watchdog in time.
|
||||
|
||||
`model`=`(i6300esb | ib700)` (default=`i6300esb`);;
|
||||
`model`=`<i6300esb | ib700>` ('default =' `i6300esb`);;
|
||||
|
||||
Watchdog type to emulate.
|
||||
|
||||
|
||||
@ -4,27 +4,27 @@
|
||||
|
||||
Restore QemuServer vzdump backups.
|
||||
|
||||
`<archive>` `string` ::
|
||||
`<archive>`: `<string>` ::
|
||||
|
||||
The backup file. You can pass '-' to read from standard input.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
`<vmid>`: `<integer> (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-force` `boolean` ::
|
||||
`-force` `<boolean>` ::
|
||||
|
||||
Allow to overwrite existing VM.
|
||||
|
||||
`-pool` `string` ::
|
||||
`-pool` `<string>` ::
|
||||
|
||||
Add the VM to the specified pool.
|
||||
|
||||
`-storage` `string` ::
|
||||
`-storage` `<string>` ::
|
||||
|
||||
Default storage.
|
||||
|
||||
`-unique` `boolean` ::
|
||||
`-unique` `<boolean>` ::
|
||||
|
||||
Assign a unique random ethernet address.
|
||||
|
||||
|
||||
@ -4,11 +4,11 @@
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
`<cmd>`: `<string>` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
`-verbose` `<boolean>` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
@ -25,7 +25,7 @@ Restart the daemon (or start if not running).
|
||||
|
||||
Start the daemon.
|
||||
|
||||
`-debug` `boolean` (default=`0`)::
|
||||
`-debug` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Debug mode - stay in foreground
|
||||
|
||||
|
||||
@ -4,103 +4,103 @@
|
||||
|
||||
Create backup.
|
||||
|
||||
`<vmid>` `string` ::
|
||||
`<vmid>`: `<string>` ::
|
||||
|
||||
The ID of the guest system you want to backup.
|
||||
|
||||
`-all` `boolean` (default=`0`)::
|
||||
`-all` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Backup all known guest systems on this host.
|
||||
|
||||
`-bwlimit` `integer (0 - N)` (default=`0`)::
|
||||
`-bwlimit` `<integer> (0 - N)` ('default =' `0`)::
|
||||
|
||||
Limit I/O bandwidth (KBytes per second).
|
||||
|
||||
`-compress` `(0 | 1 | gzip | lzo)` (default=`0`)::
|
||||
`-compress` `<0 | 1 | gzip | lzo>` ('default =' `0`)::
|
||||
|
||||
Compress dump file.
|
||||
|
||||
`-dumpdir` `string` ::
|
||||
`-dumpdir` `<string>` ::
|
||||
|
||||
Store resulting files to specified directory.
|
||||
|
||||
`-exclude` `string` ::
|
||||
`-exclude` `<string>` ::
|
||||
|
||||
Exclude specified guest systems (assumes --all)
|
||||
|
||||
`-exclude-path` `string` ::
|
||||
`-exclude-path` `<string>` ::
|
||||
|
||||
Exclude certain files/directories (shell globs).
|
||||
|
||||
`-ionice` `integer (0 - 8)` (default=`7`)::
|
||||
`-ionice` `<integer> (0 - 8)` ('default =' `7`)::
|
||||
|
||||
Set CFQ ionice priority.
|
||||
|
||||
`-lockwait` `integer (0 - N)` (default=`180`)::
|
||||
`-lockwait` `<integer> (0 - N)` ('default =' `180`)::
|
||||
|
||||
Maximal time to wait for the global lock (minutes).
|
||||
|
||||
`-mailnotification` `(always | failure)` (default=`always`)::
|
||||
`-mailnotification` `<always | failure>` ('default =' `always`)::
|
||||
|
||||
Specify when to send an email
|
||||
|
||||
`-mailto` `string` ::
|
||||
`-mailto` `<string>` ::
|
||||
|
||||
Comma-separated list of email addresses that should receive email notifications.
|
||||
|
||||
`-maxfiles` `integer (1 - N)` (default=`1`)::
|
||||
`-maxfiles` `<integer> (1 - N)` ('default =' `1`)::
|
||||
|
||||
Maximal number of backup files per guest system.
|
||||
|
||||
`-mode` `(snapshot | stop | suspend)` (default=`snapshot`)::
|
||||
`-mode` `<snapshot | stop | suspend>` ('default =' `snapshot`)::
|
||||
|
||||
Backup mode.
|
||||
|
||||
`-node` `string` ::
|
||||
`-node` `<string>` ::
|
||||
|
||||
Only run if executed on this node.
|
||||
|
||||
`-pigz` `integer` (default=`0`)::
|
||||
`-pigz` `<integer>` ('default =' `0`)::
|
||||
|
||||
Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
|
||||
|
||||
`-quiet` `boolean` (default=`0`)::
|
||||
`-quiet` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Be quiet.
|
||||
|
||||
`-remove` `boolean` (default=`1`)::
|
||||
`-remove` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Remove old backup files if there are more than 'maxfiles' backup files.
|
||||
|
||||
`-script` `string` ::
|
||||
`-script` `<string>` ::
|
||||
|
||||
Use specified hook script.
|
||||
|
||||
`-size` `integer (500 - N)` (default=`1024`)::
|
||||
`-size` `<integer> (500 - N)` ('default =' `1024`)::
|
||||
|
||||
Unused, will be removed in a future release.
|
||||
|
||||
`-stdexcludes` `boolean` (default=`1`)::
|
||||
`-stdexcludes` `<boolean>` ('default =' `1`)::
|
||||
|
||||
Exclude temporary files and logs.
|
||||
|
||||
`-stdout` `boolean` ::
|
||||
`-stdout` `<boolean>` ::
|
||||
|
||||
Write tar to stdout, not to a file.
|
||||
|
||||
`-stop` `boolean` (default=`0`)::
|
||||
`-stop` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Stop runnig backup jobs on this host.
|
||||
|
||||
`-stopwait` `integer (0 - N)` (default=`10`)::
|
||||
`-stopwait` `<integer> (0 - N)` ('default =' `10`)::
|
||||
|
||||
Maximal time to wait until a guest system is stopped (minutes).
|
||||
|
||||
`-storage` `string` ::
|
||||
`-storage` `<string>` ::
|
||||
|
||||
Store resulting file to this storage.
|
||||
|
||||
`-tmpdir` `string` ::
|
||||
`-tmpdir` `<string>` ::
|
||||
|
||||
Store temporary files to specified directory.
|
||||
|
||||
|
||||
@ -1,68 +1,68 @@
|
||||
`bwlimit`: `integer (0 - N)` (default=`0`)::
|
||||
`bwlimit`: `<integer> (0 - N)` ('default =' `0`)::
|
||||
|
||||
Limit I/O bandwidth (KBytes per second).
|
||||
|
||||
`compress`: `(0 | 1 | gzip | lzo)` (default=`0`)::
|
||||
`compress`: `<0 | 1 | gzip | lzo>` ('default =' `0`)::
|
||||
|
||||
Compress dump file.
|
||||
|
||||
`dumpdir`: `string` ::
|
||||
`dumpdir`: `<string>` ::
|
||||
|
||||
Store resulting files to specified directory.
|
||||
|
||||
`exclude-path`: `string` ::
|
||||
`exclude-path`: `<string>` ::
|
||||
|
||||
Exclude certain files/directories (shell globs).
|
||||
|
||||
`ionice`: `integer (0 - 8)` (default=`7`)::
|
||||
`ionice`: `<integer> (0 - 8)` ('default =' `7`)::
|
||||
|
||||
Set CFQ ionice priority.
|
||||
|
||||
`lockwait`: `integer (0 - N)` (default=`180`)::
|
||||
`lockwait`: `<integer> (0 - N)` ('default =' `180`)::
|
||||
|
||||
Maximal time to wait for the global lock (minutes).
|
||||
|
||||
`mailnotification`: `(always | failure)` (default=`always`)::
|
||||
`mailnotification`: `<always | failure>` ('default =' `always`)::
|
||||
|
||||
Specify when to send an email
|
||||
|
||||
`mailto`: `string` ::
|
||||
`mailto`: `<string>` ::
|
||||
|
||||
Comma-separated list of email addresses that should receive email notifications.
|
||||
|
||||
`maxfiles`: `integer (1 - N)` (default=`1`)::
|
||||
`maxfiles`: `<integer> (1 - N)` ('default =' `1`)::
|
||||
|
||||
Maximal number of backup files per guest system.
|
||||
|
||||
`mode`: `(snapshot | stop | suspend)` (default=`snapshot`)::
|
||||
`mode`: `<snapshot | stop | suspend>` ('default =' `snapshot`)::
|
||||
|
||||
Backup mode.
|
||||
|
||||
`pigz`: `integer` (default=`0`)::
|
||||
`pigz`: `<integer>` ('default =' `0`)::
|
||||
|
||||
Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.
|
||||
|
||||
`remove`: `boolean` (default=`1`)::
|
||||
`remove`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Remove old backup files if there are more than 'maxfiles' backup files.
|
||||
|
||||
`script`: `string` ::
|
||||
`script`: `<string>` ::
|
||||
|
||||
Use specified hook script.
|
||||
|
||||
`stdexcludes`: `boolean` (default=`1`)::
|
||||
`stdexcludes`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Exclude temporary files and logs.
|
||||
|
||||
`stopwait`: `integer (0 - N)` (default=`10`)::
|
||||
`stopwait`: `<integer> (0 - N)` ('default =' `10`)::
|
||||
|
||||
Maximal time to wait until a guest system is stopped (minutes).
|
||||
|
||||
`storage`: `string` ::
|
||||
`storage`: `<string>` ::
|
||||
|
||||
Store resulting file to this storage.
|
||||
|
||||
`tmpdir`: `string` ::
|
||||
`tmpdir`: `<string>` ::
|
||||
|
||||
Store temporary files to specified directory.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user