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