File: function.libvirt-domain-shutdown.html

package info (click to toggle)
libvirt-php 0.5.2~30-g64dca6f-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 4,460 kB
  • ctags: 5,538
  • sloc: cpp: 11,159; ansic: 8,250; xml: 3,999; php: 1,604; sh: 580; makefile: 189; perl: 97
file content (86 lines) | stat: -rw-r--r-- 3,948 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<!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>Shutdown a 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-resume.html">libvirt_domain_resume</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.libvirt-domain-suspend.html">libvirt_domain_suspend</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-shutdown" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">libvirt_domain_shutdown</h1>
  <p class="verinfo">(php-libvirt 0.1)</p><p class="refpurpose"><span class="refname">libvirt_domain_shutdown</span> &mdash; <span class="dc-title">Shutdown a domain</span></p>

 </div>

 <a name="function.libvirt-domain-shutdown.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_shutdown</b></span>
    ( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$domain</tt></span>
   )</div>

  <p class="para rdfs-comment">
   Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. 
  </p>

 </div>


 <a name="function.libvirt-domain-shutdown.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 shutdown.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-shutdown.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-shutdown.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-domain-reboot.html" class="function" rel="rdfs-seeAlso">libvirt_domain_reboot()</a> - Reboot a domain</li>
    <li class="member"><a href="function.libvirt-domain-resume.html" class="function" rel="rdfs-seeAlso">libvirt_domain_resume()</a> - Resume an suspended domain</li>
    <li class="member"><a href="function.libvirt-domain-suspend.html" class="function" rel="rdfs-seeAlso">libvirt_domain_suspend()</a> - Suspend a domain</li>
    <li class="member"><a href="function.libvirt-domain-create.html" class="function" rel="rdfs-seeAlso">libvirt_domain_create()</a> - Launch a defined domain.</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-resume.html">libvirt_domain_resume</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.libvirt-domain-suspend.html">libvirt_domain_suspend</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>