]> git.proxmox.com Git - pve-docs.git/blame - pve-admin-guide.adoc
add missing apidoc.htm
[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
8f4a368e 25include::pve-firewall.adoc[]
2bff8c42 26
8f4a368e 27include::pveum.adoc[]
2bff8c42 28
8f4a368e 29include::pct.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
61:leveloffset: 0
62
63
8f4a368e 64include::pve-faq.adoc[]
2bff8c42 65
39f4ffcf
DM
66include::pve-bibliography.adoc[]
67
2bff8c42 68[appendix]
2bff8c42
DM
69Command Line Interface
70----------------------
71
72*pvesm* - {pve} Storage Manager
73~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74
75:leveloffset: 1
8f4a368e 76include::pvesm.1-synopsis.adoc[]
82a8d2c6 77
2bff8c42
DM
78:leveloffset: 0
79
ebd2a7fb
DM
80*pvesubscription* - {pve} Subscription Manager
81~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
82
83:leveloffset: 1
84include::pvesubscription.1-synopsis.adoc[]
85
86:leveloffset: 0
87
0840a663
DM
88*pveceph* - Manage CEPH Services on {pve} Nodes
89~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90
91:leveloffset: 1
92include::pveceph.1-synopsis.adoc[]
93
94:leveloffset: 0
95
2bff8c42
DM
96*qm* - Qemu/KVM Virtual Machine Manager
97~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98
99:leveloffset: 1
8f4a368e 100include::qm.1-synopsis.adoc[]
82a8d2c6 101
2bff8c42
DM
102:leveloffset: 0
103
a5bb4c40
DM
104*qmrestore* - Restore QemuServer 'vzdump' Backups
105~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106
107:leveloffset: 1
108include::qmrestore.1-synopsis.adoc[]
109
110:leveloffset: 0
111
50eba620
DM
112*pct* - Proxmox Container Toolkit
113~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114
115:leveloffset: 1
116include::pct.1-synopsis.adoc[]
82a8d2c6 117
50eba620
DM
118:leveloffset: 0
119
d61bab51
DM
120*pveam* - {pve} Appliance Manager
121~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122
123:leveloffset: 1
124include::pveam.1-synopsis.adoc[]
125
126:leveloffset: 0
127
d8742b0c
DM
128*pvecm* - {pve} Cluster Manager
129~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130
131:leveloffset: 1
132include::pvecm.1-synopsis.adoc[]
133
134:leveloffset: 0
135
136
2bff8c42
DM
137*pveum* - {pve} User Manager
138~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139
140:leveloffset: 1
8f4a368e 141include::pveum.1-synopsis.adoc[]
82a8d2c6 142
2bff8c42
DM
143:leveloffset: 0
144
145*vzdump* - Backup Utility for VMs and Containers
146~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
147
148:leveloffset: 1
8f4a368e 149include::vzdump.1-synopsis.adoc[]
82a8d2c6 150
2bff8c42
DM
151:leveloffset: 0
152
734404b4 153*ha-manager* - Proxmox VE HA Manager
22653ac8
DM
154~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
155
156:leveloffset: 1
157include::ha-manager.1-synopsis.adoc[]
158
159:leveloffset: 0
160
9ddb9dc3
DM
161
162[appendix]
163Service Daemons
164---------------
165
f5eb0727 166*pve-firewall* - {pve} Firewall Daemon
15d7842c 167~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47e1b0c6
DM
168
169:leveloffset: 1
9ddb9dc3 170include::pve-firewall.8-synopsis.adoc[]
47e1b0c6
DM
171
172:leveloffset: 0
173
f5eb0727 174*pvedaemon* - {pve} API Daemon
15d7842c 175~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
954a26fd
DM
176
177:leveloffset: 1
9ddb9dc3 178include::pvedaemon.8-synopsis.adoc[]
954a26fd
DM
179
180:leveloffset: 0
2d8f1c92 181
96f2beeb 182*pveproxy* - {pve} API Proxy Daemon
15d7842c 183~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96f2beeb
DM
184
185:leveloffset: 1
15d7842c 186
96f2beeb
DM
187include::pveproxy.8-synopsis.adoc[]
188
189:leveloffset: 0
190
f5eb0727 191*pvestatd* - {pve} Status Daemon
4db6a3f3
DM
192~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193
194:leveloffset: 1
195include::pvestatd.8-synopsis.adoc[]
196
197:leveloffset: 0
198
2d8f1c92
DM
199*spiceproxy* - SPICE Proxy Service
200~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
201
202:leveloffset: 1
203
204include::spiceproxy.8-synopsis.adoc[]
205
206:leveloffset: 0
207
3377a78b
DM
208*pmxcfs* - Proxmox Cluster File System
209~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
210
211:leveloffset: 1
212include::pmxcfs.8-cli.adoc[]
213
214:leveloffset: 0
215
9ddb9dc3
DM
216*pve-ha-crm* - Cluster Ressource Manager Daemon
217~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
218
219:leveloffset: 1
220include::pve-ha-crm.8-synopsis.adoc[]
221
222:leveloffset: 0
223
224*pve-ha-lrm* - Local Ressource Manager Daemon
225~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
226
227:leveloffset: 1
228include::pve-ha-lrm.8-synopsis.adoc[]
229
230:leveloffset: 0
231
4db6a3f3 232
c016ebb7
DM
233[appendix]
234Configuration Files
235-------------------
236
237:leveloffset: 2
8f1132ee 238include::datacenter.cfg.adoc[]
c016ebb7 239
16e6f235 240include::qm.conf.adoc[]
7b2c36ae 241
71e16346
DM
242include::pct.conf.adoc[]
243
c016ebb7
DM
244:leveloffset: 0
245
14c06023
DM
246[appendix]
247Firewall Macro Definitions
248--------------------------
249
250include::pve-firewall-macros.adoc[]
251
c016ebb7 252
2296c490
DM
253:leveloffset: 1
254[appendix]
255include::GFDL.adoc[]
82a8d2c6 256
2296c490
DM
257:leveloffset: 0
258