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