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