mirror of
git://git.proxmox.com/git/pve-docs.git
synced 2025-01-07 17:17:48 +03:00
add generated -synopsis.adoc files
This commit is contained in:
Dietmar Maurer
parent
50eba620b4
commit
1f554f760e
708
pct.1-synopsis.adoc
Normal file
708
pct.1-synopsis.adoc
Normal file
@ -0,0 +1,708 @@
|
||||
*pct* `<COMMAND> [ARGS] [OPTIONS]`
|
||||
|
||||
*pct config* `<vmid>`
|
||||
|
||||
Get container configuration.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct console* `<vmid>`
|
||||
|
||||
Launch a console for the specified container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct create* `<vmid> <ostemplate>` `[OPTIONS]`
|
||||
|
||||
Create or restore a container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<ostemplate>` `string` ::
|
||||
|
||||
The OS template or backup file.
|
||||
|
||||
`-arch` `(amd64 | i386)` (default=`amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
`-cmode` `(console | shell | tty)` (default=`tty`)::
|
||||
|
||||
Console mode. By default, the console command tries to open a connection to
|
||||
one of the available tty devices. By setting cmode to 'console' it tries to
|
||||
attach to /dev/console instead. If you set cmode to 'shell', it simply
|
||||
invokes a shell inside the container (no login).
|
||||
|
||||
`-console` `boolean` (default=`1`)::
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`-cpulimit` `number (0 - 128)` (default=`0`)::
|
||||
|
||||
Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
|
||||
CPU time. Value '0' indicates no CPU limit.
|
||||
|
||||
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
|
||||
|
||||
CPU weight for a VM. Argument is used in the kernel fair scheduler. The
|
||||
larger the number is, the more CPU time this VM gets. Number is relative to
|
||||
weights of all the other running VMs.
|
||||
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`-description` `string` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`-force` `boolean` ::
|
||||
|
||||
Allow to overwrite existing container.
|
||||
|
||||
`-hostname` `string` ::
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`-ignore-unpack-errors` `boolean` ::
|
||||
|
||||
Ignore errors when extracting the template.
|
||||
|
||||
`-lock` `(backup | migrate | rollback | snapshot)` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`-memory` `integer (16 - N)` (default=`512`)::
|
||||
|
||||
Amount of RAM for the VM in MB.
|
||||
|
||||
`-mp[n]` `[volume=]<volume> [,backup=<[1|0]>] [,mp=<Path>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container mount point (experimental feature).
|
||||
|
||||
`-nameserver` `string` ::
|
||||
|
||||
Sets DNS server IP address for a container. Create will automatically use
|
||||
the setting from the host if you neither set searchdomain or nameserver.
|
||||
|
||||
`-net[n]` `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,tag=<VlanNo>]` ::
|
||||
|
||||
Specifies network interfaces for the container.
|
||||
|
||||
`-onboot` `boolean` (default=`0`)::
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` ::
|
||||
|
||||
OS type. Corresponds to lxc setup scripts in
|
||||
/usr/share/lxc/config/<ostype>.common.conf.
|
||||
|
||||
`-password` `string` ::
|
||||
|
||||
Sets root password inside container.
|
||||
|
||||
`-pool` `string` ::
|
||||
|
||||
Add the VM to the specified pool.
|
||||
|
||||
`-protection` `boolean` (default=`0`)::
|
||||
|
||||
Sets the protection flag of the container. This will prevent the remove
|
||||
operation. This will prevent the CT or CT's disk remove/update operation.
|
||||
|
||||
`-restore` `boolean` ::
|
||||
|
||||
Mark this as restore task.
|
||||
|
||||
`-rootfs` `[volume=]<volume> [,backup=<[1|0]>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container root.
|
||||
|
||||
`-searchdomain` `string` ::
|
||||
|
||||
Sets DNS search domains for a container. Create will automatically use the
|
||||
setting from the host if you neither set searchdomain or nameserver.
|
||||
|
||||
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
|
||||
|
||||
Startup and shutdown behavior. Order is a non-negative number defining the
|
||||
general startup order. Shutdown in done with reverse ordering. Additionally
|
||||
you can set the 'up' or 'down' delay in seconds, which specifies a delay to
|
||||
wait before the next VM is started or stopped.
|
||||
|
||||
`-storage` `string` (default=`local`)::
|
||||
|
||||
Default Storage.
|
||||
|
||||
`-swap` `integer (0 - N)` (default=`512`)::
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`-template` `boolean` (default=`0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`-tty` `integer (0 - 6)` (default=`2`)::
|
||||
|
||||
Specify the number of tty available to the container
|
||||
|
||||
`-unprivileged` `boolean` (default=`0`)::
|
||||
|
||||
Makes the container run as unprivileged user. (Should not be modified
|
||||
manually.)
|
||||
|
||||
`-unused[n]` `string` ::
|
||||
|
||||
Reference to unused volumes.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct delsnapshot* `<vmid> <snapname>` `[OPTIONS]`
|
||||
|
||||
Delete a LXC snapshot.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<snapname>` `string` ::
|
||||
|
||||
The name of the snapshot.
|
||||
|
||||
`-force` `boolean` ::
|
||||
|
||||
For removal from config file, even if removing disk snapshots fails.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct destroy* `<vmid>`
|
||||
|
||||
Destroy the container (also delete all uses files).
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct enter* `<vmid>`
|
||||
|
||||
Launch a shell for the specified container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
*pct exec* `<vmid> [<extra-args>]`
|
||||
|
||||
Launch a command inside the specified container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<extra-args>` `array` ::
|
||||
|
||||
Extra arguments as array
|
||||
|
||||
|
||||
|
||||
*pct fsck* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Run a filesystem check (fsck) on a container volume.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-device` `(mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs)` ::
|
||||
|
||||
A volume on which to run the filesystem check
|
||||
|
||||
`-force` `boolean` (default=`0`)::
|
||||
|
||||
Force checking, even if the filesystem seems clean
|
||||
|
||||
|
||||
|
||||
|
||||
*pct help* `[<cmd>]` `[OPTIONS]`
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct list*
|
||||
|
||||
LXC container index (per node).
|
||||
|
||||
|
||||
|
||||
|
||||
*pct listsnapshot* `<vmid>`
|
||||
|
||||
List all snapshots.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct migrate* `<vmid> <target>` `[OPTIONS]`
|
||||
|
||||
Migrate the container to another node. Creates a new migration task.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<target>` `string` ::
|
||||
|
||||
Target node.
|
||||
|
||||
`-online` `boolean` ::
|
||||
|
||||
Use online/live migration.
|
||||
|
||||
|
||||
|
||||
*pct resize* `<vmid> <disk> <size>` `[OPTIONS]`
|
||||
|
||||
Resize a container mountpoint.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<disk>` `(mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs)` ::
|
||||
|
||||
The disk you want to resize.
|
||||
|
||||
`<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` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest.
|
||||
This can be used to prevent concurrent modifications.
|
||||
|
||||
|
||||
|
||||
*pct restore* `<vmid> <ostemplate>` `[OPTIONS]`
|
||||
|
||||
Create or restore a container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<ostemplate>` `string` ::
|
||||
|
||||
The OS template or backup file.
|
||||
|
||||
`-arch` `(amd64 | i386)` (default=`amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
`-cmode` `(console | shell | tty)` (default=`tty`)::
|
||||
|
||||
Console mode. By default, the console command tries to open a connection to
|
||||
one of the available tty devices. By setting cmode to 'console' it tries to
|
||||
attach to /dev/console instead. If you set cmode to 'shell', it simply
|
||||
invokes a shell inside the container (no login).
|
||||
|
||||
`-console` `boolean` (default=`1`)::
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`-cpulimit` `number (0 - 128)` (default=`0`)::
|
||||
|
||||
Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
|
||||
CPU time. Value '0' indicates no CPU limit.
|
||||
|
||||
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
|
||||
|
||||
CPU weight for a VM. Argument is used in the kernel fair scheduler. The
|
||||
larger the number is, the more CPU time this VM gets. Number is relative to
|
||||
weights of all the other running VMs.
|
||||
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`-description` `string` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`-force` `boolean` ::
|
||||
|
||||
Allow to overwrite existing container.
|
||||
|
||||
`-hostname` `string` ::
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`-ignore-unpack-errors` `boolean` ::
|
||||
|
||||
Ignore errors when extracting the template.
|
||||
|
||||
`-lock` `(backup | migrate | rollback | snapshot)` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`-memory` `integer (16 - N)` (default=`512`)::
|
||||
|
||||
Amount of RAM for the VM in MB.
|
||||
|
||||
`-mp[n]` `[volume=]<volume> [,backup=<[1|0]>] [,mp=<Path>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container mount point (experimental feature).
|
||||
|
||||
`-nameserver` `string` ::
|
||||
|
||||
Sets DNS server IP address for a container. Create will automatically use
|
||||
the setting from the host if you neither set searchdomain or nameserver.
|
||||
|
||||
`-net[n]` `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,tag=<VlanNo>]` ::
|
||||
|
||||
Specifies network interfaces for the container.
|
||||
|
||||
`-onboot` `boolean` (default=`0`)::
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` ::
|
||||
|
||||
OS type. Corresponds to lxc setup scripts in
|
||||
/usr/share/lxc/config/<ostype>.common.conf.
|
||||
|
||||
`-password` `string` ::
|
||||
|
||||
Sets root password inside container.
|
||||
|
||||
`-pool` `string` ::
|
||||
|
||||
Add the VM to the specified pool.
|
||||
|
||||
`-protection` `boolean` (default=`0`)::
|
||||
|
||||
Sets the protection flag of the container. This will prevent the remove
|
||||
operation. This will prevent the CT or CT's disk remove/update operation.
|
||||
|
||||
`-rootfs` `[volume=]<volume> [,backup=<[1|0]>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container root.
|
||||
|
||||
`-searchdomain` `string` ::
|
||||
|
||||
Sets DNS search domains for a container. Create will automatically use the
|
||||
setting from the host if you neither set searchdomain or nameserver.
|
||||
|
||||
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
|
||||
|
||||
Startup and shutdown behavior. Order is a non-negative number defining the
|
||||
general startup order. Shutdown in done with reverse ordering. Additionally
|
||||
you can set the 'up' or 'down' delay in seconds, which specifies a delay to
|
||||
wait before the next VM is started or stopped.
|
||||
|
||||
`-storage` `string` (default=`local`)::
|
||||
|
||||
Default Storage.
|
||||
|
||||
`-swap` `integer (0 - N)` (default=`512`)::
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`-template` `boolean` (default=`0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`-tty` `integer (0 - 6)` (default=`2`)::
|
||||
|
||||
Specify the number of tty available to the container
|
||||
|
||||
`-unprivileged` `boolean` (default=`0`)::
|
||||
|
||||
Makes the container run as unprivileged user. (Should not be modified
|
||||
manually.)
|
||||
|
||||
`-unused[n]` `string` ::
|
||||
|
||||
Reference to unused volumes.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct resume* `<vmid>`
|
||||
|
||||
Resume the container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct rollback* `<vmid> <snapname>`
|
||||
|
||||
Rollback LXC state to specified snapshot.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<snapname>` `string` ::
|
||||
|
||||
The name of the snapshot.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct set* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Set container options.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-arch` `(amd64 | i386)` (default=`amd64`)::
|
||||
|
||||
OS architecture type.
|
||||
|
||||
`-cmode` `(console | shell | tty)` (default=`tty`)::
|
||||
|
||||
Console mode. By default, the console command tries to open a connection to
|
||||
one of the available tty devices. By setting cmode to 'console' it tries to
|
||||
attach to /dev/console instead. If you set cmode to 'shell', it simply
|
||||
invokes a shell inside the container (no login).
|
||||
|
||||
`-console` `boolean` (default=`1`)::
|
||||
|
||||
Attach a console device (/dev/console) to the container.
|
||||
|
||||
`-cpulimit` `number (0 - 128)` (default=`0`)::
|
||||
|
||||
Limit of CPU usage. Note if the computer has 2 CPUs, it has total of '2'
|
||||
CPU time. Value '0' indicates no CPU limit.
|
||||
|
||||
`-cpuunits` `integer (0 - 500000)` (default=`1024`)::
|
||||
|
||||
CPU weight for a VM. Argument is used in the kernel fair scheduler. The
|
||||
larger the number is, the more CPU time this VM gets. Number is relative to
|
||||
weights of all the other running VMs.
|
||||
|
||||
NOTE: You can disable fair-scheduler configuration by setting this to 0.
|
||||
|
||||
`-delete` `string` ::
|
||||
|
||||
A list of settings you want to delete.
|
||||
|
||||
`-description` `string` ::
|
||||
|
||||
Container description. Only used on the configuration web interface.
|
||||
|
||||
`-digest` `string` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest.
|
||||
This can be used to prevent concurrent modifications.
|
||||
|
||||
`-hostname` `string` ::
|
||||
|
||||
Set a host name for the container.
|
||||
|
||||
`-lock` `(backup | migrate | rollback | snapshot)` ::
|
||||
|
||||
Lock/unlock the VM.
|
||||
|
||||
`-memory` `integer (16 - N)` (default=`512`)::
|
||||
|
||||
Amount of RAM for the VM in MB.
|
||||
|
||||
`-mp[n]` `[volume=]<volume> [,backup=<[1|0]>] [,mp=<Path>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container mount point (experimental feature).
|
||||
|
||||
`-nameserver` `string` ::
|
||||
|
||||
Sets DNS server IP address for a container. Create will automatically use
|
||||
the setting from the host if you neither set searchdomain or nameserver.
|
||||
|
||||
`-net[n]` `name=<String> [,bridge=<vmbr<Number>>] [,firewall=<[1|0]>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<MAC>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<Number>] [,tag=<VlanNo>]` ::
|
||||
|
||||
Specifies network interfaces for the container.
|
||||
|
||||
`-onboot` `boolean` (default=`0`)::
|
||||
|
||||
Specifies whether a VM will be started during system bootup.
|
||||
|
||||
`-ostype` `(archlinux | centos | debian | fedora | opensuse | ubuntu)` ::
|
||||
|
||||
OS type. Corresponds to lxc setup scripts in
|
||||
/usr/share/lxc/config/<ostype>.common.conf.
|
||||
|
||||
`-protection` `boolean` (default=`0`)::
|
||||
|
||||
Sets the protection flag of the container. This will prevent the remove
|
||||
operation. This will prevent the CT or CT's disk remove/update operation.
|
||||
|
||||
`-rootfs` `[volume=]<volume> [,backup=<[1|0]>] [,size=<DiskSize>]` ::
|
||||
|
||||
Use volume as container root.
|
||||
|
||||
`-searchdomain` `string` ::
|
||||
|
||||
Sets DNS search domains for a container. Create will automatically use the
|
||||
setting from the host if you neither set searchdomain or nameserver.
|
||||
|
||||
`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
|
||||
|
||||
Startup and shutdown behavior. Order is a non-negative number defining the
|
||||
general startup order. Shutdown in done with reverse ordering. Additionally
|
||||
you can set the 'up' or 'down' delay in seconds, which specifies a delay to
|
||||
wait before the next VM is started or stopped.
|
||||
|
||||
`-swap` `integer (0 - N)` (default=`512`)::
|
||||
|
||||
Amount of SWAP for the VM in MB.
|
||||
|
||||
`-template` `boolean` (default=`0`)::
|
||||
|
||||
Enable/disable Template.
|
||||
|
||||
`-tty` `integer (0 - 6)` (default=`2`)::
|
||||
|
||||
Specify the number of tty available to the container
|
||||
|
||||
`-unprivileged` `boolean` (default=`0`)::
|
||||
|
||||
Makes the container run as unprivileged user. (Should not be modified
|
||||
manually.)
|
||||
|
||||
`-unused[n]` `string` ::
|
||||
|
||||
Reference to unused volumes.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct shutdown* `<vmid>` `[OPTIONS]`
|
||||
|
||||
Shutdown the container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`-forceStop` `boolean` (default=`0`)::
|
||||
|
||||
Make sure the Container stops.
|
||||
|
||||
`-timeout` `integer (0 - N)` (default=`60`)::
|
||||
|
||||
Wait maximal timeout seconds.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct snapshot* `<vmid> <snapname>` `[OPTIONS]`
|
||||
|
||||
Snapshot a container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
`<snapname>` `string` ::
|
||||
|
||||
The name of the snapshot.
|
||||
|
||||
`-description` `string` ::
|
||||
|
||||
A textual description or comment.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct start* `<vmid>`
|
||||
|
||||
Start the container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
*pct stop* `<vmid>`
|
||||
|
||||
Stop the container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
*pct suspend* `<vmid>`
|
||||
|
||||
Suspend the container.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct template* `<vmid>`
|
||||
|
||||
Create a Template.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
|
||||
*pct unlock* `<vmid>`
|
||||
|
||||
Unlock the VM.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
The (unique) ID of the VM.
|
||||
|
||||
|
||||
|
||||
|
||||
100
pve-firewall.8-synopsis.adoc
Normal file
100
pve-firewall.8-synopsis.adoc
Normal file
@ -0,0 +1,100 @@
|
||||
*pve-firewall* `<COMMAND> [ARGS] [OPTIONS]`
|
||||
|
||||
*pve-firewall compile*
|
||||
|
||||
Compile and print firewall rules. This is useful for testing.
|
||||
|
||||
|
||||
|
||||
|
||||
*pve-firewall help* `[<cmd>]` `[OPTIONS]`
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
|
||||
|
||||
|
||||
*pve-firewall localnet*
|
||||
|
||||
Print information about local network.
|
||||
|
||||
|
||||
|
||||
*pve-firewall restart*
|
||||
|
||||
Restart the Proxmox VE firewall service.
|
||||
|
||||
|
||||
|
||||
*pve-firewall simulate* `[OPTIONS]`
|
||||
|
||||
Simulate firewall rules. This does not simulate kernel 'routing' table.
|
||||
Instead, this simply assumes that routing from source zone to destination
|
||||
zone is possible.
|
||||
|
||||
`-dest` `string` ::
|
||||
|
||||
Destination IP address.
|
||||
|
||||
`-dport` `integer` ::
|
||||
|
||||
Destination port.
|
||||
|
||||
`-from` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` (default=`outside`)::
|
||||
|
||||
Source zone.
|
||||
|
||||
`-protocol` `(tcp|udp)` (default=`tcp`)::
|
||||
|
||||
Protocol.
|
||||
|
||||
`-source` `string` ::
|
||||
|
||||
Source IP address.
|
||||
|
||||
`-sport` `integer` ::
|
||||
|
||||
Source port.
|
||||
|
||||
`-to` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` (default=`host`)::
|
||||
|
||||
Destination zone.
|
||||
|
||||
`-verbose` `boolean` (default=`0`)::
|
||||
|
||||
Verbose output.
|
||||
|
||||
|
||||
|
||||
*pve-firewall start* `[OPTIONS]`
|
||||
|
||||
Start the Proxmox VE firewall service.
|
||||
|
||||
`-debug` `boolean` (default=`0`)::
|
||||
|
||||
Debug mode - stay in foreground
|
||||
|
||||
|
||||
|
||||
*pve-firewall status*
|
||||
|
||||
Get firewall status.
|
||||
|
||||
|
||||
|
||||
*pve-firewall stop*
|
||||
|
||||
Stop firewall. This removes all Proxmox VE related iptable rules. The host
|
||||
is unprotected afterwards.
|
||||
|
||||
|
||||
|
||||
|
||||
428
pvesm.1-synopsis.adoc
Normal file
428
pvesm.1-synopsis.adoc
Normal file
@ -0,0 +1,428 @@
|
||||
*pvesm* `<COMMAND> [ARGS] [OPTIONS]`
|
||||
|
||||
*pvesm add* `<type> <storage>` `[OPTIONS]`
|
||||
|
||||
Create a new storage.
|
||||
|
||||
`<type>` `(dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | sheepdog | zfs | zfspool)` ::
|
||||
|
||||
Storage type.
|
||||
|
||||
`<storage>` `string` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
`-authsupported` `string` ::
|
||||
|
||||
Authsupported.
|
||||
|
||||
`-base` `string` ::
|
||||
|
||||
Base volume. This volume is automatically activated.
|
||||
|
||||
`-blocksize` `string` ::
|
||||
|
||||
block size
|
||||
|
||||
`-comstar_hg` `string` ::
|
||||
|
||||
host group for comstar views
|
||||
|
||||
`-comstar_tg` `string` ::
|
||||
|
||||
target group for comstar views
|
||||
|
||||
`-content` `string` ::
|
||||
|
||||
Allowed content types. Note: value 'rootdir' is used for Containers, and
|
||||
value 'images' for KVM-Qemu VM's.
|
||||
|
||||
`-disable` `boolean` ::
|
||||
|
||||
Flag to disable the storage.
|
||||
|
||||
`-export` `string` ::
|
||||
|
||||
NFS export path.
|
||||
|
||||
`-format` `string` ::
|
||||
|
||||
Default Image format.
|
||||
|
||||
`-iscsiprovider` `string` ::
|
||||
|
||||
iscsi provider
|
||||
|
||||
`-krbd` `boolean` ::
|
||||
|
||||
Access rbd through krbd kernel module.
|
||||
|
||||
`-maxfiles` `integer (0 - N)` ::
|
||||
|
||||
Maximal number of backup files per VM. Use '0' for unlimted.
|
||||
|
||||
`-monhost` `string` ::
|
||||
|
||||
Monitors daemon ips.
|
||||
|
||||
`-nodes` `string` ::
|
||||
|
||||
List of cluster node names.
|
||||
|
||||
`-nowritecache` `boolean` ::
|
||||
|
||||
disable write caching on the target
|
||||
|
||||
`-options` `string` ::
|
||||
|
||||
NFS mount options (see 'man nfs')
|
||||
|
||||
`-path` `string` ::
|
||||
|
||||
File system path.
|
||||
|
||||
`-pool` `string` ::
|
||||
|
||||
Pool.
|
||||
|
||||
`-portal` `string` ::
|
||||
|
||||
iSCSI portal (IP or DNS name with optional port).
|
||||
|
||||
`-redundancy` `integer (1 - 16)` (default=`2`)::
|
||||
|
||||
The redundancy count specifies the number of nodes to which the resource
|
||||
should be deployed. It must be at least 1 and at most the number of nodes
|
||||
in the cluster.
|
||||
|
||||
`-saferemove` `boolean` ::
|
||||
|
||||
Zero-out data when removing LVs.
|
||||
|
||||
`-saferemove_throughput` `string` ::
|
||||
|
||||
Wipe throughput (cstream -t parameter value).
|
||||
|
||||
`-server` `string` ::
|
||||
|
||||
Server IP or DNS name.
|
||||
|
||||
`-server[n]` `string` ::
|
||||
|
||||
Backup volfile server IP or DNS name.
|
||||
+
|
||||
NOTE: Requires option(s): `server`
|
||||
|
||||
`-shared` `boolean` ::
|
||||
|
||||
Mark storage as shared.
|
||||
|
||||
`-sparse` `boolean` ::
|
||||
|
||||
use sparse volumes
|
||||
|
||||
`-target` `string` ::
|
||||
|
||||
iSCSI target.
|
||||
|
||||
`-thinpool` `string` ::
|
||||
|
||||
LVM thin pool LV name.
|
||||
|
||||
`-transport` `(rdma | tcp | unix)` ::
|
||||
|
||||
Gluster transport: tcp or rdma
|
||||
|
||||
`-username` `string` ::
|
||||
|
||||
RBD Id.
|
||||
|
||||
`-vgname` `string` ::
|
||||
|
||||
Volume group name.
|
||||
|
||||
`-volume` `string` ::
|
||||
|
||||
Glusterfs Volume.
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm alloc* `<storage> <vmid> <filename> <size>` `[OPTIONS]`
|
||||
|
||||
Allocate disk images.
|
||||
|
||||
`<storage>` `string` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
`<vmid>` `integer (1 - N)` ::
|
||||
|
||||
Specify owner VM
|
||||
|
||||
`<filename>` `string` ::
|
||||
|
||||
The name of the file to create.
|
||||
|
||||
`<size>` `\d+[MG]?` ::
|
||||
|
||||
Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and
|
||||
'G' (gigabyte, 1024M)
|
||||
|
||||
`-format` `(qcow2 | raw | subvol)` ::
|
||||
|
||||
no description available
|
||||
+
|
||||
NOTE: Requires option(s): `size`
|
||||
|
||||
|
||||
|
||||
*pvesm free* `<volume>` `[OPTIONS]`
|
||||
|
||||
Delete volume
|
||||
|
||||
`<volume>` `string` ::
|
||||
|
||||
Volume identifier
|
||||
|
||||
`-storage` `string` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm glusterfsscan* `<server>`
|
||||
|
||||
Scan remote GlusterFS server.
|
||||
|
||||
`<server>` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm help* `[<cmd>]` `[OPTIONS]`
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm iscsiscan* `-portal <string>` `[OPTIONS]`
|
||||
|
||||
Scan remote iSCSI server.
|
||||
|
||||
`-portal` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm list* `<storage>` `[OPTIONS]`
|
||||
|
||||
List storage content.
|
||||
|
||||
`<storage>` `string` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
`-content` `string` ::
|
||||
|
||||
Only list content of this type.
|
||||
|
||||
`-vmid` `integer (1 - N)` ::
|
||||
|
||||
Only list images for this VM
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm lvmscan*
|
||||
|
||||
List local LVM volume groups.
|
||||
|
||||
|
||||
|
||||
*pvesm nfsscan* `<server>`
|
||||
|
||||
Scan remote NFS server.
|
||||
|
||||
`<server>` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm path* `<volume>`
|
||||
|
||||
Get filesystem path for specified volume
|
||||
|
||||
`<volume>` `string` ::
|
||||
|
||||
Volume identifier
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm remove* `<storage>`
|
||||
|
||||
Delete storage configuration.
|
||||
|
||||
`<storage>` `string` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
|
||||
|
||||
*pvesm set* `<storage>` `[OPTIONS]`
|
||||
|
||||
Update storage configuration.
|
||||
|
||||
`<storage>` `string` ::
|
||||
|
||||
The storage identifier.
|
||||
|
||||
`-blocksize` `string` ::
|
||||
|
||||
block size
|
||||
|
||||
`-comstar_hg` `string` ::
|
||||
|
||||
host group for comstar views
|
||||
|
||||
`-comstar_tg` `string` ::
|
||||
|
||||
target group for comstar views
|
||||
|
||||
`-content` `string` ::
|
||||
|
||||
Allowed content types. Note: value 'rootdir' is used for Containers, and
|
||||
value 'images' for KVM-Qemu VM's.
|
||||
|
||||
`-delete` `string` ::
|
||||
|
||||
A list of settings you want to delete.
|
||||
|
||||
`-digest` `string` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest.
|
||||
This can be used to prevent concurrent modifications.
|
||||
|
||||
`-disable` `boolean` ::
|
||||
|
||||
Flag to disable the storage.
|
||||
|
||||
`-format` `string` ::
|
||||
|
||||
Default Image format.
|
||||
|
||||
`-krbd` `boolean` ::
|
||||
|
||||
Access rbd through krbd kernel module.
|
||||
|
||||
`-maxfiles` `integer (0 - N)` ::
|
||||
|
||||
Maximal number of backup files per VM. Use '0' for unlimted.
|
||||
|
||||
`-nodes` `string` ::
|
||||
|
||||
List of cluster node names.
|
||||
|
||||
`-nowritecache` `boolean` ::
|
||||
|
||||
disable write caching on the target
|
||||
|
||||
`-options` `string` ::
|
||||
|
||||
NFS mount options (see 'man nfs')
|
||||
|
||||
`-pool` `string` ::
|
||||
|
||||
Pool.
|
||||
|
||||
`-redundancy` `integer (1 - 16)` (default=`2`)::
|
||||
|
||||
The redundancy count specifies the number of nodes to which the resource
|
||||
should be deployed. It must be at least 1 and at most the number of nodes
|
||||
in the cluster.
|
||||
|
||||
`-saferemove` `boolean` ::
|
||||
|
||||
Zero-out data when removing LVs.
|
||||
|
||||
`-saferemove_throughput` `string` ::
|
||||
|
||||
Wipe throughput (cstream -t parameter value).
|
||||
|
||||
`-server` `string` ::
|
||||
|
||||
Server IP or DNS name.
|
||||
|
||||
`-server[n]` `string` ::
|
||||
|
||||
Backup volfile server IP or DNS name.
|
||||
+
|
||||
NOTE: Requires option(s): `server`
|
||||
|
||||
`-shared` `boolean` ::
|
||||
|
||||
Mark storage as shared.
|
||||
|
||||
`-sparse` `boolean` ::
|
||||
|
||||
use sparse volumes
|
||||
|
||||
`-transport` `(rdma | tcp | unix)` ::
|
||||
|
||||
Gluster transport: tcp or rdma
|
||||
|
||||
`-username` `string` ::
|
||||
|
||||
RBD Id.
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm status* `[OPTIONS]`
|
||||
|
||||
Get status for all datastores.
|
||||
|
||||
`-content` `string` ::
|
||||
|
||||
Only list stores which support this content type.
|
||||
|
||||
`-enabled` `boolean` (default=`0`)::
|
||||
|
||||
Only list stores which are enabled (not disabled in config).
|
||||
|
||||
`-storage` `string` ::
|
||||
|
||||
Only list status for specified storage
|
||||
|
||||
`-target` `string` ::
|
||||
|
||||
If target is different to 'node', we only lists shared storages which
|
||||
content is accessible on this 'node' and the specified 'target' node.
|
||||
|
||||
|
||||
|
||||
|
||||
*pvesm zfsscan*
|
||||
|
||||
Scan zfs pool list on local node.
|
||||
|
||||
|
||||
|
||||
|
||||
304
pveum.1-synopsis.adoc
Normal file
304
pveum.1-synopsis.adoc
Normal file
@ -0,0 +1,304 @@
|
||||
*pveum* `<COMMAND> [ARGS] [OPTIONS]`
|
||||
|
||||
*pveum acldel* `<path> -roles <string>` `[OPTIONS]`
|
||||
|
||||
Update Access Control List (add or remove permissions).
|
||||
|
||||
`<path>` `string` ::
|
||||
|
||||
Access control path
|
||||
|
||||
`-groups` `string` ::
|
||||
|
||||
List of groups.
|
||||
|
||||
`-propagate` `boolean` (default=`1`)::
|
||||
|
||||
Allow to propagate (inherit) permissions.
|
||||
|
||||
`-roles` `string` ::
|
||||
|
||||
List of roles.
|
||||
|
||||
`-users` `string` ::
|
||||
|
||||
List of users.
|
||||
|
||||
|
||||
|
||||
*pveum aclmod* `<path> -roles <string>` `[OPTIONS]`
|
||||
|
||||
Update Access Control List (add or remove permissions).
|
||||
|
||||
`<path>` `string` ::
|
||||
|
||||
Access control path
|
||||
|
||||
`-groups` `string` ::
|
||||
|
||||
List of groups.
|
||||
|
||||
`-propagate` `boolean` (default=`1`)::
|
||||
|
||||
Allow to propagate (inherit) permissions.
|
||||
|
||||
`-roles` `string` ::
|
||||
|
||||
List of roles.
|
||||
|
||||
`-users` `string` ::
|
||||
|
||||
List of users.
|
||||
|
||||
|
||||
|
||||
|
||||
*pveum groupadd* `<groupid>` `[OPTIONS]`
|
||||
|
||||
Create new group.
|
||||
|
||||
`<groupid>` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-comment` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
*pveum groupdel* `<groupid>`
|
||||
|
||||
Delete group.
|
||||
|
||||
`<groupid>` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
*pveum groupmod* `<groupid>` `[OPTIONS]`
|
||||
|
||||
Update group data.
|
||||
|
||||
`<groupid>` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-comment` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
|
||||
*pveum help* `[<cmd>]` `[OPTIONS]`
|
||||
|
||||
Get help about specified command.
|
||||
|
||||
`<cmd>` `string` ::
|
||||
|
||||
Command name
|
||||
|
||||
`-verbose` `boolean` ::
|
||||
|
||||
Verbose output format.
|
||||
|
||||
|
||||
|
||||
|
||||
*pveum passwd* `<userid>`
|
||||
|
||||
Change user password.
|
||||
|
||||
`<userid>` `string` ::
|
||||
|
||||
User ID
|
||||
|
||||
|
||||
|
||||
|
||||
*pveum roleadd* `<roleid>` `[OPTIONS]`
|
||||
|
||||
Create new role.
|
||||
|
||||
`<roleid>` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-privs` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
*pveum roledel* `<roleid>`
|
||||
|
||||
Delete role.
|
||||
|
||||
`<roleid>` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
*pveum rolemod* `<roleid> -privs <string>` `[OPTIONS]`
|
||||
|
||||
Create new role.
|
||||
|
||||
`<roleid>` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-append` `boolean` ::
|
||||
|
||||
no description available
|
||||
+
|
||||
NOTE: Requires option(s): `privs`
|
||||
|
||||
`-privs` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
|
||||
*pveum ticket* `<username>` `[OPTIONS]`
|
||||
|
||||
Create or verify authentication ticket.
|
||||
|
||||
`<username>` `string` ::
|
||||
|
||||
User name
|
||||
|
||||
`-otp` `string` ::
|
||||
|
||||
One-time password for Two-factor authentication.
|
||||
|
||||
`-path` `string` ::
|
||||
|
||||
Verify ticket, and check if user have access 'privs' on 'path'
|
||||
+
|
||||
NOTE: Requires option(s): `privs`
|
||||
|
||||
`-privs` `string` ::
|
||||
|
||||
Verify ticket, and check if user have access 'privs' on 'path'
|
||||
+
|
||||
NOTE: Requires option(s): `path`
|
||||
|
||||
`-realm` `string` ::
|
||||
|
||||
You can optionally pass the realm using this parameter. Normally the realm
|
||||
is simply added to the username <username>@<relam>.
|
||||
|
||||
|
||||
|
||||
|
||||
*pveum useradd* `<userid>` `[OPTIONS]`
|
||||
|
||||
Create new user.
|
||||
|
||||
`<userid>` `string` ::
|
||||
|
||||
User ID
|
||||
|
||||
`-comment` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-email` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-enable` `boolean` (default=`1`)::
|
||||
|
||||
Enable the account (default). You can set this to '0' to disable the accout
|
||||
|
||||
`-expire` `integer (0 - N)` ::
|
||||
|
||||
Account expiration date (seconds since epoch). '0' means no expiration
|
||||
date.
|
||||
|
||||
`-firstname` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-groups` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-keys` `string` ::
|
||||
|
||||
Keys for two factor auth (yubico).
|
||||
|
||||
`-lastname` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-password` `` ::
|
||||
|
||||
Initial password.
|
||||
|
||||
|
||||
|
||||
*pveum userdel* `<userid>`
|
||||
|
||||
Delete user.
|
||||
|
||||
`<userid>` `string` ::
|
||||
|
||||
User ID
|
||||
|
||||
|
||||
|
||||
*pveum usermod* `<userid>` `[OPTIONS]`
|
||||
|
||||
Update user configuration.
|
||||
|
||||
`<userid>` `string` ::
|
||||
|
||||
User ID
|
||||
|
||||
`-append` `boolean` ::
|
||||
|
||||
no description available
|
||||
+
|
||||
NOTE: Requires option(s): `groups`
|
||||
|
||||
`-comment` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-email` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-enable` `boolean` ::
|
||||
|
||||
Enable/disable the account.
|
||||
|
||||
`-expire` `integer (0 - N)` ::
|
||||
|
||||
Account expiration date (seconds since epoch). '0' means no expiration
|
||||
date.
|
||||
|
||||
`-firstname` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-groups` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-keys` `string` ::
|
||||
|
||||
Keys for two factor auth (yubico).
|
||||
|
||||
`-lastname` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
|
||||
|
||||
|
||||
1261
qm.1-synopsis.adoc
Normal file
1261
qm.1-synopsis.adoc
Normal file
File diff suppressed because it is too large
Load Diff
107
vzdump.1-synopsis.adoc
Normal file
107
vzdump.1-synopsis.adoc
Normal file
@ -0,0 +1,107 @@
|
||||
*vzdump* `help`
|
||||
|
||||
*vzdump* `{<vmid>}` `[OPTIONS]`
|
||||
|
||||
Create backup.
|
||||
|
||||
`<vmid>` `string` ::
|
||||
|
||||
The ID of the VM you want to backup.
|
||||
|
||||
`-all` `boolean` (default=`0`)::
|
||||
|
||||
Backup all known VMs on this host.
|
||||
|
||||
`-bwlimit` `integer (0 - N)` ::
|
||||
|
||||
Limit I/O bandwidth (KBytes per second).
|
||||
|
||||
`-compress` `(0 | 1 | gzip | lzo)` (default=`lzo`)::
|
||||
|
||||
Compress dump file.
|
||||
|
||||
`-dumpdir` `string` ::
|
||||
|
||||
Store resulting files to specified directory.
|
||||
|
||||
`-exclude` `string` ::
|
||||
|
||||
exclude specified VMs (assumes --all)
|
||||
|
||||
`-exclude-path` `string` ::
|
||||
|
||||
exclude certain files/directories (shell globs).
|
||||
|
||||
`-ionice` `integer (0 - 8)` ::
|
||||
|
||||
Set CFQ ionice priority.
|
||||
|
||||
`-lockwait` `integer (0 - N)` ::
|
||||
|
||||
Maximal time to wait for the global lock (minutes).
|
||||
|
||||
`-mailnotification` `(always | failure)` (default=`always`)::
|
||||
|
||||
Specify when to send an email
|
||||
|
||||
`-mailto` `string` ::
|
||||
|
||||
no description available
|
||||
|
||||
`-maxfiles` `integer (1 - N)` ::
|
||||
|
||||
Maximal number of backup files per VM.
|
||||
|
||||
`-mode` `(snapshot | stop | suspend)` (default=`stop`)::
|
||||
|
||||
Backup mode.
|
||||
|
||||
`-node` `string` ::
|
||||
|
||||
Only run if executed on this node.
|
||||
|
||||
`-pigz` `integer` (default=`0`)::
|
||||
|
||||
Uses pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as
|
||||
thread count.
|
||||
|
||||
`-quiet` `boolean` (default=`0`)::
|
||||
|
||||
Be quiet.
|
||||
|
||||
`-remove` `boolean` (default=`1`)::
|
||||
|
||||
Remove old backup files if there are more than 'maxfiles' backup files.
|
||||
|
||||
`-script` `string` ::
|
||||
|
||||
Use specified hook script.
|
||||
|
||||
`-size` `integer (500 - N)` ::
|
||||
|
||||
LVM snapshot size in MB.
|
||||
|
||||
`-stdexcludes` `boolean` (default=`1`)::
|
||||
|
||||
Exclude temorary files and logs.
|
||||
|
||||
`-stdout` `boolean` ::
|
||||
|
||||
Write tar to stdout, not to a file.
|
||||
|
||||
`-stop` `boolean` (default=`0`)::
|
||||
|
||||
Stop runnig backup jobs on this host.
|
||||
|
||||
`-stopwait` `integer (0 - N)` ::
|
||||
|
||||
Maximal time to wait until a VM is stopped (minutes).
|
||||
|
||||
`-storage` `string` ::
|
||||
|
||||
Store resulting file to this storage.
|
||||
|
||||
`-tmpdir` `string` ::
|
||||
|
||||
Store temporary files to specified directory.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user