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