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