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 include::pveperf.adoc[]
  71
  72
  73 :leveloffset: 1
  74
  75 include::pve-faq.adoc[]
  76
  77 include::pve-bibliography.adoc[]
  78
  79 :leveloffset: 0
  80
  81 [appendix]
  82 Command Line Interface
  83 ----------------------
  84
  85 *pvesm* - {pve} Storage Manager
  86 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  87
  88 :leveloffset: 1
  89 include::pvesm.1-synopsis.adoc[]
  90
  91 :leveloffset: 0
  92
  93 *pvesubscription* - {pve} Subscription Manager
  94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  95
  96 :leveloffset: 1
  97 include::pvesubscription.1-synopsis.adoc[]
  98
  99 :leveloffset: 0
 100
 101 *pveperf* - {pve} Benchmark Script
 102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 103
 104 :leveloffset: 1
 105 include::pveperf.1-synopsis.adoc[]
 106
 107 :leveloffset: 0
 108
 109 *pveceph* - Manage CEPH Services on {pve} Nodes
 110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 111
 112 :leveloffset: 1
 113 include::pveceph.1-synopsis.adoc[]
 114
 115 :leveloffset: 0
 116
 117 *qm* - Qemu/KVM Virtual Machine Manager
 118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 119
 120 :leveloffset: 1
 121 include::qm.1-synopsis.adoc[]
 122
 123 :leveloffset: 0
 124
 125 *qmrestore* - Restore QemuServer `vzdump` Backups
 126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 127
 128 :leveloffset: 1
 129 include::qmrestore.1-synopsis.adoc[]
 130
 131 :leveloffset: 0
 132
 133 *pct* - Proxmox Container Toolkit
 134 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135
 136 :leveloffset: 1
 137 include::pct.1-synopsis.adoc[]
 138
 139 :leveloffset: 0
 140
 141 *pveam* -  {pve} Appliance Manager
 142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 143
 144 :leveloffset: 1
 145 include::pveam.1-synopsis.adoc[]
 146
 147 :leveloffset: 0
 148
 149 *pvecm* - {pve} Cluster Manager
 150 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 151
 152 :leveloffset: 1
 153 include::pvecm.1-synopsis.adoc[]
 154
 155 :leveloffset: 0
 156
 157
 158 *pveum* - {pve} User Manager
 159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 160
 161 :leveloffset: 1
 162 include::pveum.1-synopsis.adoc[]
 163
 164 :leveloffset: 0
 165
 166 *vzdump* - Backup Utility for VMs and Containers
 167 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 168
 169 :leveloffset: 1
 170 include::vzdump.1-synopsis.adoc[]
 171
 172 :leveloffset: 0
 173
 174 *ha-manager* - {pve} HA Manager
 175 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 176
 177 :leveloffset: 1
 178 include::ha-manager.1-synopsis.adoc[]
 179
 180 :leveloffset: 0
 181
 182
 183 [appendix]
 184 Service Daemons
 185 ---------------
 186
 187 *pve-firewall* - {pve} Firewall Daemon
 188 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 189
 190 :leveloffset: 1
 191 include::pve-firewall.8-synopsis.adoc[]
 192
 193 :leveloffset: 0
 194
 195 *pvedaemon* - {pve} API Daemon
 196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 197
 198 :leveloffset: 1
 199 include::pvedaemon.8-synopsis.adoc[]
 200
 201 :leveloffset: 0
 202
 203 *pveproxy* - {pve} API Proxy Daemon
 204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 205
 206 :leveloffset: 1
 207
 208 include::pveproxy.8-synopsis.adoc[]
 209
 210 :leveloffset: 0
 211
 212 *pvestatd* - {pve} Status Daemon
 213 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 214
 215 :leveloffset: 1
 216 include::pvestatd.8-synopsis.adoc[]
 217
 218 :leveloffset: 0
 219
 220 *spiceproxy* - SPICE Proxy Service
 221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 222
 223 :leveloffset: 1
 224
 225 include::spiceproxy.8-synopsis.adoc[]
 226
 227 :leveloffset: 0
 228
 229 *pmxcfs* - Proxmox Cluster File System
 230 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 231
 232 :leveloffset: 1
 233 include::pmxcfs.8-cli.adoc[]
 234
 235 :leveloffset: 0
 236
 237 *pve-ha-crm* - Cluster Resource Manager Daemon
 238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 239
 240 :leveloffset: 1
 241 include::pve-ha-crm.8-synopsis.adoc[]
 242
 243 :leveloffset: 0
 244
 245 *pve-ha-lrm* - Local Resource Manager Daemon
 246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 247
 248 :leveloffset: 1
 249 include::pve-ha-lrm.8-synopsis.adoc[]
 250
 251 :leveloffset: 0
 252
 253
 254 [appendix]
 255 Configuration Files
 256 -------------------
 257
 258 :leveloffset: 2
 259 include::datacenter.cfg.adoc[]
 260
 261 :leveloffset: 0
 262
 263 [appendix]
 264 Firewall Macro Definitions
 265 --------------------------
 266
 267 include::pve-firewall-macros.adoc[]
 268
 269
 270 :leveloffset: 1
 271 [appendix]
 272 include::GFDL.adoc[]
 273
 274 :leveloffset: 0
 275