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 :toc2:
  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::pve-gui.adoc[]
  29
  30 include::pvecm.adoc[]
  31
  32 include::pmxcfs.adoc[]
  33
  34 include::pvesm.adoc[]
  35
  36 include::pveceph.adoc[]
  37
  38 include::pvesr.adoc[]
  39
  40 include::qm.adoc[]
  41
  42 include::pct.adoc[]
  43
  44 include::pvesdn.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 include::pvescheduler.adoc[]
  70
  71 :leveloffset: 0
  72
  73
  74 Useful Command Line Tools
  75 -------------------------
  76
  77 :leveloffset: 2
  78
  79 include::pvesubscription.adoc[]
  80
  81 include::pveperf.adoc[]
  82
  83 include::pvesh.adoc[]
  84
  85 :leveloffset: 1
  86
  87 include::pve-faq.adoc[]
  88
  89 include::pve-bibliography.adoc[]
  90
  91 :leveloffset: 0
  92
  93 [appendix]
  94 Command Line Interface
  95 ----------------------
  96
  97 :leveloffset: 1
  98
  99 include::output-format.adoc[]
 100
 101 :leveloffset: 0
 102
 103
 104 *pvesm* - {pve} Storage Manager
 105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 106
 107 :leveloffset: 1
 108 include::pvesm.1-synopsis.adoc[]
 109
 110 :leveloffset: 0
 111
 112 *pvesubscription* - {pve} Subscription Manager
 113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 114
 115 :leveloffset: 1
 116 include::pvesubscription.1-synopsis.adoc[]
 117
 118 :leveloffset: 0
 119
 120 *pveperf* - {pve} Benchmark Script
 121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 122
 123 :leveloffset: 1
 124 include::pveperf.1-synopsis.adoc[]
 125
 126 :leveloffset: 0
 127
 128 *pveceph* - Manage CEPH Services on {pve} Nodes
 129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 130
 131 :leveloffset: 1
 132 include::pveceph.1-synopsis.adoc[]
 133
 134 :leveloffset: 0
 135
 136 *pvenode* - {pve} Node Management
 137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 138
 139 :leveloffset: 1
 140 include::pvenode.1-synopsis.adoc[]
 141
 142 :leveloffset: 0
 143
 144 *pvesh* - Shell interface for the {pve} API
 145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 146
 147 :leveloffset: 1
 148 include::pvesh.1-synopsis.adoc[]
 149
 150 :leveloffset: 0
 151
 152 *qm* - Qemu/KVM Virtual Machine Manager
 153 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 154
 155 :leveloffset: 1
 156 include::qm.1-synopsis.adoc[]
 157
 158 :leveloffset: 0
 159
 160 *qmrestore* - Restore QemuServer `vzdump` Backups
 161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 162
 163 :leveloffset: 1
 164 include::qmrestore.1-synopsis.adoc[]
 165
 166 :leveloffset: 0
 167
 168 *pct* - Proxmox Container Toolkit
 169 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 170
 171 :leveloffset: 1
 172 include::pct.1-synopsis.adoc[]
 173
 174 :leveloffset: 0
 175
 176 *pveam* -  {pve} Appliance Manager
 177 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 178
 179 :leveloffset: 1
 180 include::pveam.1-synopsis.adoc[]
 181
 182 :leveloffset: 0
 183
 184 *pvecm* - {pve} Cluster Manager
 185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 186
 187 :leveloffset: 1
 188 include::pvecm.1-synopsis.adoc[]
 189
 190 :leveloffset: 0
 191
 192 *pvesr* - {pve} Storage Replication
 193 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 194
 195 :leveloffset: 1
 196 include::pvesr.1-synopsis.adoc[]
 197
 198 :leveloffset: 0
 199
 200
 201 *pveum* - {pve} User Manager
 202 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 203
 204 :leveloffset: 1
 205 include::pveum.1-synopsis.adoc[]
 206
 207 :leveloffset: 0
 208
 209 *vzdump* - Backup Utility for VMs and Containers
 210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 211
 212 :leveloffset: 1
 213 include::vzdump.1-synopsis.adoc[]
 214
 215 :leveloffset: 0
 216
 217 *ha-manager* - {pve} HA Manager
 218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 219
 220 :leveloffset: 1
 221 include::ha-manager.1-synopsis.adoc[]
 222
 223 :leveloffset: 0
 224
 225
 226 [appendix]
 227 Service Daemons
 228 ---------------
 229
 230 *pve-firewall* - {pve} Firewall Daemon
 231 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 232
 233 :leveloffset: 1
 234 include::pve-firewall.8-synopsis.adoc[]
 235
 236 :leveloffset: 0
 237
 238 *pvedaemon* - {pve} API Daemon
 239 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 240
 241 :leveloffset: 1
 242 include::pvedaemon.8-synopsis.adoc[]
 243
 244 :leveloffset: 0
 245
 246 *pveproxy* - {pve} API Proxy Daemon
 247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 248
 249 :leveloffset: 1
 250
 251 include::pveproxy.8-synopsis.adoc[]
 252
 253 :leveloffset: 0
 254
 255 *pvestatd* - {pve} Status Daemon
 256 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 257
 258 :leveloffset: 1
 259 include::pvestatd.8-synopsis.adoc[]
 260
 261 :leveloffset: 0
 262
 263 *spiceproxy* - SPICE Proxy Service
 264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 265
 266 :leveloffset: 1
 267
 268 include::spiceproxy.8-synopsis.adoc[]
 269
 270 :leveloffset: 0
 271
 272 *pmxcfs* - Proxmox Cluster File System
 273 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 274
 275 :leveloffset: 1
 276 include::pmxcfs.8-synopsis.adoc[]
 277
 278 :leveloffset: 0
 279
 280 *pve-ha-crm* - Cluster Resource Manager Daemon
 281 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 282
 283 :leveloffset: 1
 284 include::pve-ha-crm.8-synopsis.adoc[]
 285
 286 :leveloffset: 0
 287
 288 *pve-ha-lrm* - Local Resource Manager Daemon
 289 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 290
 291 :leveloffset: 1
 292 include::pve-ha-lrm.8-synopsis.adoc[]
 293
 294 :leveloffset: 0
 295
 296 *pvescheduler* - {pve} Scheduler Daemon
 297 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 298
 299 :leveloffset: 1
 300 include::pvescheduler.8-synopsis.adoc[]
 301
 302 :leveloffset: 0
 303
 304 [appendix]
 305 Configuration Files
 306 -------------------
 307
 308 :leveloffset: 2
 309 include::datacenter.cfg.adoc[]
 310
 311 :leveloffset: 0
 312
 313 [appendix]
 314 Calendar Events
 315 ---------------
 316
 317 :leveloffset: 1
 318 include::calendar-events.adoc[]
 319
 320 :leveloffset: 0
 321
 322 [appendix]
 323 Firewall Macro Definitions
 324 --------------------------
 325
 326 include::pve-firewall-macros.adoc[]
 327
 328 :leveloffset: 1
 329 [appendix]
 330 include::markdown-primer.adoc[]
 331
 332 :leveloffset: 1
 333 [appendix]
 334 include::GFDL.adoc[]
 335
 336 :leveloffset: 0
 337
 338 endif::manvolnum[]
 339 endif::wiki[]