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