pve-admin-guide.adoc

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