add pvesubscription man page
[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::pve-firewall.adoc[]
26
27 include::pveum.adoc[]
28
29 include::pct.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::pvesubscription.adoc[]
58
59 :leveloffset: 0
60
61
62 include::pve-faq.adoc[]
63
64 include::pve-bibliography.adoc[]
65
66 [appendix]
67 Command Line Interface
68 ----------------------
69
70 *pvesm* - {pve} Storage Manager
71 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72
73 :leveloffset: 1
74 include::pvesm.1-synopsis.adoc[]
75
76 :leveloffset: 0
77
78 *pvesubscription* - {pve} Subscription Manager
79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
80
81 :leveloffset: 1
82 include::pvesubscription.1-synopsis.adoc[]
83
84 :leveloffset: 0
85
86 *qm* - Qemu/KVM Virtual Machine Manager
87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88
89 :leveloffset: 1
90 include::qm.1-synopsis.adoc[]
91
92 :leveloffset: 0
93
94 *qmrestore* - Restore QemuServer 'vzdump' Backups
95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96
97 :leveloffset: 1
98 include::qmrestore.1-synopsis.adoc[]
99
100 :leveloffset: 0
101
102 *pct* - Proxmox Container Toolkit
103 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104
105 :leveloffset: 1
106 include::pct.1-synopsis.adoc[]
107
108 :leveloffset: 0
109
110 *pveam* -  {pve} Appliance Manager
111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112
113 :leveloffset: 1
114 include::pveam.1-synopsis.adoc[]
115
116 :leveloffset: 0
117
118 *pvecm* - {pve} Cluster Manager
119 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120
121 :leveloffset: 1
122 include::pvecm.1-synopsis.adoc[]
123
124 :leveloffset: 0
125
126
127 *pveum* - {pve} User Manager
128 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
129
130 :leveloffset: 1
131 include::pveum.1-synopsis.adoc[]
132
133 :leveloffset: 0
134
135 *vzdump* - Backup Utility for VMs and Containers
136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
137
138 :leveloffset: 1
139 include::vzdump.1-synopsis.adoc[]
140
141 :leveloffset: 0
142
143 *ha-manager* - Proxmox VE HA Manager
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145
146 :leveloffset: 1
147 include::ha-manager.1-synopsis.adoc[]
148
149 :leveloffset: 0
150
151
152 [appendix]
153 Service Daemons
154 ---------------
155
156 *pve-firewall* - {pve} Firewall Daemon
157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
158
159 :leveloffset: 1
160 include::pve-firewall.8-synopsis.adoc[]
161
162 :leveloffset: 0
163
164 *pvedaemon* - {pve} API Daemon
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166
167 :leveloffset: 1
168 include::pvedaemon.8-synopsis.adoc[]
169
170 :leveloffset: 0
171
172 *pveproxy* - {pve} API Proxy Daemon
173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174
175 :leveloffset: 1
176
177 include::pveproxy.8-synopsis.adoc[]
178
179 :leveloffset: 0
180
181 *pvestatd* - {pve} Status Daemon
182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
183
184 :leveloffset: 1
185 include::pvestatd.8-synopsis.adoc[]
186
187 :leveloffset: 0
188
189 *spiceproxy* - SPICE Proxy Service
190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191
192 :leveloffset: 1
193
194 include::spiceproxy.8-synopsis.adoc[]
195
196 :leveloffset: 0
197
198 *pmxcfs* - Proxmox Cluster File System
199 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200
201 :leveloffset: 1
202 include::pmxcfs.8-cli.adoc[]
203
204 :leveloffset: 0
205
206 *pve-ha-crm* - Cluster Ressource Manager Daemon
207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
208
209 :leveloffset: 1
210 include::pve-ha-crm.8-synopsis.adoc[]
211
212 :leveloffset: 0
213
214 *pve-ha-lrm* - Local Ressource Manager Daemon
215 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
216
217 :leveloffset: 1
218 include::pve-ha-lrm.8-synopsis.adoc[]
219
220 :leveloffset: 0
221
222
223 [appendix]
224 Configuration Files
225 -------------------
226
227 :leveloffset: 2
228 include::datacenter.cfg.adoc[]
229
230 include::qm.conf.adoc[]
231
232 include::pct.conf.adoc[]
233
234 :leveloffset: 0
235
236 [appendix]
237 Firewall Macro Definitions
238 --------------------------
239
240 include::pve-firewall-macros.adoc[]
241
242
243 :leveloffset: 1
244 [appendix]
245 include::GFDL.adoc[]
246
247 :leveloffset: 0
248