proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-04-28 21:13:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update autogenerated docs

Browse Source
This commit is contained in:
Dietmar Maurer 2016-09-29 12:18:57 +02:00
parent 20fa8c2208
commit 2c0dde619d
12 changed files with 630 additions and 277 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

764
api-viewer/apidata.js
View File

File diff suppressed because it is too large Load Diff

4
datacenter.cfg.5-opts.adoc
View File

@ -24,6 +24,10 @@ Default keybord layout for vnc server.
Default GUI language.
`mac_prefix`: `(?^i:[a-f0-9]{2}(?::[a-f0-9]{2}){0,2}:?)` ::
Prefix for autogenerated MAC addresses.
`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.

6
pct-mountpoint-opts.adoc
View File

@ -8,11 +8,13 @@ Explicitly enable or disable ACL support.
`backup`: `boolean` ::
Whether to include the mountpoint in backups.
Whether to include the mountpoint in backups (only used for volume mountpoints).
`mp`: `<Path>` ::
Path to the mountpoint as seen from inside the container.
+
NOTE: Must not contain any symlinks for security reasons.
`quota`: `boolean` ::
@ -20,7 +22,7 @@ Enable user quotas inside the container (not supported with zfs subvolumes)
`ro`: `boolean` ::
Read-only mountpoint (not supported with bind mounts)
Read-only mountpoint
`size`: `<DiskSize>` ::

26
pct.1-synopsis.adoc
View File

@ -236,6 +236,16 @@ The (unique) ID of the VM.
*pct df* `<vmid>`
Get the container's current disk usage.
`<vmid>` `integer (1 - N)` ::
The (unique) ID of the VM.
*pct enter* `<vmid>`
Launch a shell for the specified container.
@ -759,6 +769,22 @@ Ignore locks - only root is allowed to use this option.
*pct status* `<vmid>` `[OPTIONS]`
Show CT status.
`<vmid>` `integer (1 - N)` ::
The (unique) ID of the VM.
`-verbose` `boolean` ::
Verbose output format
*pct stop* `<vmid>` `[OPTIONS]`
Stop the container. This will abruptly stop all processes running in the

8
pct.conf.5-opts.adoc
View File

@ -48,11 +48,13 @@ Explicitly enable or disable ACL support.
`backup`=`boolean` ;;
Whether to include the mountpoint in backups.
Whether to include the mountpoint in backups (only used for volume mountpoints).
`mp`=`<Path>` ;;
Path to the mountpoint as seen from inside the container.
+
NOTE: Must not contain any symlinks for security reasons.
`quota`=`boolean` ;;
@ -60,7 +62,7 @@ Enable user quotas inside the container (not supported with zfs subvolumes)
`ro`=`boolean` ;;
Read-only mountpoint (not supported with bind mounts)
Read-only mountpoint
`size`=`<DiskSize>` ;;
@ -156,7 +158,7 @@ Enable user quotas inside the container (not supported with zfs subvolumes)
`ro`=`boolean` ;;
Read-only mountpoint (not supported with bind mounts)
Read-only mountpoint
`size`=`<DiskSize>` ;;

9
pve-firewall-macros.adoc
View File

@ -328,6 +328,15 @@
|PARAM|tcp|636|
|===========================================================
[horizontal]
'MDNS':: Multicast DNS
[width="100%",options="header"]
|===========================================================
|Action|proto|dport|sport
|PARAM|udp|5353|
|===========================================================
[horizontal]
'MSNP':: Microsoft Notification Protocol

4
pveam.1-synopsis.adoc
View File

@ -17,7 +17,7 @@ Download appliance templates.
`<storage>` `string` ::
Only list status for specified storage
The storage where the template will be stored
`<template>` `string` ::
@ -47,7 +47,7 @@ Get list of all templates on storage
`<storage>` `string` ::
Only list status for specified storage
Only list templates on specified storage

6
pveceph.1-synopsis.adoc
View File

@ -78,7 +78,7 @@ If set, we remove partition table entries.
*pveceph destroypool* `<name>`
*pveceph destroypool* `<name>` `[OPTIONS]`
Destroy pool
@ -86,6 +86,10 @@ Destroy pool
The name of the pool. It must be unique.
`-force` `boolean` (default=`0`)::
If true, destroys pool even if in use

2
pvecm.1-synopsis.adoc
View File

@ -104,7 +104,7 @@ Removes a node to the cluster configuration.
`<node>` `string` ::
The cluster node name.
Hostname or IP of the corosync ring0 address of this node.

36
pvesm.1-synopsis.adoc
View File

@ -50,6 +50,10 @@ NFS export path.
Default image format.
`-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` ::
iscsi provider
@ -62,6 +66,10 @@ Access rbd through krbd kernel module.
Maximal number of backup files per VM. Use '0' for unlimted.
`-mkdir` `boolean` (default=`yes`)::
Create the directory if it doesn't exist.
`-monhost` `string` ::
Monitors daemon ips.
@ -120,6 +128,10 @@ Mark storage as shared.
use sparse volumes
`-tagged_only` `boolean` ::
Only use logical volumes tagged with 'pve-vm-ID'.
`-target` `string` ::
iSCSI target.
@ -175,6 +187,18 @@ NOTE: Requires option(s): `size`
*pvesm extractconfig* `<volume>`
Extract configuration from vzdump backup archive.
`<volume>` `string` ::
Volume identifier
*pvesm free* `<volume>` `[OPTIONS]`
Delete volume
@ -336,6 +360,10 @@ Flag to disable the storage.
Default image format.
`-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` ::
Access rbd through krbd kernel module.
@ -344,6 +372,10 @@ Access rbd through krbd kernel module.
Maximal number of backup files per VM. Use '0' for unlimted.
`-mkdir` `boolean` (default=`yes`)::
Create the directory if it doesn't exist.
`-nodes` `string` ::
List of cluster node names.
@ -390,6 +422,10 @@ Mark storage as shared.
use sparse volumes
`-tagged_only` `boolean` ::
Only use logical volumes tagged with 'pve-vm-ID'.
`-transport` `(rdma | tcp | unix)` ::
Gluster transport: tcp or rdma

22
qm.1-synopsis.adoc
View File

@ -133,6 +133,10 @@ CPU weight for a VM.
Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
`-efidisk0` `[file=]<volume> [,format=<image format>] [,size=<DiskSize>]` ::
Configure a Disk for storing EFI vars
`-force` `boolean` ::
Allow to overwrite existing VM.
@ -151,6 +155,10 @@ Map host PCI devices into guest.
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)` ::
Enable/disable hugepages memory.
`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,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>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
@ -415,7 +423,7 @@ Move volume to different storage.
The (unique) ID of the VM.
`<disk>` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` ::
`<disk>` `(efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` ::
The disk you want to move.
@ -489,7 +497,7 @@ Extend volume size.
The (unique) ID of the VM.
`<disk>` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` ::
`<disk>` `(efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` ::
The disk you want to resize.
@ -631,6 +639,10 @@ Description for the VM. Only used on the configuration web interface. This is sa
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
`-efidisk0` `[file=]<volume> [,format=<image format>] [,size=<DiskSize>]` ::
Configure a Disk for storing EFI vars
`-force` `boolean` ::
Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal.
@ -649,6 +661,10 @@ Map host PCI devices into guest.
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)` ::
Enable/disable hugepages memory.
`-ide[n]` `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,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>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).
@ -960,7 +976,7 @@ Create a Template.
The (unique) ID of the VM.
`-disk` `(ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` ::
`-disk` `(efidisk0 | ide0 | ide1 | ide2 | ide3 | sata0 | sata1 | sata2 | sata3 | sata4 | sata5 | scsi0 | scsi1 | scsi10 | scsi11 | scsi12 | scsi13 | scsi2 | scsi3 | scsi4 | scsi5 | scsi6 | scsi7 | scsi8 | scsi9 | virtio0 | virtio1 | virtio10 | virtio11 | virtio12 | virtio13 | virtio14 | virtio15 | virtio2 | virtio3 | virtio4 | virtio5 | virtio6 | virtio7 | virtio8 | virtio9)` ::
If you want to convert only 1 disk to base image.

20
qm.conf.5-opts.adoc
View File

@ -70,6 +70,22 @@ NOTE: You can disable fair-scheduler configuration by setting this to 0.
Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.
`efidisk0`: `[file=]<volume> [,format=<image format>] [,size=<DiskSize>]` ::
Configure a Disk for storing EFI vars
`file`=`<volume>` ;;
The drive's backing volume.
`format`=`<image format>` ;;
The drive's backing file's data format.
`size`=`<DiskSize>` ;;
Disk size. This is purely informational and has no effect.
`freeze`: `boolean` ::
Freeze CPU at startup (use 'c' monitor command to start execution).
@ -108,6 +124,10 @@ Enable vfio-vga device support.
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)` ::
Enable/disable hugepages memory.
`ide[n]`: `[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,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>]` ::
Use volume as IDE hard disk or CD-ROM (n is 0 to 3).