pve-admin-guide.adoc

   1 Proxmox VE Administration Guide
   2 ===============================
   3 include::attributes.txt[]
   4 :doctype:   book
   5 :toc:
   6 :numbered:
   7 :data-uri:
   8 :icons:
   9
  10 // Push titles down one level.
  11 :leveloffset: 1
  12
  13 include::pve-intro.adoc[]
  14
  15 include::sysadmin.adoc[]
  16
  17 include::pvecm.adoc[]
  18
  19 include::pmxcfs.adoc[]
  20
  21 include::pvesm.adoc[]
  22
  23 include::qm.adoc[]
  24
  25 include::pve-firewall.adoc[]
  26
  27 include::pveum.adoc[]
  28
  29 include::pct.adoc[]
  30
  31 include::ha-manager.adoc[]
  32
  33 include::vzdump.adoc[]
  34
  35 // Return to normal title levels.
  36 :leveloffset: 0
  37
  38 Important Service Daemons
  39 -------------------------
  40
  41 :leveloffset: 2
  42 include::pvedaemon.adoc[]
  43
  44 include::pveproxy.adoc[]
  45
  46 include::pvestatd.adoc[]
  47
  48 include::spiceproxy.adoc[]
  49
  50 :leveloffset: 0
  51
  52
  53 Useful Command Line Tools
  54 -------------------------
  55
  56 :leveloffset: 2
  57 include::pveceph.adoc[]
  58
  59 include::pvesubscription.adoc[]
  60
  61 :leveloffset: 0
  62
  63
  64 include::pve-faq.adoc[]
  65
  66 include::pve-bibliography.adoc[]
  67
  68 [appendix]
  69 Command Line Interface
  70 ----------------------
  71
  72 *pvesm* - {pve} Storage Manager
  73 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  74
  75 :leveloffset: 1
  76 include::pvesm.1-synopsis.adoc[]
  77
  78 :leveloffset: 0
  79
  80 *pvesubscription* - {pve} Subscription Manager
  81 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  82
  83 :leveloffset: 1
  84 include::pvesubscription.1-synopsis.adoc[]
  85
  86 :leveloffset: 0
  87
  88 *pveceph* - Manage CEPH Services on {pve} Nodes
  89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  90
  91 :leveloffset: 1
  92 include::pveceph.1-synopsis.adoc[]
  93
  94 :leveloffset: 0
  95
  96 *qm* - Qemu/KVM Virtual Machine Manager
  97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  98
  99 :leveloffset: 1
 100 include::qm.1-synopsis.adoc[]
 101
 102 :leveloffset: 0
 103
 104 *qmrestore* - Restore QemuServer 'vzdump' Backups
 105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 106
 107 :leveloffset: 1
 108 include::qmrestore.1-synopsis.adoc[]
 109
 110 :leveloffset: 0
 111
 112 *pct* - Proxmox Container Toolkit
 113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 114
 115 :leveloffset: 1
 116 include::pct.1-synopsis.adoc[]
 117
 118 :leveloffset: 0
 119
 120 *pveam* -  {pve} Appliance Manager
 121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 122
 123 :leveloffset: 1
 124 include::pveam.1-synopsis.adoc[]
 125
 126 :leveloffset: 0
 127
 128 *pvecm* - {pve} Cluster Manager
 129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 130
 131 :leveloffset: 1
 132 include::pvecm.1-synopsis.adoc[]
 133
 134 :leveloffset: 0
 135
 136
 137 *pveum* - {pve} User Manager
 138 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 139
 140 :leveloffset: 1
 141 include::pveum.1-synopsis.adoc[]
 142
 143 :leveloffset: 0
 144
 145 *vzdump* - Backup Utility for VMs and Containers
 146 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 147
 148 :leveloffset: 1
 149 include::vzdump.1-synopsis.adoc[]
 150
 151 :leveloffset: 0
 152
 153 *ha-manager* - Proxmox VE HA Manager
 154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 155
 156 :leveloffset: 1
 157 include::ha-manager.1-synopsis.adoc[]
 158
 159 :leveloffset: 0
 160
 161
 162 [appendix]
 163 Service Daemons
 164 ---------------
 165
 166 *pve-firewall* - {pve} Firewall Daemon
 167 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 168
 169 :leveloffset: 1
 170 include::pve-firewall.8-synopsis.adoc[]
 171
 172 :leveloffset: 0
 173
 174 *pvedaemon* - {pve} API Daemon
 175 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 176
 177 :leveloffset: 1
 178 include::pvedaemon.8-synopsis.adoc[]
 179
 180 :leveloffset: 0
 181
 182 *pveproxy* - {pve} API Proxy Daemon
 183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 184
 185 :leveloffset: 1
 186
 187 include::pveproxy.8-synopsis.adoc[]
 188
 189 :leveloffset: 0
 190
 191 *pvestatd* - {pve} Status Daemon
 192 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 193
 194 :leveloffset: 1
 195 include::pvestatd.8-synopsis.adoc[]
 196
 197 :leveloffset: 0
 198
 199 *spiceproxy* - SPICE Proxy Service
 200 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 201
 202 :leveloffset: 1
 203
 204 include::spiceproxy.8-synopsis.adoc[]
 205
 206 :leveloffset: 0
 207
 208 *pmxcfs* - Proxmox Cluster File System
 209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 210
 211 :leveloffset: 1
 212 include::pmxcfs.8-cli.adoc[]
 213
 214 :leveloffset: 0
 215
 216 *pve-ha-crm* - Cluster Ressource Manager Daemon
 217 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 218
 219 :leveloffset: 1
 220 include::pve-ha-crm.8-synopsis.adoc[]
 221
 222 :leveloffset: 0
 223
 224 *pve-ha-lrm* - Local Ressource Manager Daemon
 225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 226
 227 :leveloffset: 1
 228 include::pve-ha-lrm.8-synopsis.adoc[]
 229
 230 :leveloffset: 0
 231
 232
 233 [appendix]
 234 Configuration Files
 235 -------------------
 236
 237 :leveloffset: 2
 238 include::datacenter.cfg.adoc[]
 239
 240 include::qm.conf.adoc[]
 241
 242 include::pct.conf.adoc[]
 243
 244 :leveloffset: 0
 245
 246 [appendix]
 247 Firewall Macro Definitions
 248 --------------------------
 249
 250 include::pve-firewall-macros.adoc[]
 251
 252
 253 :leveloffset: 1
 254 [appendix]
 255 include::GFDL.adoc[]
 256
 257 :leveloffset: 0
 258