mirror of
https://github.com/php/pecl-virtualization-libvirt.git
synced 2026-03-26 16:22:06 +01:00
90 lines
4.5 KiB
HTML
90 lines
4.5 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
<title>Launch a defined domain.</title>
|
|
</head>
|
|
<body><div class="manualnavbar" style="text-align: center;">
|
|
<div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-domain-create-xml.html">libvirt_domain_create_xml</a></div>
|
|
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-domain-define-xml.html">libvirt_domain_define_xml</a></div>
|
|
<div class="up"><a href="ref.libvirt.html">Libvirt Functions</a></div>
|
|
<div class="home"><a href="index.html">PHP Manual</a></div>
|
|
</div><hr /><div id="function.libvirt-domain-create" class="refentry">
|
|
<div class="refnamediv">
|
|
<h1 class="refname">libvirt_domain_create</h1>
|
|
<p class="verinfo">(php-libvirt 0.1)</p><p class="refpurpose"><span class="refname">libvirt_domain_create</span> — <span class="dc-title">Launch a defined domain.</span></p>
|
|
|
|
</div>
|
|
|
|
<a name="function.libvirt-domain-create.description"></a><div class="refsect1 description">
|
|
<h3 class="title">Description</h3>
|
|
<div class="methodsynopsis dc-description">
|
|
<span class="type">bool</span> <span class="methodname"><b>libvirt_domain_create</b></span>
|
|
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$domain</tt></span>
|
|
)</div>
|
|
|
|
<p class="para rdfs-comment">
|
|
Launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<a name="function.libvirt-domain-create.parameters"></a><div class="refsect1 parameters">
|
|
<h3 class="title">Parameters</h3>
|
|
<p class="para">
|
|
</p><dl>
|
|
|
|
<dt class="varlistentry">
|
|
|
|
<span class="term"><i><tt class="parameter">domain</tt></i>
|
|
</span>
|
|
|
|
</dt><dd class="listitem">
|
|
|
|
<p class="para">
|
|
Domain resource of domain to be launched. You can get domain resource using various functions (i.e. <a href="function.libvirt-domain-lookup-by-uuid.html" class="function">libvirt_domain_lookup_by_uuid()</a> or <a href="function.libvirt-list-domains.html" class="function">libvirt_list_domains()</a>).
|
|
</p>
|
|
</dd>
|
|
|
|
|
|
</dl>
|
|
<p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
<a name="function.libvirt-domain-create.returnvalues"></a><div class="refsect1 returnvalues">
|
|
<h3 class="title">Return Values</h3>
|
|
|
|
<p class="para">
|
|
<b><tt class="constant">TRUE</tt></b> on success and <b><tt class="constant">FALSE</tt></b> on failure
|
|
</p>
|
|
</div>
|
|
|
|
|
|
|
|
<a name="function.libvirt-domain-create.seealso"></a><div class="refsect1 seealso">
|
|
<h3 class="title">See Also</h3>
|
|
<p class="para">
|
|
</p><ul class="simplelist">
|
|
<li class="member"><a href="function.libvirt-list-domains.html" class="function" rel="rdfs-seeAlso">libvirt_list_domains()</a> - List all domains</li>
|
|
<li class="member"><a href="function.libvirt-domain-lookup-by-uuid.html" class="function" rel="rdfs-seeAlso">libvirt_domain_lookup_by_uuid()</a> - Try to look up a domain by its UUID (binary)</li>
|
|
<li class="member"><a href="function.libvirt-domain-lookup-by-uuid-string.html" class="function" rel="rdfs-seeAlso">libvirt_domain_lookup_by_uuid_string()</a> - Try to look up a domain by its UUID (textual)</li>
|
|
<li class="member"><a href="function.libvirt-domain-lookup-by-id.html" class="function" rel="rdfs-seeAlso">libvirt_domain_lookup_by_id()</a> - Try to look up a domain based on the hypervisor ID number</li>
|
|
<li class="member"><a href="function.libvirt-domain-lookup-by-name.html" class="function" rel="rdfs-seeAlso">libvirt_domain_lookup_by_name()</a> - Try to look up a domain by its name.</li>
|
|
<li class="member"><a href="function.libvirt-domain-create-xml.html" class="function" rel="rdfs-seeAlso">libvirt_domain_create_xml()</a> - Launch a new guest domain, based on an XML description</li>
|
|
<li class="member"><a href="function.libvirt-domain-define-xml.html" class="function" rel="rdfs-seeAlso">libvirt_domain_define_xml()</a> - Define a domain, but does not start it.</li>
|
|
</ul><p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
</div><hr /><div class="manualnavbar" style="text-align: center;">
|
|
<div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-domain-create-xml.html">libvirt_domain_create_xml</a></div>
|
|
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-domain-define-xml.html">libvirt_domain_define_xml</a></div>
|
|
<div class="up"><a href="ref.libvirt.html">Libvirt Functions</a></div>
|
|
<div class="home"><a href="index.html">PHP Manual</a></div>
|
|
</div></body></html>
|