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