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