make dinstall: skip mediawiki deb for now
[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::hyper-converged-infrastructure.adoc[]
29
30 :leveloffset: 2
31 include::pveceph.adoc[]
32 :leveloffset: 1
33
34 include::pve-gui.adoc[]
35
36 include::pvecm.adoc[]
37
38 include::pmxcfs.adoc[]
39
40 include::pvesm.adoc[]
41
42 include::pvesr.adoc[]
43
44 include::qm.adoc[]
45
46 include::pct.adoc[]
47
48 include::pve-firewall.adoc[]
49
50 include::pveum.adoc[]
51
52 include::ha-manager.adoc[]
53
54 include::vzdump.adoc[]
55
56 // Return to normal title levels.
57 :leveloffset: 0
58
59 Important Service Daemons
60 -------------------------
61
62 :leveloffset: 2
63 include::pvedaemon.adoc[]
64
65 include::pveproxy.adoc[]
66
67 include::pvestatd.adoc[]
68
69 include::spiceproxy.adoc[]
70
71 :leveloffset: 0
72
73
74 Useful Command Line Tools
75 -------------------------
76
77 :leveloffset: 2
78
79 include::pvesubscription.adoc[]
80
81 include::pveperf.adoc[]
82
83 include::pvesh.adoc[]
84
85 include::pvenode.adoc[]
86
87 :leveloffset: 1
88
89 include::pve-faq.adoc[]
90
91 include::pve-bibliography.adoc[]
92
93 :leveloffset: 0
94
95 [appendix]
96 Command Line Interface
97 ----------------------
98
99 :leveloffset: 1
100
101 include::output-format.adoc[]
102
103 :leveloffset: 0
104
105
106 *pvesm* - {pve} Storage Manager
107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
108
109 :leveloffset: 1
110 include::pvesm.1-synopsis.adoc[]
111
112 :leveloffset: 0
113
114 *pvesubscription* - {pve} Subscription Manager
115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116
117 :leveloffset: 1
118 include::pvesubscription.1-synopsis.adoc[]
119
120 :leveloffset: 0
121
122 *pveperf* - {pve} Benchmark Script
123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
124
125 :leveloffset: 1
126 include::pveperf.1-synopsis.adoc[]
127
128 :leveloffset: 0
129
130 *pveceph* - Manage CEPH Services on {pve} Nodes
131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132
133 :leveloffset: 1
134 include::pveceph.1-synopsis.adoc[]
135
136 :leveloffset: 0
137
138 *pvenode* - {pve} Node Management
139 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140
141 :leveloffset: 1
142 include::pvenode.1-synopsis.adoc[]
143
144 :leveloffset: 0
145
146 *pvesh* - Shell interface for the {pve} API
147 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
148
149 :leveloffset: 1
150 include::pvesh.1-synopsis.adoc[]
151
152 :leveloffset: 0
153
154 *qm* - Qemu/KVM Virtual Machine Manager
155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
156
157 :leveloffset: 1
158 include::qm.1-synopsis.adoc[]
159
160 :leveloffset: 0
161
162 *qmrestore* - Restore QemuServer `vzdump` Backups
163 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164
165 :leveloffset: 1
166 include::qmrestore.1-synopsis.adoc[]
167
168 :leveloffset: 0
169
170 *pct* - Proxmox Container Toolkit
171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
172
173 :leveloffset: 1
174 include::pct.1-synopsis.adoc[]
175
176 :leveloffset: 0
177
178 *pveam* -  {pve} Appliance Manager
179 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
180
181 :leveloffset: 1
182 include::pveam.1-synopsis.adoc[]
183
184 :leveloffset: 0
185
186 *pvecm* - {pve} Cluster Manager
187 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
188
189 :leveloffset: 1
190 include::pvecm.1-synopsis.adoc[]
191
192 :leveloffset: 0
193
194 *pvesr* - {pve} Storage Replication
195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
196
197 :leveloffset: 1
198 include::pvesr.1-synopsis.adoc[]
199
200 :leveloffset: 0
201
202
203 *pveum* - {pve} User Manager
204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
205
206 :leveloffset: 1
207 include::pveum.1-synopsis.adoc[]
208
209 :leveloffset: 0
210
211 *vzdump* - Backup Utility for VMs and Containers
212 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213
214 :leveloffset: 1
215 include::vzdump.1-synopsis.adoc[]
216
217 :leveloffset: 0
218
219 *ha-manager* - {pve} HA Manager
220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221
222 :leveloffset: 1
223 include::ha-manager.1-synopsis.adoc[]
224
225 :leveloffset: 0
226
227
228 [appendix]
229 Service Daemons
230 ---------------
231
232 *pve-firewall* - {pve} Firewall Daemon
233 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
234
235 :leveloffset: 1
236 include::pve-firewall.8-synopsis.adoc[]
237
238 :leveloffset: 0
239
240 *pvedaemon* - {pve} API Daemon
241 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
242
243 :leveloffset: 1
244 include::pvedaemon.8-synopsis.adoc[]
245
246 :leveloffset: 0
247
248 *pveproxy* - {pve} API Proxy Daemon
249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
250
251 :leveloffset: 1
252
253 include::pveproxy.8-synopsis.adoc[]
254
255 :leveloffset: 0
256
257 *pvestatd* - {pve} Status Daemon
258 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
259
260 :leveloffset: 1
261 include::pvestatd.8-synopsis.adoc[]
262
263 :leveloffset: 0
264
265 *spiceproxy* - SPICE Proxy Service
266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
267
268 :leveloffset: 1
269
270 include::spiceproxy.8-synopsis.adoc[]
271
272 :leveloffset: 0
273
274 *pmxcfs* - Proxmox Cluster File System
275 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
276
277 :leveloffset: 1
278 include::pmxcfs.8-synopsis.adoc[]
279
280 :leveloffset: 0
281
282 *pve-ha-crm* - Cluster Resource Manager Daemon
283 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
284
285 :leveloffset: 1
286 include::pve-ha-crm.8-synopsis.adoc[]
287
288 :leveloffset: 0
289
290 *pve-ha-lrm* - Local Resource Manager Daemon
291 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
292
293 :leveloffset: 1
294 include::pve-ha-lrm.8-synopsis.adoc[]
295
296 :leveloffset: 0
297
298
299 [appendix]
300 Configuration Files
301 -------------------
302
303 :leveloffset: 2
304 include::datacenter.cfg.adoc[]
305
306 :leveloffset: 0
307
308 [appendix]
309 Firewall Macro Definitions
310 --------------------------
311
312 include::pve-firewall-macros.adoc[]
313
314
315 :leveloffset: 1
316 [appendix]
317 include::GFDL.adoc[]
318
319 :leveloffset: 0
320
321 endif::manvolnum[]
322 endif::wiki[]