├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── README_ZH.md
├── composer.json
├── example.php
└── src
└── Libvirt.php
/.gitattributes:
--------------------------------------------------------------------------------
1 | # Auto detect text files and perform LF normalization
2 | * text=auto
3 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | composer.lock
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Libvirt-Manager
2 |
3 | [中文 ReadMe](README_ZH.md) | [ZeroDream](https://www.zerodream.net/)
4 |
5 | This is a simple php libvirt manager
6 |
7 | It can start, shutdown, destory, get the virtual machines list or get the information for any virtual machine.
8 |
9 | This project is to make it easier for developers to manage virtual machines.
10 |
11 | You need install php_ssh2 module to use this manager.
12 |
13 | Maybe this document has some grammatical mistakes, because the author is Chinese :P
14 |
15 | ### Install Libvirt-Manager
16 |
17 | Use composer
18 |
19 | ```
20 | composer require kasuganosoras/libvirt-manager
21 | ```
22 |
23 | Use git
24 |
25 | ```
26 | git clone https://github.com/kasuganosoras/Libvirt-Manager
27 | ```
28 |
29 | ### Example code for connect a server
30 |
31 | This example code will connect to your server using SSH, make sure your server sshd service is running.
32 |
33 | ```php
34 | require_once __DIR__ . '/vendor/autoload.php';
35 | use libvirt_manager\Libvirt;
36 | $Libvirt = new Libvirt();
37 | $Libvirt->setHost("192.168.3.181", 22, "/data/libvirt/");
38 | $Libvirt->connect("root", "123456");
39 | ```
40 |
41 | The `192.168.3.181` is your server hostname, `22` is your server port, and `/data/libvirt/` is your libvirt data save path.
42 |
43 | For authenticate, use username and password, the username and password in example code is `root` and `123456`.
44 |
45 | ### Example code for create a virtual machine
46 |
47 | The following example code will create a virtual machine called Test and allocate 2 CPU cores, 2 GB of memory to it.
48 |
49 | ```php
50 | $Libvirt->createDisk("Test", "qcow2", "30G");
51 | $Libvirt->createVMXML("Test", 2, 2048576, "/data/libvirt/images/Test/Test.qcow2", "/data/iso/CentOS-7-x86_64-Minimal-1804.iso", "cdrom", "network", "default", $Libvirt->randomMac(), "virbr0", 0, 0, 5902);
52 | $Libvirt->define("/data/libvirt/Test.xml");
53 | $Libvirt->setPermission("Test");
54 | $Libvirt->start("Test");
55 | ```
56 | #### Create a virtual disk
57 | ```php
58 | String createDisk ( Name, Format, Size )
59 | ```
60 | #### create a Virtual Machine xml config file
61 | The method of createVMXML have 13 params.
62 | ```php
63 | void createVMXL ( Name, vCPU, Ram, Disk, ISO, Boot Device, Network type, Network name, MAC Address, Network bridge, Bandwidth in, Bandwidth out, VNC Port )
64 | ```
65 | #### Register the xml config file to system
66 | ```php
67 | String define ( XML File Path )
68 | ```
69 | #### Set execute permission
70 | ```php
71 | void setPermission ( Name )
72 | ```
73 | #### Start the virtual machine
74 | ```php
75 | String start ( Name )
76 | ```
77 | #### Stop the virtual machine
78 | ```php
79 | String shutdown ( Name )
80 | ```
81 | #### Force stop the virtual machine
82 | if your virtual machine is in trouble and can't use shutdown to make if off, you can use this method to force stop it.
83 | ```php
84 | String destroy ( Name )
85 | ```
86 | #### Get the virtual machine list
87 | You can use this method to get the virtual machine list, It will return an array.
88 | ```php
89 | String getList ()
90 | ```
91 | #### Get the virtual machine information
92 | You can use this method to get any registed virtual machine information, It will return an array.
93 | ```php
94 | String getInfo ( Name )
95 | ```
96 | #### Dump the virtual machine xml config file
97 | This method can get any registered virtual machine xml config file and return.
98 | ```php
99 | String dumpxml ( Name )
100 | ```
101 | #### Clone an exist virtual machine
102 | You can use this method to clone a exist virtual machine.
103 |
104 | This method may take a long time, you need add a line `set_time_limit(120)` in your code.
105 | ```php
106 | String cloneVM ( Name, New name, New disk path )
107 | ```
108 | #### Set the virtual machine network
109 | This method can control the virtual machine network.
110 |
111 | The third param is Boolean type, if you give it a true value, the network will enable, else the network will disable.
112 | ```php
113 | String setNetwork ( Server, Network name, Status )
114 | ```
115 | You can find out more info in `libvirt/libvirt.php`
116 |
--------------------------------------------------------------------------------
/README_ZH.md:
--------------------------------------------------------------------------------
1 | # Libvirt-Manager
2 |
3 | 这是一个简单的 Libvirt 虚拟机管理器,使用 PHP 开发。
4 |
5 | 它可以启动、关闭、强制结束或读取虚拟机信息,列出虚拟机列表等。
6 |
7 | 这个项目是为了让开发者管理虚拟机更简单,更轻松。
8 |
9 | 你需要安装 PHP_SSH2 模块来使用此管理器。
10 |
11 | 唔...第一次写英文 ReadMe,英文很蹩脚,请不要在意...嘤嘤嘤
12 |
13 | ### 安装 Libvirt-Manager
14 |
15 | 使用 Composer
16 |
17 | ```
18 | composer require kasuganosoras/libvirt-manager
19 | ```
20 |
21 | 使用 Git
22 |
23 | ```
24 | git clone https://github.com/kasuganosoras/Libvirt-Manager
25 | ```
26 |
27 | ### 连接到服务器的示例代码
28 |
29 | Libvirt Manager 需要通过 SSH 连接到服务器进行操作,请确认你的服务器已启用 sshd 服务。
30 |
31 | ```php
32 | require_once __DIR__ . '/vendor/autoload.php';
33 | use libvirt_manager\Libvirt;
34 | $Libvirt = new Libvirt();
35 | $Libvirt->setHost("192.168.3.181", 22, "/data/libvirt/");
36 | $Libvirt->connect("root", "123456");
37 | ```
38 |
39 | 在示例代码中,`192.168.3.181` 是服务器地址,`22` 是服务器端口,`/data/libvirt/` 是你希望 Libvirt 使用的数据储存目录。
40 |
41 | 在登录时,请使用用户名和密码(目前暂不支持证书登录),示例代码中的用户名和密码分别是 `root` 和 `123456`
42 |
43 | ### 创建虚拟机示例代码
44 |
45 | 下面的示例代码将会创建一个名为 Test 的虚拟机,并且为它分配 2 CPU 核心,2GB 内存。
46 |
47 | ```php
48 | $Libvirt->createDisk("Test", "qcow2", "30G");
49 | $Libvirt->createVMXML("Test", 2, 2048576, "/data/libvirt/images/Test/Test.qcow2", "/data/iso/CentOS-7-x86_64-Minimal-1804.iso", "cdrom", "network", "default", $Libvirt->randomMac(), "virbr0", 0, 0, 5902);
50 | $Libvirt->define("/data/libvirt/Test.xml");
51 | $Libvirt->setPermission("Test");
52 | $Libvirt->start("Test");
53 | ```
54 | #### 创建一个虚拟磁盘
55 | ```php
56 | String createDisk ( Name, Format, Size )
57 | ```
58 | #### 创建一个虚拟机 XML 配置文件
59 | createVMXML 方法一共有 13 个参数
60 | ```php
61 | void createVMXML ( Name, vCPU, Ram, Disk, ISO, Boot Device, Network type, Network name, MAC Address, Network bridge, Bandwidth in, Bandwidth out, VNC Port )
62 | ```
63 | #### 将虚拟机 XML 配置文件注册到系统
64 | ```php
65 | String define ( XML File Path )
66 | ```
67 | #### 设置可执行权限
68 | ```php
69 | void setPermission ( Name )
70 | ```
71 | #### 启动虚拟机
72 | ```php
73 | String start ( Name )
74 | ```
75 | #### 正常停止虚拟机
76 | ```php
77 | String shutdown ( Name )
78 | ```
79 | #### 强制停止虚拟机
80 | 如果你的虚拟机出现了问题导致不能使用 shutdown 方法停止时,可以使用此方法强制结束虚拟机,但是可能会丢失数据。
81 | ```php
82 | String destroy ( Name )
83 | ```
84 | #### 获得虚拟机列表
85 | 你可以使用此方法获得所有已注册的虚拟机列表,它将会返回一个数组。
86 | ```php
87 | String getList ()
88 | ```
89 | #### 获得虚拟机信息
90 | 你可以使用此方法获得任何已注册的虚拟机信息,它将会返回一个数组。
91 | ```php
92 | String getInfo ( Name )
93 | ```
94 | #### 导出虚拟机的 XML 配置文件
95 | 此方法可以读取虚拟机的 XML 配置文件并返回
96 | ```php
97 | String dumpxml ( Name )
98 | ```
99 | #### 克隆现有的虚拟机
100 | 你可以使用此方法复制一个现有的虚拟机
101 |
102 | 此方法也许需要消耗很长时间,具体视磁盘性能而定,建议加一行代码 `set_time_limit(120)` 以防止脚本超时。
103 | ```php
104 | String cloneVM ( Name, New name, New disk path )
105 | ```
106 | #### 设置虚拟机网卡
107 | 此方法可以设置虚拟机的网卡
108 |
109 | 第三个参数是布尔型的,如果赋值是 true,将会启用网卡,如果赋值是 false,将会禁用网卡。
110 | ```php
111 | String setNetwork ( Server, Network name, Status )
112 | ```
113 | 你可以在 `libvirt/libvirt.php` 找到更多信息
114 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "kasuganosoras/libvirt_manager",
3 | "description": "A library to control the libvirt virtual machine.",
4 | "type": "library",
5 | "license": "GPL-3.0-only",
6 | "authors": [
7 | {
8 | "name": "KasuganoSoras",
9 | "email": "kasuganosora@tcotp.cn"
10 | }
11 | ],
12 | "minimum-stability": "stable",
13 | "require": {},
14 | "autoload": {
15 | "psr-4": {
16 | "libvirt_manager\\": "src/"
17 | }
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/example.php:
--------------------------------------------------------------------------------
1 | setHost("192.168.3.181", 22, "/data/libvirt/");
9 | // Use the username 'root' and the password '123456' login to server.
10 | $Libvirt->connect("root", "123456");
11 | // Print the virtual machine centos's config file.
12 | echo $Libvirt->dumpxml("centos");
13 |
--------------------------------------------------------------------------------
/src/Libvirt.php:
--------------------------------------------------------------------------------
1 | hostname = $hostname;
21 | $this->libpath = $libpath;
22 | $this->port = intval($port);
23 | }
24 |
25 | /**
26 | *
27 | * connect 连接服务器
28 | *
29 | * @param $username SSH 用户名
30 | * @param $password SSH 密码
31 | *
32 | */
33 | public function connect($username = "", $password = "") {
34 | if(!$this->hostname || !$this->port || !$this->libpath) {
35 | throw new HostUndefineException();
36 | } else {
37 | try {
38 | $this->conn = ssh2_connect($this->hostname, $this->port);
39 | ssh2_auth_password($this->conn, $username, $password);
40 | if($this->runCommand("whoami") == "") {
41 | throw new LoginFailedException();
42 | }
43 | } catch (Exception $e) {
44 | die($e->getMessage());
45 | }
46 | }
47 | }
48 |
49 | /**
50 | *
51 | * runCommand 执行 Shell 命令
52 | *
53 | * @param $data 需要执行的命令
54 | *
55 | */
56 | public function runCommand($data) {
57 | if(!$this->conn || $this->conn === null) {
58 | throw new NoConnectionException();
59 | }
60 | try {
61 | $stream = ssh2_exec($this->conn, $data);
62 | stream_set_blocking($stream, true);
63 | $stream_out = ssh2_fetch_stream($stream, SSH2_STREAM_STDIO);
64 | $stream_out = stream_get_contents($stream_out);
65 | } catch (Exception $e) {
66 | print($e->getMessage());
67 | $stream_out = null;
68 | }
69 | return $stream_out;
70 | }
71 |
72 | /**
73 | *
74 | * getList 获取当前主机上的所有虚拟机
75 | *
76 | * @return Array 虚拟机列表
77 | *
78 | */
79 | public function getList() {
80 | if(!$this->conn) {
81 | throw new NoConnectionException();
82 | }
83 | $list = $this->runCommand("virsh list --all --name");
84 | $list = explode("\n", $list);
85 | $data = array();
86 | foreach($list as $item) {
87 | if($item !== "") {
88 | $data[count($data)] = $item;
89 | }
90 | }
91 | return $data;
92 | }
93 |
94 | /**
95 | *
96 | * start 启动指定的虚拟机
97 | *
98 | * @param $server 虚拟机名称
99 | * @return String 执行结果
100 | *
101 | */
102 | public function start($server) {
103 | if(!$this->conn) {
104 | throw new NoConnectionException();
105 | }
106 | return $this->runCommand("virsh start {$server}");
107 | }
108 |
109 | /**
110 | *
111 | * destroy 强制关闭指定的虚拟机
112 | *
113 | * @param $server 虚拟机名称
114 | * @return String 执行结果
115 | *
116 | */
117 | public function destroy($server) {
118 | if(!$this->conn) {
119 | throw new NoConnectionException();
120 | }
121 | return $this->runCommand("virsh destroy {$server}");
122 | }
123 |
124 | /**
125 | *
126 | * shutdown 关闭指定的虚拟机
127 | *
128 | * @param $server 虚拟机名称
129 | * @return String 执行结果
130 | *
131 | */
132 | public function shutdown($server) {
133 | if(!$this->conn) {
134 | throw new NoConnectionException();
135 | }
136 | return $this->runCommand("virsh shutdown {$server}");
137 | }
138 |
139 | /**
140 | *
141 | * reboot 重启指定的虚拟机
142 | *
143 | * @param $server 虚拟机名称
144 | * @return String 执行结果
145 | *
146 | */
147 | public function reboot($server) {
148 | if(!$this->conn) {
149 | throw new NoConnectionException();
150 | }
151 | return $this->runCommand("virsh reboot {$server}");
152 | }
153 |
154 | /**
155 | *
156 | * suspend 暂停指定的虚拟机
157 | *
158 | * @param $server 虚拟机名称
159 | * @return String 执行结果
160 | *
161 | */
162 | public function suspend($server) {
163 | if(!$this->conn) {
164 | throw new NoConnectionException();
165 | }
166 | return $this->runCommand("virsh suspend {$server}");
167 | }
168 |
169 | /**
170 | *
171 | * resume 恢复指定的虚拟机
172 | *
173 | * @param $server 虚拟机名称
174 | * @return String 执行结果
175 | *
176 | */
177 | public function resume($server) {
178 | if(!$this->conn) {
179 | throw new NoConnectionException();
180 | }
181 | return $this->runCommand("virsh resume {$server}");
182 | }
183 |
184 | /**
185 | *
186 | * save 将指定的虚拟机状态转储到文件
187 | *
188 | * @param $server 虚拟机名称
189 | * @param $name 文件名
190 | * @return String 执行结果
191 | *
192 | */
193 | public function save($server, $name) {
194 | if(!$this->conn) {
195 | throw new NoConnectionException();
196 | }
197 | return $this->runCommand("virsh save {$server} {$name}");
198 | }
199 |
200 | /**
201 | *
202 | * restore 从文件中恢复虚拟机的状态
203 | *
204 | * @param $name 文件名
205 | * @return String 执行结果
206 | *
207 | */
208 | public function restore($name) {
209 | if(!$this->conn) {
210 | throw new NoConnectionException();
211 | }
212 | return $this->runCommand("virsh restore {$name}");
213 | }
214 |
215 | /**
216 | *
217 | * define 载入指定的虚拟机配置文件
218 | *
219 | * @param $xmlfile XML 文件路径和名称
220 | * @return String 执行结果
221 | *
222 | */
223 | public function define($xmlfile) {
224 | if(!$this->conn) {
225 | throw new NoConnectionException();
226 | }
227 | return $this->runCommand("virsh define {$xmlfile}");
228 | }
229 |
230 | /**
231 | *
232 | * undefine 移除指定的虚拟机
233 | *
234 | * @param $server 虚拟机名称
235 | * @return String 执行结果
236 | *
237 | */
238 | public function undefine($server) {
239 | if(!$this->conn) {
240 | throw new NoConnectionException();
241 | }
242 | return $this->runCommand("virsh undefine {$server}");
243 | }
244 |
245 | /**
246 | *
247 | * dumpxml 输出指定的虚拟机的配置文件
248 | *
249 | * @param $server 虚拟机名称
250 | * @return String 虚拟机配置文件
251 | *
252 | */
253 | public function dumpxml($server) {
254 | if(!$this->conn) {
255 | throw new NoConnectionException();
256 | }
257 | return $this->runCommand("virsh dumpxml {$server}");
258 | }
259 |
260 | /**
261 | *
262 | * getInfo 获取指定的虚拟机的配置信息
263 | *
264 | * @param $server 虚拟机名称
265 | * @return Array 虚拟机配置信息数组
266 | *
267 | */
268 | public function getInfo($server) {
269 | if(!$this->conn) {
270 | throw new NoConnectionException();
271 | }
272 | $info = $this->runCommand("virsh dominfo {$server}");
273 | $info = explode("\n", $info);
274 | $data = array();
275 | foreach($info as $item) {
276 | if($item !== "") {
277 | $exp = explode(": ", $item);
278 | $key = trim($exp[0]);
279 | $value = trim($exp[1]);
280 | $data[$key] = $value;
281 | }
282 | }
283 | return $data;
284 | }
285 |
286 | /**
287 | *
288 | * createVMXML 创建新的虚拟机配置并上传至服务器
289 | *
290 | * @param $server 名称
291 | * @param $vcpu CPU 数量
292 | * @param $memory 运行内存
293 | * @param $disk 磁盘镜像路径
294 | * @param $iso ISO 镜像路径
295 | * @param $boot 首选启动设备
296 | * @param $network_type 网卡类型
297 | * @param $network_name 网卡名称
298 | * @param $network_mac 网卡 MAC 地址
299 | * @param $network_bridge 网卡桥接名称
300 | * @param $bandwidth_in 限制下行最大速率(0为不限制)
301 | * @param $bandwidth_out 限制上行最大速率(0为不限制)
302 | * @param $vnc_port VNC 远程连接端口
303 | *
304 | */
305 | public function createVMXML($server, $vcpu, $memory, $disk = "", $iso = "", $boot = "hd", $network_type = "network", $network_name = "default", $network_mac = "", $network_bridge = "", $bandwidth_in = 0, $bandwidth_out = 0, $vnc_port = 5900) {
306 | // 这一段写的非常骚气请不要在意
307 | $template = "
308 | {$server}
309 | {$uuid}
310 | {$memory}
311 | {$memory}
312 | {$vcpu}
313 |
314 | /machine
315 |
316 |
317 | hvm
318 |
319 |
320 |
321 |
322 |
323 |
324 |
325 |
326 |
327 | destroy
328 | restart
329 | destroy
330 |
331 | /usr/libexec/qemu-kvm
332 | ";
333 | // 如果设置了磁盘文件
334 | if($disk !== "") {
335 | $template .=
336 | "
337 |
338 |
339 |
340 |
341 |
342 |
343 |
344 | ";
345 | }
346 |
347 | // 如果设置了 ISO 镜像
348 | if($iso !== "") {
349 | $template .=
350 | "
351 |
352 |
353 |
354 |
355 |
356 |
357 |
358 |
359 | ";
360 | }
361 |
362 | // 判断网络类型,选择不同的标签
363 | $tag_name = ($network_type !== "network") ? "name" : "network";
364 | $template .=
365 | "
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 |
376 |
377 |
378 |
379 | ";
380 | // 如果设置了最大宽带速率
381 | if($bandwidth_in !== 0 && $bandwidth_out !== 0) {
382 | $template .=
383 | "
384 |
385 |
386 |
387 | ";
388 | }
389 | $template .=
390 | "
391 |
392 |
393 |
394 |
395 |
396 |
397 |
398 |
399 |
400 |
401 |
402 |
403 |
404 |
409 |
410 |
411 |
412 |
413 |
414 |
415 |
416 | +9869:+9869
417 |
418 | ";
419 | @file_put_contents(__DIR__ . "/{$server}.xml", $template);
420 | $this->uploadFile(__DIR__ . "/{$server}.xml", $this->libpath . "/{$server}.xml");
421 | @unlink(__DIR__ . "/{$server}.xml");
422 | }
423 |
424 | /**
425 | *
426 | * changeMac 修改指定虚拟机的网卡 MAC
427 | *
428 | * @param $server 虚拟机名称
429 | * @param $newMac 新的网卡 MAC
430 | *
431 | */
432 | public function changeMac($server, $newMac = "") {
433 | $data = $this->dumpxml($server);
434 | if($newMac == "") {
435 | $newMac = $this->randomMac();
436 | }
437 | $data = preg_replace("/address='([A-Za-z0-9\:]+)'/", "address='{$newMac}'", $data);
438 | @file_put_contents(__DIR__ . "/{$server}.xml", $data);
439 | $this->uploadFile(__DIR__ . "/{$server}.xml", $this->libpath . "/{$server}.xml");
440 | @unlink(__DIR__ . "/{$server}.xml");
441 | }
442 |
443 | /**
444 | *
445 | * createDisk 创建新的虚拟磁盘
446 | *
447 | * @param $name 虚拟磁盘名称
448 | * @param $type 虚拟磁盘类型(raw / qcow2 ...)
449 | * @param $size 虚拟磁盘容量(GB)
450 | * @return String 执行结果
451 | *
452 | */
453 | public function createDisk($name, $type, $size) {
454 | if(!$this->conn) {
455 | throw new NoConnectionException();
456 | }
457 | $this->runCommand("mkdir " . $this->libpath . "images/{$name}/");
458 | return $this->runCommand("qemu-img create -f {$type} " . $this->libpath . "images/{$name}/{$name}.{$type} {$size}");// $this->runCommand("qemu-img create -f {$type} {$name} {$size}");
459 | }
460 |
461 | /**
462 | *
463 | * cloneVM 克隆指定的虚拟机
464 | *
465 | * @param $sname 源虚拟机名称
466 | * @param $dname 目标虚拟机名称
467 | * @param $ddisk 目标虚拟机磁盘文件
468 | * @return String 执行结果
469 | *
470 | */
471 | public function cloneVM($sname, $dname, $ddisk = "") {
472 | if(!$this->conn) {
473 | throw new NoConnectionException();
474 | }
475 | if($ddisk === "") {
476 | $ddisk = $this->libpath . "images/{$dname}/{$dname}.qcow2";
477 | $this->runCommand("mkdir " . $this->libpath . "images/{$dname}/");
478 | }
479 | return $this->runCommand("virt-clone -o {$sname} -n {$dname} --file {$ddisk}");
480 | }
481 |
482 | /**
483 | *
484 | * attach_disk 临时挂载磁盘到虚拟机
485 | *
486 | * @param $server 虚拟机名称
487 | * @param $name 虚拟磁盘文件名
488 | * @param $target 虚拟磁盘标签
489 | * @return String 执行结果
490 | *
491 | */
492 | public function attach_disk($server, $name, $target) {
493 | if(!$this->conn) {
494 | throw new NoConnectionException();
495 | }
496 | return $this->runCommand("virsh attach-disk {$server} " . $this->libpath . "images/{$name} {$target} --cache none");
497 | }
498 |
499 | /**
500 | *
501 | * detach_disk 临时卸载虚拟机的磁盘
502 | *
503 | * @param $server 虚拟机名称
504 | * @param $target 虚拟磁盘标签
505 | * @return String 执行结果
506 | *
507 | */
508 | public function detach_disk($server, $target) {
509 | if(!$this->conn) {
510 | throw new NoConnectionException();
511 | }
512 | return $this->runCommand("virsh detach-disk {$server} --target {$target}");
513 | }
514 |
515 | /**
516 | *
517 | * attach_iso 挂载 ISO 到虚拟机
518 | *
519 | * @param $server 虚拟机名称
520 | * @param $name ISO 文件名
521 | * @return String 执行结果
522 | *
523 | */
524 | public function attach_iso($server, $name) {
525 | if(!$this->conn) {
526 | throw new NoConnectionException();
527 | }
528 | return $this->runCommand("virsh attach-disk {$server} {$name} hdb --type cdrom --mode readonly");
529 | }
530 |
531 | /**
532 | *
533 | * detach_iso 卸载虚拟机 ISO
534 | *
535 | * @param $server 虚拟机名称
536 | * @return String 执行结果
537 | *
538 | */
539 | public function detach_iso($server) {
540 | if(!$this->conn) {
541 | throw new NoConnectionException();
542 | }
543 | return $this->runCommand("virsh attach-disk {$server} \"\" hdb --type cdrom --mode readonly");
544 | }
545 |
546 | /**
547 | *
548 | * setNetwork 控制虚拟机网卡
549 | *
550 | * @param $server 虚拟机名称
551 | * @param $name 网卡名称
552 | * @param $status 启用或禁用网卡 true / false
553 | * @return String 执行结果
554 | *
555 | */
556 | public function setNetwork($server, $name, $status = true) {
557 | if(!$this->conn) {
558 | throw new NoConnectionException();
559 | }
560 | $status = $status === true ? 'up' : 'down';
561 | return $this->runCommand("virsh domif-setlink {$server} {$name} {$status}");
562 | }
563 |
564 | /**
565 | *
566 | * getNetwork 获取虚拟机网卡列表
567 | *
568 | * @param $server 虚拟机名称
569 | * @return Array 虚拟机网卡列表数组
570 | *
571 | */
572 | public function getNetwork($server) {
573 | if(!$this->conn) {
574 | throw new NoConnectionException();
575 | }
576 | $list = $this->runCommand("virsh domiflist {$server}");
577 | $line = explode("\n", $list);
578 | $data = Array();
579 | $s = 0;
580 | for($i = 2; $i < count($line); $i++) {
581 | $exp = explode(" ", $line[$i]);
582 | $t = 0;
583 | foreach($exp as $item) {
584 | if($item !== "") {
585 | switch($t) {
586 | case 0:
587 | $data[$s]['Interface'] = $item;
588 | break;
589 | case 1:
590 | $data[$s]['Type'] = $item;
591 | break;
592 | case 2:
593 | $data[$s]['Source'] = $item;
594 | break;
595 | case 3:
596 | $data[$s]['Model'] = $item;
597 | break;
598 | case 4:
599 | $data[$s]['MAC'] = $item;
600 | break;
601 | }
602 | $t++;
603 | }
604 | }
605 | $s++;
606 | }
607 | return $data;
608 | }
609 |
610 | /**
611 | *
612 | * setPermission 设置虚拟机配置文件以及镜像权限
613 | *
614 | * @param $name 虚拟机名称
615 | * @return String 执行结果
616 | *
617 | */
618 | public function setPermission($name) {
619 | $data = $this->runCommand("chmod -R 777 " . $this->libpath . "images/{$name}/");
620 | $data = $this->runCommand("chmod -R 777 " . $this->libpath . "{$name}.xml");
621 | return $data;
622 | }
623 |
624 | /**
625 | *
626 | * randomMac 生成随机网卡 MAC 地址
627 | *
628 | * @return String 网卡 MAC 地址
629 | *
630 | */
631 | public function randomMac() {
632 | return "0e:37:6a:" . implode(':', str_split(substr(md5(mt_rand()), 0, 6), 2));
633 | }
634 |
635 | /**
636 | *
637 | * changeBoot 修改指定虚拟机的启动设备
638 | *
639 | * @param $server 虚拟机名称
640 | * @param $device 设备类型
641 | *
642 | */
643 | public function changeBoot($server, $device = "") {
644 | $data = @file_get_contents($this->libpath . "/{$server}.xml");
645 | if(empty($data)) {
646 | return "";
647 | }
648 | if($device == "") {
649 | $device = "hd";
650 | }
651 | $dom = new DOMDocument();
652 | $dom->loadXML($data);
653 | $domain = $dom->documentElement;
654 | $os = $domain->getElementsByTagName('os')->item(0);
655 | $oldboot = $os->getElementsByTagName("boot");
656 | foreach($oldboot as $item) {
657 | $os->removeChild($item);
658 | }
659 | $boot = $dom->createElement("boot");
660 | $boot->setAttribute('dev', $device);
661 | $os->appendChild($boot);
662 | $data = $dom->saveXML($dom->documentElement);
663 | // 不知道为啥要两次
664 | $dom->loadXML($data);
665 | $domain = $dom->documentElement;
666 | $os = $domain->getElementsByTagName('os')->item(0);
667 | $oldboot = $os->getElementsByTagName("boot");
668 | foreach($oldboot as $item) {
669 | $os->removeChild($item);
670 | }
671 | $boot = $dom->createElement("boot");
672 | $boot->setAttribute('dev', $device);
673 | $os->appendChild($boot);
674 | $data = $dom->saveXML($dom->documentElement);
675 | @file_put_contents(__DIR__ . "/{$server}.xml", $data);
676 | $this->uploadFile(__DIR__ . "/{$server}.xml", $this->libpath . "/{$server}.xml");
677 | @unlink(__DIR__ . "/{$server}.xml");
678 | }
679 |
680 | /**
681 | *
682 | * changeBandwidth 修改指定虚拟机的最大带宽速率
683 | *
684 | * @param $server 虚拟机名称
685 | * @param $inbound 最大下行速率
686 | * @param $outbound 最大上行速率
687 | *
688 | */
689 | public function changeBandwidth($server, $in = 0, $out = 0) {
690 | $data = @file_get_contents($this->libpath . "/{$server}.xml");
691 | if(empty($data)) {
692 | return "";
693 | }
694 | $dom = new DOMDocument();
695 | $dom->loadXML($data);
696 | $domain = $dom->documentElement;
697 | $devices = $domain->getElementsByTagName('devices')->item(0);
698 | $interface = $devices->getElementsByTagName('interface')->item(0);
699 | $bandwidth = $interface->getElementsByTagName('bandwidth')->item(0);
700 | $inbound = $bandwidth->getElementsByTagName('inbound')->item(0);
701 | $outbound = $bandwidth->getElementsByTagName('outbound')->item(0);
702 | $inbound->setAttribute("average", $in);
703 | $outbound->setAttribute("average", $out);
704 | $data = $dom->saveXML($dom->documentElement);
705 | @file_put_contents(__DIR__ . "/{$server}.xml", $data);
706 | $this->uploadFile(__DIR__ . "/{$server}.xml", $this->libpath . "/{$server}.xml");
707 | @unlink(__DIR__ . "/{$server}.xml");
708 | }
709 |
710 | /**
711 | *
712 | * uploadFile 将本地文件上传到服务器
713 | *
714 | * @param $local 本地文件和路径
715 | * @param $remote 远程文件和路径
716 | *
717 | */
718 | public function uploadFile($local, $remote) {
719 | $sftp = ssh2_sftp($this->conn);
720 | $stream = @fopen("ssh2.sftp://{$sftp}{$remote}", 'w');
721 | if (!$stream) {
722 | throw new Exception("Could not open file: {$remote}");
723 | }
724 | $data = @file_get_contents($local);
725 | if ($data === false) {
726 | throw new Exception("Could not open local file: {$local}");
727 | }
728 | if (@fwrite($stream, $data) === false) {
729 | throw new Exception("Could not send data from file: {$local}");
730 | }
731 | @fclose($stream);
732 | }
733 |
734 | /**
735 | *
736 | * downloadFile 将远程文件下传到本地
737 | *
738 | * @param $remote 远程文件和路径
739 | * @param $local 本地文件和路径
740 | *
741 | */
742 | public function downloadFile($remote, $local) {
743 | $sftp = ssh2_sftp($this->conn);
744 | copy("ssh2.sftp://{$sftp}{$remote}", $local);
745 | }
746 | }
747 |
748 | class HostUndefineException extends \Exception {
749 |
750 | public function __toString() {
751 | return "Error: You must set a host before use method connect() in " . __FILE__ . ":" . __LINE__;
752 | }
753 | }
754 |
755 | class LoginFailedException extends \Exception {
756 |
757 | public function __toString() {
758 | return "Error: Failed login to ssh server in " . __FILE__ . ":" . __LINE__;
759 | }
760 | }
761 |
762 | class NoConnectionException extends \Exception {
763 |
764 | public function __toString() {
765 | return "Error: You must connect a host before use this method in " . __FILE__ . ":" . __LINE__;
766 | }
767 | }
768 |
--------------------------------------------------------------------------------