index.adoc

   1 {pve} Documentation Index
   2 =========================
   3 include::attributes.txt[]
   4 :data-uri:
   5 :icons:
   6
   7 {pve} Administration Guide
   8 --------------------------
   9
  10 [width="100%",options="header"]
  11 |===========================================================
  12 |Format               |Download link
  13 |Printable version    |link:pve-admin-guide.pdf[]
  14 |Online HTML version  |link:pve-admin-guide.html[]
  15 |E-Book version       |link:pve-admin-guide.epub[]
  16 |===========================================================
  17
  18
  19 Individual Chapters
  20 -------------------
  21 [width="100%",options="header"]
  22 |===========================================================
  23 |Title                                |Download link
  24 |Host System Administration           |link:chapter-sysadmin.html[]
  25 |Cluster Manager                      |link:chapter-pvecm.html[]
  26 |Proxmox Cluster File System (pmxcfs) |link:chapter-pmxcfs.html[]
  27 |{pve} Storage                        |link:chapter-pvesm.html[]
  28 |Qemu/KVM Virtual Machines            |link:chapter-qm.html[]
  29 |{pve} Firewall                       |link:chapter-pve-firewall.html[]
  30 |User Management                      |link:chapter-pveum.html[]
  31 |Proxmox Container Toolkit            |link:chapter-pct.html[]
  32 |High Availability                    |link:chapter-ha-manager.html[]
  33 |Backup and Restore                   |link:chapter-vzdump.html[]
  34 |Frequently Asked Questions           |link:chapter-pve-faq.html[]
  35 |Bibliography                         |link:chapter-pve-bibliography.html[]
  36 |===========================================================
  37
  38
  39 {pve} Manual Pages
  40 ------------------
  41
  42 Command Line Interface
  43 ~~~~~~~~~~~~~~~~~~~~~~
  44
  45 [width="100%",options="header"]
  46 |===========================================================
  47 | Command name    | Download link
  48 | qm              | link:qm.1.html[qm.1]
  49 | qmrestore       | link:qmrestore.1.html[qmrestore.1]
  50 | pct             | link:pct.1.html[pct.1]
  51 | pveam           | link:pveam.1.html[pveam.1]
  52 | pveceph         | link:pveceph.1.html[pveceph.1]
  53 | pvecm           | link:pvecm.1.html[pvecm.1]
  54 | pveum           | link:pveum.1.html[pveum.1]
  55 | pvesm           | link:pvesm.1.html[pvesm.1]
  56 | pvesubscription | link:pvesubscription.1.html[pvesubscription.1]
  57 | vzdump          | link:vzdump.1.html[vzdump.1]
  58 | ha-manager      | link:ha-manager.1.html[ha-manager.1]
  59 |===========================================================
  60
  61
  62 Service Daemons
  63 ~~~~~~~~~~~~~~~
  64
  65 [width="100%",options="header"]
  66 |===========================================================
  67 | Command name |'systemd' Service     | Download link
  68 | pvedaemon    | pvedaemon.service    |link:pvedaemon.8.html[pvedaemon.8]
  69 | pveproxy     | pveproxy.service     |link:pveproxy.8.html[pveproxy.8]
  70 | pvestatd     | pvestatd.service     |link:pvestatd.8.html[pvestatd.8]
  71 | spiceproxy   | spiceproxy.service   |link:spiceproxy.8.html[spiceproxy.8]
  72 | pve-ha-crm   | pve-ha-crm.service   |link:pve-ha-crm.8.html[pve-ha-crm.8]
  73 | pve-ha-lrm   | pve-ha-lrm.service   |link:pve-ha-lrm.8.html[pve-ha-lrm.8]
  74 | pve-firewall | pve-firewall.service |link:pve-firewall.8.html[pve-firewall.8]
  75 | pmxcfs       | pve-cluster.service  |link:pmxcfs.8.html[pmxcfs.8]
  76 |===========================================================
  77
  78
  79 Configuration Options
  80 ~~~~~~~~~~~~~~~~~~~~~
  81
  82 [width="100%",options="header"]
  83 |===========================================================
  84 | File name |Download link
  85 | '/etc/pve/datacenter.cfg'          | link:datacenter.cfg.5.html[datacenter.cfg.5]
  86 | '/etc/pve/qemu-server/<VMID>.conf' | link:qm.conf.5.html[qm.conf.5]
  87 | '/etc/pve/lxc/<CTID>.conf'         | link:pct.conf.5.html[pct.conf.5]
  88 |===========================================================
  89
  90
  91 API Viewer
  92 ~~~~~~~~~~
  93
  94 The link:api-viewer/index.html[API viewer] is a tiny web application
  95 which allows you to inspect all available API calls.