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