LibvirtGObject.StoragePool¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`build` (flags)
	`build_async` (flags, cancellable, callback, *user_data)
	`build_finish` (result)
	`create_volume` (conf)
	`delete` (flags)
	`delete_async` (flags, cancellable, callback, *user_data)
	`delete_finish` (result)
	`get_active` ()
	`get_autostart` ()
	`get_config` (flags)
	`get_info` ()
	`get_name` ()
	`get_persistent` ()
	`get_uuid` ()
	`get_volume` (name)
	`get_volumes` ()
	`refresh` (cancellable)
	`refresh_async` (cancellable, callback, *user_data)
	`refresh_finish` (result)
	`set_autostart` (autostart)
	`start` (flags)
	`start_async` (flags, cancellable, callback, *user_data)
	`start_finish` (result)
	`stop` ()
	`stop_async` (cancellable, callback, *user_data)
	`stop_finish` (result)
	`undefine` ()
	`undefine_async` (cancellable, callback, *user_data)
	`undefine_finish` (result)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`handle`		r/w/co	The storage_pool handle

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class LibvirtGObject.StoragePool(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: LibvirtGObject.StoragePoolClass

build(flags)¶

Parameters:: flags (int) – the flags
Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

build_async(flags, cancellable, callback, *user_data)¶

Parameters:

flags (int) – the flags
cancellable (Gio.Cancellable or None) – cancellation object
callback (Gio.AsyncReadyCallback or None) – completion callback
user_data (object or None) – opaque data for callback

build_finish(result)¶

Parameters:: result (Gio.AsyncResult) – async method result
Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

create_volume(conf)¶

Parameters:: conf (LibvirtGConfig.StorageVol) – the configuration for the new volume
Raises:: GLib.Error
Returns:: the newly created volume. The returned object should be unreffed with GObject.Object.unref() when no longer needed.
Return type:: LibvirtGObject.StorageVol

delete(flags)¶

Parameters:: flags (int) – the flags
Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

delete_async(flags, cancellable, callback, *user_data)¶

Parameters:

flags (int) – the flags
cancellable (Gio.Cancellable or None) – cancellation object
callback (Gio.AsyncReadyCallback or None) – completion callback
user_data (object or None) – opaque data for callback

delete_finish(result)¶

Parameters:: result (Gio.AsyncResult) – async method result
Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

get_active()¶

Return type:: bool

get_autostart()¶

Raises:: GLib.Error
Returns:: #True if autostart is enabled, #False otherwise.
Return type:: bool

get_config(flags)¶

Parameters:: flags (int) – the flags
Raises:: GLib.Error
Returns:: the config. The returned object should be unreffed with GObject.Object.unref() when no longer needed.
Return type:: LibvirtGConfig.StoragePool

get_info()¶

Raises:: GLib.Error
Returns:: the info. The returned pointer should be freed using GObject.boxed_free() when no longer needed.
Return type:: LibvirtGObject.StoragePoolInfo

get_name()¶

Return type:: str

get_persistent()¶

Return type:: bool

get_uuid()¶

Return type:: str

get_volume(name)¶

Parameters:: name (str) – Name of the requested storage volume
Returns:: the LibvirtGObject.StorageVol, or None. The returned object should be unreffed with GObject.Object.unref() when no longer needed.
Return type:: LibvirtGObject.StorageVol

get_volumes()¶

Returns:: List of LibvirtGObject.StorageVol. The returned list should be freed with g_list_free(), after its elements have been unreffed with GObject.Object.unref().
Return type:: [LibvirtGObject.StorageVol]

refresh(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – cancellation object
Raises:: GLib.Error
Return type:: bool

refresh_async(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – cancellation object
callback (Gio.AsyncReadyCallback or None) – completion callback
user_data (object or None) – opaque data for callback

refresh_finish(result)¶

Parameters:: result (Gio.AsyncResult) – async method result
Raises:: GLib.Error
Return type:: bool

set_autostart(autostart)¶

Parameters:: autostart (bool) – Whether or not to autostart
Raises:: GLib.Error
Returns:: True on success, False otherwise.
Return type:: bool

Sets whether or not storage pool self is started automatically on boot.

start(flags)¶

Parameters:: flags (int) – the flags
Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

start_async(flags, cancellable, callback, *user_data)¶

Parameters:

flags (int) – the flags
cancellable (Gio.Cancellable or None) – cancellation object
callback (Gio.AsyncReadyCallback or None) – completion callback
user_data (object or None) – opaque data for callback

start_finish(result)¶

Parameters:: result (Gio.AsyncResult) – async method result
Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

stop()¶

Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

stop_async(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – cancellation object
callback (Gio.AsyncReadyCallback or None) – completion callback
user_data (object or None) – opaque data for callback

stop_finish(result)¶

Parameters:: result (Gio.AsyncResult) – async method result
Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

undefine()¶

Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

undefine_async(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – cancellation object
callback (Gio.AsyncReadyCallback or None) – completion callback
user_data (object or None) – opaque data for callback

undefine_finish(result)¶

Parameters:: result (Gio.AsyncResult) – async method result
Raises:: GLib.Error
Returns:: #True on success, #False otherwise.
Return type:: bool

Property Details¶

LibvirtGObject.StoragePool.props.handle¶

Name:: handle
Type:
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The storage_pool handle