File: libvirt-list-storagepools.xml

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 (113 lines) | stat: -rw-r--r-- 2,539 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.28 $ -->

<refentry xml:id="function.libvirt-list-storagepools" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>libvirt_list_storagepools</refname>
  <refpurpose>List all storagepools</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>libvirt_list_storagepools</methodname>
   <methodparam ><type>resource</type><parameter>connection</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function returns array of storagepool names for the connection resource.  
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
 <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       Connection resource of hypervisor. 
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <!-- See also &return.success; -->
  <para>
    Array of storagepool names. &false; on failure
  </para>
 </refsect1>

 

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>libvirt_list_storagepools</function> example</title>
    <para>
     List all storagepools
    </para>
    <programlisting role="php">
<![CDATA[
<?php

	$conn=libvirt_connect($uri,true);
	$pools=libvirt_list_storagepools($conn);

	var_dump($pools);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(2) {
  [0]=>
  string(7) "default"
  [1]=>
  string(4) "data"
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>libvirt_storagepool_lookup_by_name</function></member>
    <member><function>libvirt_storagepool_get_info</function></member>
    <member><function>libvirt_list_volumes</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->