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