pve-admin-guide.adoc

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