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 *qm* - Qemu/KVM Virtual Machine Manager
 129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 130
 131 :leveloffset: 1
 132 include::qm.1-synopsis.adoc[]
 133
 134 :leveloffset: 0
 135
 136 *qmrestore* - Restore QemuServer `vzdump` Backups
 137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 138
 139 :leveloffset: 1
 140 include::qmrestore.1-synopsis.adoc[]
 141
 142 :leveloffset: 0
 143
 144 *pct* - Proxmox Container Toolkit
 145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 146
 147 :leveloffset: 1
 148 include::pct.1-synopsis.adoc[]
 149
 150 :leveloffset: 0
 151
 152 *pveam* -  {pve} Appliance Manager
 153 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 154
 155 :leveloffset: 1
 156 include::pveam.1-synopsis.adoc[]
 157
 158 :leveloffset: 0
 159
 160 *pvecm* - {pve} Cluster Manager
 161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 162
 163 :leveloffset: 1
 164 include::pvecm.1-synopsis.adoc[]
 165
 166 :leveloffset: 0
 167
 168
 169 *pveum* - {pve} User Manager
 170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 171
 172 :leveloffset: 1
 173 include::pveum.1-synopsis.adoc[]
 174
 175 :leveloffset: 0
 176
 177 *vzdump* - Backup Utility for VMs and Containers
 178 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 179
 180 :leveloffset: 1
 181 include::vzdump.1-synopsis.adoc[]
 182
 183 :leveloffset: 0
 184
 185 *ha-manager* - {pve} HA Manager
 186 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 187
 188 :leveloffset: 1
 189 include::ha-manager.1-synopsis.adoc[]
 190
 191 :leveloffset: 0
 192
 193
 194 [appendix]
 195 Service Daemons
 196 ---------------
 197
 198 *pve-firewall* - {pve} Firewall Daemon
 199 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 200
 201 :leveloffset: 1
 202 include::pve-firewall.8-synopsis.adoc[]
 203
 204 :leveloffset: 0
 205
 206 *pvedaemon* - {pve} API Daemon
 207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 208
 209 :leveloffset: 1
 210 include::pvedaemon.8-synopsis.adoc[]
 211
 212 :leveloffset: 0
 213
 214 *pveproxy* - {pve} API Proxy Daemon
 215 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 216
 217 :leveloffset: 1
 218
 219 include::pveproxy.8-synopsis.adoc[]
 220
 221 :leveloffset: 0
 222
 223 *pvestatd* - {pve} Status Daemon
 224 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 225
 226 :leveloffset: 1
 227 include::pvestatd.8-synopsis.adoc[]
 228
 229 :leveloffset: 0
 230
 231 *spiceproxy* - SPICE Proxy Service
 232 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 233
 234 :leveloffset: 1
 235
 236 include::spiceproxy.8-synopsis.adoc[]
 237
 238 :leveloffset: 0
 239
 240 *pmxcfs* - Proxmox Cluster File System
 241 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 242
 243 :leveloffset: 1
 244 include::pmxcfs.8-synopsis.adoc[]
 245
 246 :leveloffset: 0
 247
 248 *pve-ha-crm* - Cluster Resource Manager Daemon
 249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 250
 251 :leveloffset: 1
 252 include::pve-ha-crm.8-synopsis.adoc[]
 253
 254 :leveloffset: 0
 255
 256 *pve-ha-lrm* - Local Resource Manager Daemon
 257 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 258
 259 :leveloffset: 1
 260 include::pve-ha-lrm.8-synopsis.adoc[]
 261
 262 :leveloffset: 0
 263
 264
 265 [appendix]
 266 Configuration Files
 267 -------------------
 268
 269 :leveloffset: 2
 270 include::datacenter.cfg.adoc[]
 271
 272 :leveloffset: 0
 273
 274 [appendix]
 275 Firewall Macro Definitions
 276 --------------------------
 277
 278 include::pve-firewall-macros.adoc[]
 279
 280
 281 :leveloffset: 1
 282 [appendix]
 283 include::GFDL.adoc[]
 284
 285 :leveloffset: 0
 286
 287 endif::manvolnum[]
 288 endif::wiki[]