Commit | Line | Data |
---|---|---|
683e3b93 DM |
1 | ifdef::pvelogo[] |
2 | image:./images/proxmox-logo.svg[] pass:[<br>] Proxmox VE Administration Guide | |
3 | ============================================================================= | |
4 | endif::pvelogo[] | |
5 | ifndef::pvelogo[] | |
2bff8c42 DM |
6 | Proxmox VE Administration Guide |
7 | =============================== | |
683e3b93 | 8 | endif::pvelogo[] |
2bff8c42 | 9 | :doctype: book |
683e3b93 | 10 | :title: Proxmox VE Administration Guide |
ab40d1a3 | 11 | :toc2: |
2bff8c42 DM |
12 | :numbered: |
13 | :data-uri: | |
14 | :icons: | |
58cc423c DM |
15 | ifndef::wiki[] |
16 | ifndef::manvolnum[] | |
5f09af76 | 17 | :pve-toplevel: |
58cc423c | 18 | |
2bff8c42 DM |
19 | // Push titles down one level. |
20 | :leveloffset: 1 | |
21 | ||
8f4a368e | 22 | include::pve-intro.adoc[] |
2bff8c42 | 23 | |
6b5fc47b DM |
24 | include::pve-installation.adoc[] |
25 | ||
8f4a368e | 26 | include::sysadmin.adoc[] |
2bff8c42 | 27 | |
fec60328 DM |
28 | include::pve-gui.adoc[] |
29 | ||
afcff28d DM |
30 | include::pvecm.adoc[] |
31 | ||
8f4a368e | 32 | include::pmxcfs.adoc[] |
2bff8c42 | 33 | |
8f4a368e | 34 | include::pvesm.adoc[] |
2bff8c42 | 35 | |
4360c00f TM |
36 | include::pveceph.adoc[] |
37 | ||
381269be TL |
38 | include::pvesr.adoc[] |
39 | ||
8f4a368e | 40 | include::qm.adoc[] |
2bff8c42 | 41 | |
6a81db85 DM |
42 | include::pct.adoc[] |
43 | ||
d709fbb4 TL |
44 | include::pvesdn.adoc[] |
45 | ||
8f4a368e | 46 | include::pve-firewall.adoc[] |
2bff8c42 | 47 | |
8f4a368e | 48 | include::pveum.adoc[] |
2bff8c42 | 49 | |
22653ac8 DM |
50 | include::ha-manager.adoc[] |
51 | ||
8f4a368e | 52 | include::vzdump.adoc[] |
2bff8c42 DM |
53 | |
54 | // Return to normal title levels. | |
55 | :leveloffset: 0 | |
56 | ||
6b295b6e DM |
57 | Important Service Daemons |
58 | ------------------------- | |
59 | ||
60 | :leveloffset: 2 | |
61 | include::pvedaemon.adoc[] | |
62 | ||
96f2beeb | 63 | include::pveproxy.adoc[] |
6b295b6e DM |
64 | |
65 | include::pvestatd.adoc[] | |
66 | ||
2d8f1c92 DM |
67 | include::spiceproxy.adoc[] |
68 | ||
1ee2e9a2 DC |
69 | include::pvescheduler.adoc[] |
70 | ||
6b295b6e DM |
71 | :leveloffset: 0 |
72 | ||
73 | ||
ebd2a7fb DM |
74 | Useful Command Line Tools |
75 | ------------------------- | |
76 | ||
77 | :leveloffset: 2 | |
0840a663 | 78 | |
ebd2a7fb DM |
79 | include::pvesubscription.adoc[] |
80 | ||
fcace69a FG |
81 | include::pveperf.adoc[] |
82 | ||
ed53a3e6 DM |
83 | include::pvesh.adoc[] |
84 | ||
b5643436 | 85 | :leveloffset: 1 |
ebd2a7fb | 86 | |
8f4a368e | 87 | include::pve-faq.adoc[] |
2bff8c42 | 88 | |
39f4ffcf DM |
89 | include::pve-bibliography.adoc[] |
90 | ||
b5643436 DM |
91 | :leveloffset: 0 |
92 | ||
2bff8c42 | 93 | [appendix] |
2bff8c42 DM |
94 | Command Line Interface |
95 | ---------------------- | |
96 | ||
ed53a3e6 DM |
97 | :leveloffset: 1 |
98 | ||
99 | include::output-format.adoc[] | |
100 | ||
101 | :leveloffset: 0 | |
102 | ||
103 | ||
2bff8c42 DM |
104 | *pvesm* - {pve} Storage Manager |
105 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
106 | ||
107 | :leveloffset: 1 | |
8f4a368e | 108 | include::pvesm.1-synopsis.adoc[] |
82a8d2c6 | 109 | |
2bff8c42 DM |
110 | :leveloffset: 0 |
111 | ||
ebd2a7fb DM |
112 | *pvesubscription* - {pve} Subscription Manager |
113 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
114 | ||
115 | :leveloffset: 1 | |
116 | include::pvesubscription.1-synopsis.adoc[] | |
117 | ||
118 | :leveloffset: 0 | |
119 | ||
fcace69a FG |
120 | *pveperf* - {pve} Benchmark Script |
121 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
122 | ||
123 | :leveloffset: 1 | |
124 | include::pveperf.1-synopsis.adoc[] | |
125 | ||
126 | :leveloffset: 0 | |
127 | ||
0840a663 DM |
128 | *pveceph* - Manage CEPH Services on {pve} Nodes |
129 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
130 | ||
131 | :leveloffset: 1 | |
132 | include::pveceph.1-synopsis.adoc[] | |
133 | ||
134 | :leveloffset: 0 | |
135 | ||
68cd3b24 DM |
136 | *pvenode* - {pve} Node Management |
137 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
138 | ||
139 | :leveloffset: 1 | |
140 | include::pvenode.1-synopsis.adoc[] | |
141 | ||
142 | :leveloffset: 0 | |
143 | ||
17eb42a2 DM |
144 | *pvesh* - Shell interface for the {pve} API |
145 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
146 | ||
147 | :leveloffset: 1 | |
148 | include::pvesh.1-synopsis.adoc[] | |
149 | ||
150 | :leveloffset: 0 | |
151 | ||
c730e973 | 152 | *qm* - QEMU/KVM Virtual Machine Manager |
2bff8c42 DM |
153 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
154 | ||
155 | :leveloffset: 1 | |
8f4a368e | 156 | include::qm.1-synopsis.adoc[] |
82a8d2c6 | 157 | |
2bff8c42 DM |
158 | :leveloffset: 0 |
159 | ||
8c1189b6 | 160 | *qmrestore* - Restore QemuServer `vzdump` Backups |
a5bb4c40 DM |
161 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
162 | ||
163 | :leveloffset: 1 | |
164 | include::qmrestore.1-synopsis.adoc[] | |
165 | ||
166 | :leveloffset: 0 | |
167 | ||
50eba620 DM |
168 | *pct* - Proxmox Container Toolkit |
169 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
170 | ||
171 | :leveloffset: 1 | |
172 | include::pct.1-synopsis.adoc[] | |
82a8d2c6 | 173 | |
50eba620 DM |
174 | :leveloffset: 0 |
175 | ||
d61bab51 DM |
176 | *pveam* - {pve} Appliance Manager |
177 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
178 | ||
179 | :leveloffset: 1 | |
180 | include::pveam.1-synopsis.adoc[] | |
181 | ||
182 | :leveloffset: 0 | |
183 | ||
d8742b0c DM |
184 | *pvecm* - {pve} Cluster Manager |
185 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
186 | ||
187 | :leveloffset: 1 | |
188 | include::pvecm.1-synopsis.adoc[] | |
189 | ||
190 | :leveloffset: 0 | |
191 | ||
4ecb55a9 TL |
192 | *pvesr* - {pve} Storage Replication |
193 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
194 | ||
195 | :leveloffset: 1 | |
196 | include::pvesr.1-synopsis.adoc[] | |
197 | ||
198 | :leveloffset: 0 | |
199 | ||
d8742b0c | 200 | |
2bff8c42 DM |
201 | *pveum* - {pve} User Manager |
202 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
203 | ||
204 | :leveloffset: 1 | |
8f4a368e | 205 | include::pveum.1-synopsis.adoc[] |
82a8d2c6 | 206 | |
2bff8c42 DM |
207 | :leveloffset: 0 |
208 | ||
209 | *vzdump* - Backup Utility for VMs and Containers | |
210 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
211 | ||
212 | :leveloffset: 1 | |
8f4a368e | 213 | include::vzdump.1-synopsis.adoc[] |
82a8d2c6 | 214 | |
2bff8c42 DM |
215 | :leveloffset: 0 |
216 | ||
26ca7ff5 FG |
217 | *ha-manager* - {pve} HA Manager |
218 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
22653ac8 DM |
219 | |
220 | :leveloffset: 1 | |
221 | include::ha-manager.1-synopsis.adoc[] | |
222 | ||
223 | :leveloffset: 0 | |
224 | ||
9ddb9dc3 DM |
225 | |
226 | [appendix] | |
227 | Service Daemons | |
228 | --------------- | |
229 | ||
f5eb0727 | 230 | *pve-firewall* - {pve} Firewall Daemon |
15d7842c | 231 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
47e1b0c6 DM |
232 | |
233 | :leveloffset: 1 | |
9ddb9dc3 | 234 | include::pve-firewall.8-synopsis.adoc[] |
47e1b0c6 DM |
235 | |
236 | :leveloffset: 0 | |
237 | ||
f5eb0727 | 238 | *pvedaemon* - {pve} API Daemon |
15d7842c | 239 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
954a26fd DM |
240 | |
241 | :leveloffset: 1 | |
9ddb9dc3 | 242 | include::pvedaemon.8-synopsis.adoc[] |
954a26fd DM |
243 | |
244 | :leveloffset: 0 | |
2d8f1c92 | 245 | |
96f2beeb | 246 | *pveproxy* - {pve} API Proxy Daemon |
15d7842c | 247 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
96f2beeb DM |
248 | |
249 | :leveloffset: 1 | |
15d7842c | 250 | |
96f2beeb DM |
251 | include::pveproxy.8-synopsis.adoc[] |
252 | ||
253 | :leveloffset: 0 | |
254 | ||
f5eb0727 | 255 | *pvestatd* - {pve} Status Daemon |
4db6a3f3 DM |
256 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
257 | ||
258 | :leveloffset: 1 | |
259 | include::pvestatd.8-synopsis.adoc[] | |
260 | ||
261 | :leveloffset: 0 | |
262 | ||
2d8f1c92 DM |
263 | *spiceproxy* - SPICE Proxy Service |
264 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
265 | ||
266 | :leveloffset: 1 | |
267 | ||
268 | include::spiceproxy.8-synopsis.adoc[] | |
269 | ||
270 | :leveloffset: 0 | |
271 | ||
3377a78b DM |
272 | *pmxcfs* - Proxmox Cluster File System |
273 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
274 | ||
275 | :leveloffset: 1 | |
54079101 | 276 | include::pmxcfs.8-synopsis.adoc[] |
3377a78b DM |
277 | |
278 | :leveloffset: 0 | |
279 | ||
5eba0743 | 280 | *pve-ha-crm* - Cluster Resource Manager Daemon |
9ddb9dc3 DM |
281 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
282 | ||
283 | :leveloffset: 1 | |
284 | include::pve-ha-crm.8-synopsis.adoc[] | |
285 | ||
286 | :leveloffset: 0 | |
287 | ||
5eba0743 | 288 | *pve-ha-lrm* - Local Resource Manager Daemon |
9ddb9dc3 DM |
289 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
290 | ||
291 | :leveloffset: 1 | |
292 | include::pve-ha-lrm.8-synopsis.adoc[] | |
293 | ||
294 | :leveloffset: 0 | |
295 | ||
1ee2e9a2 DC |
296 | *pvescheduler* - {pve} Scheduler Daemon |
297 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
298 | ||
299 | :leveloffset: 1 | |
300 | include::pvescheduler.8-synopsis.adoc[] | |
301 | ||
302 | :leveloffset: 0 | |
4db6a3f3 | 303 | |
c016ebb7 DM |
304 | [appendix] |
305 | Configuration Files | |
306 | ------------------- | |
307 | ||
308 | :leveloffset: 2 | |
8f1132ee | 309 | include::datacenter.cfg.adoc[] |
c016ebb7 DM |
310 | |
311 | :leveloffset: 0 | |
312 | ||
1ee2e9a2 DC |
313 | [appendix] |
314 | Calendar Events | |
315 | --------------- | |
316 | ||
317 | :leveloffset: 1 | |
318 | include::calendar-events.adoc[] | |
319 | ||
320 | :leveloffset: 0 | |
321 | ||
14c06023 DM |
322 | [appendix] |
323 | Firewall Macro Definitions | |
324 | -------------------------- | |
325 | ||
326 | include::pve-firewall-macros.adoc[] | |
327 | ||
44d211d2 TL |
328 | :leveloffset: 1 |
329 | [appendix] | |
330 | include::markdown-primer.adoc[] | |
c016ebb7 | 331 | |
2296c490 DM |
332 | :leveloffset: 1 |
333 | [appendix] | |
334 | include::GFDL.adoc[] | |
82a8d2c6 | 335 | |
2296c490 DM |
336 | :leveloffset: 0 |
337 | ||
58cc423c DM |
338 | endif::manvolnum[] |
339 | endif::wiki[] |