org.libvirt
public class StoragePool extends Object
Field Summary | |
---|---|
protected Libvirt | libvirt
the libvirt instance |
protected Connect | virConnect
The VirConnect Object that represents the Hypervisor of this Domain |
protected StoragePoolPointer | VSPP
the native virStoragePoolPtr. |
Method Summary | |
---|---|
void | build(int flags)
Build the underlying storage pool
|
void | create(int flags)
Starts this inactive storage pool
|
void | delete(int flags)
Delete the underlying pool resources. |
void | destroy()
Destroy an active storage pool. |
int | free()
Free a storage pool object, releasing all memory associated with it. |
boolean | getAutostart()
Fetches the value of the autostart flag, which determines whether the
pool is automatically started at boot time
|
Connect | getConnect()
Provides the connection pointer associated with a storage pool.
|
StoragePoolInfo | getInfo()
Get volatile information about the storage pool such as free space /
usage summary
|
String | getName()
Fetch the locally unique name of the storage pool
|
int[] | getUUID()
Fetch the globally unique ID of this storage pool
|
String | getUUIDString()
Fetch the globally unique ID of the storage pool as a string
|
String | getXMLDesc(int flags)
Fetch an XML document describing all aspects of the storage pool. |
int | isActive()
Determine if the storage pool is currently running
|
int | isPersistent()
Determine if the storage pool has a persistent configuration which means
it will still exist after shutting down
|
String[] | listVolumes()
Fetch list of storage volume names
|
int | numOfVolumes()
Fetch the number of storage volumes within a pool
|
protected void | processError() |
void | refresh(int flags)
Request that the pool refresh its list of volumes. |
void | setAutostart(int autostart)
Sets the autostart flag
|
StorageVol | storageVolCreateXML(String xmlDesc, int flags)
Create a storage volume within a pool based on an XML description. |
StorageVol | storageVolCreateXMLFrom(String xmlDesc, StorageVol cloneVolume, int flags)
Create a storage volume in the parent pool, using the 'clonevol' volume
as input. |
StorageVol | storageVolLookupByName(String name)
Fetch an object representing to a storage volume based on its name within
a pool
|
void | undefine()
Undefine an inactive storage pool
|
Parameters: flags future flags, use 0 for now
Parameters: flags future flags, use 0 for now
Parameters: flags flags for obliteration process
Returns: number of references left (>= 0) for success, -1 for failure.
Throws: LibvirtException
Returns: the result
Throws: LibvirtException
Returns: the Connect object
Returns: a StoragePoolInfo object describing this storage pool
Throws: LibvirtException
Returns: the name
Throws: LibvirtException
Returns: the UUID as an unpacked int array
Throws: LibvirtException
Returns: the UUID in canonical String format
Throws: LibvirtException
Parameters: flags flags for XML format options (set of virDomainXMLFlags)
Returns: a XML document -java @throws LibvirtException
Returns: 1 if running, 0 if inactive, -1 on error
Throws: LibvirtException
See Also: Libvirt
Documentation
Returns: 1 if persistent, 0 if transient, -1 on error
Throws: LibvirtException
See Also: Libvirt
Documentation
Returns: an Array of Strings that contains the names of the storage volumes
Throws: LibvirtException
Returns: the number of storage pools
Throws: LibvirtException
Parameters: flags flags to control refresh behaviour (currently unused, use 0)
Throws: LibvirtException
Parameters: autostart new flag setting
Throws: LibvirtException
Parameters: xmlDesc description of volume to create flags flags for creation (unused, pass 0)
Returns: the storage volume
Throws: LibvirtException
Returns:
Throws: LibvirtException
Parameters: name name of storage volume
Returns: The StorageVol object found
Throws: LibvirtException
Throws: LibvirtException