Top | ![]() |
![]() |
![]() |
![]() |
enum | GVirDomainState |
enum | GVirDomainStartFlags |
enum | GVirDomainDeleteFlags |
enum | GVirDomainXMLFlags |
enum | GVirDomainShutdownFlags |
enum | GVirDomainSnapshotCreateFlags |
enum | GVirDomainUpdateDeviceFlags |
enum | GVirDomainRebootFlags |
enum | GVirDomainSnapshotListFlags |
void gvir_domain_start_async (GVirDomain *dom
,guint flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronous variant of gvir_domain_start.
gboolean gvir_domain_start_finish (GVirDomain *dom
,GAsyncResult *result
,GError **err
);
void gvir_domain_resume_async (GVirDomain *dom
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronous variant of gvir_domain_resume.
gboolean gvir_domain_resume_finish (GVirDomain *dom
,GAsyncResult *result
,GError **err
);
void gvir_domain_wakeup_async (GVirDomain *dom
,guint flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronous variant of gvir_domain_wakeup.
gboolean gvir_domain_wakeup_finish (GVirDomain *dom
,GAsyncResult *result
,GError **err
);
gboolean gvir_domain_save_to_file (GVirDomain *dom
,gchar *filename
,GVirConfigDomain *custom_conf
,guint flags
,GError **err
);
void gvir_domain_save_to_file_async (GVirDomain *dom
,gchar *filename
,GVirConfigDomain *custom_conf
,guint flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronous variant of gvir_domain_save_to_file
gboolean gvir_domain_save_to_file_finish (GVirDomain *dom
,GAsyncResult *result
,GError **err
);
Finishes the operation started by gvir_domain_save_to_file_async.
void gvir_domain_get_info_async (GVirDomain *dom
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronous variant of gvir_domain_get_info.
GVirDomainInfo * gvir_domain_get_info_finish (GVirDomain *dom
,GAsyncResult *result
,GError **err
);
Finishes the operation started by gvir_domain_get_info_async.
GVirConfigDomain * gvir_domain_get_config (GVirDomain *dom
,guint flags
,GError **err
);
gboolean gvir_domain_set_config (GVirDomain *domain
,GVirConfigDomain *conf
,GError **err
);
Resets configuration of an existing domain.
Note: If domain is already running, the new configuration will not take affect until domain reboots.
gchar * gvir_domain_screenshot (GVirDomain *dom
,GVirStream *stream
,guint monitor_id
,guint flags
,GError **err
);
gboolean gvir_domain_open_console (GVirDomain *dom
,GVirStream *stream
,const gchar *devname
,guint flags
,GError **err
);
Open a text console for the domain dom
, connecting it to the
stream stream
. If devname
is NULL, the default console will
be opened, otherwise devname
can be used to specify a non-default
console device.
gboolean gvir_domain_open_graphics (GVirDomain *dom
,guint idx
,int fd
,unsigned int flags
,GError **err
);
Open a connection to the local graphics display, connecting it to the
socket pair file descriptor passed in as fd
.
int gvir_domain_open_graphics_fd (GVirDomain *dom
,guint idx
,unsigned int flags
,GError **err
);
This will create a socket pair connected to the graphics backend of dom
. One
end of the socket will be returned on success, and the other end is handed to
the hypervisor. If dom
has multiple graphics backends configured, then idx
will determine which one is opened, starting from idx
0.
Since: 0.2.0
gboolean gvir_domain_suspend (GVirDomain *dom
,GError **err
);
Suspends an active domain, the process is frozen without further access to
CPU resources and I/O but the memory used by the domain at the hypervisor
level will stay allocated. Use gvir_domain_resume()
to reactivate the domain.
gboolean gvir_domain_save (GVirDomain *dom
,unsigned int flags
,GError **err
);
Saves the state of the domain on disk and stops it. Use gvir_domain_start to restore the saved state of the domain. A saved domain can be restored even after shutdown/reboot of host machine.
void gvir_domain_save_async (GVirDomain *dom
,unsigned int flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronous variant of gvir_domain_save.
gboolean gvir_domain_save_finish (GVirDomain *dom
,GAsyncResult *result
,GError **err
);
Finishes the operation started by gvir_domain_save_async.
gboolean
gvir_domain_get_saved (GVirDomain *dom
);
TRUE if a stopped domain has a saved state to which it can be restored to using gvir_domain_start, FALSE otherwise.
GList * gvir_domain_get_devices (GVirDomain *domain
,GError **err
);
Gets the list of devices attached to domain
. The returned list should
be freed with g_list_free()
, after its elements have been unreffed with
g_object_unref()
.
gboolean gvir_domain_update_device (GVirDomain *dom
,GVirConfigDomainDevice *device
,guint flags
,GError **err
);
Update the configuration of a device.
dom |
the domain |
|
device |
A modified device config |
|
flags |
bitwise-OR of GVirDomainUpdateDeviceFlags |
|
err |
Place-holder for error or NULL. |
[allow-none] |
GVirDomainSnapshot * gvir_domain_create_snapshot (GVirDomain *dom
,GVirConfigDomainSnapshot *custom_conf
,guint flags
,GError **err
);
dom |
the domain |
|
custom_conf |
configuration of snapshot or NULL. |
[allow-none] |
flags |
bitwise-OR of GVirDomainSnapshotCreateFlags |
|
err |
Place-holder for error or NULL. |
[allow-none] |
void gvir_domain_create_snapshot_async (GVirDomain *dom
,GVirConfigDomainSnapshot *custom_conf
,guint flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
dom |
The GVirDomain |
|
custom_conf |
Configuration of snapshot or |
[allow-none] |
flags |
Bitwise-OR of GVirDomainSnapshotCreateFlags |
|
cancellable |
cancellation object. |
[allow-none][transfer none] |
callback |
Completion callback. |
[scope async] |
user_data |
Opaque data for callback. |
[closure] |
GVirDomainSnapshot * gvir_domain_create_snapshot_finish (GVirDomain *domain
,GAsyncResult *result
,GError **error
);
gboolean gvir_domain_fetch_snapshots (GVirDomain *dom
,guint list_flags
,GCancellable *cancellable
,GError **error
);
dom |
The domain |
|
list_flags |
bitwise-OR of GVirDomainSnapshotListFlags |
|
cancellable |
cancellation object. |
[allow-none][transfer none] |
error |
Place-holder for error or |
[allow-none] |
void gvir_domain_fetch_snapshots_async (GVirDomain *dom
,guint list_flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
dom |
The domain |
|
list_flags |
bitwise-OR of GVirDomainSnapshotListFlags |
|
cancellable |
cancellation object. |
[allow-none][transfer none] |
callback |
completion callback. |
[scope async] |
user_data |
opaque data for callback. |
[closure] |
gboolean gvir_domain_fetch_snapshots_finish (GVirDomain *dom
,GAsyncResult *res
,GError **error
);
gboolean gvir_domain_get_has_current_snapshot (GVirDomain *dom
,guint flags
,gboolean *has_current_snapshot
,GError **error
);
gboolean gvir_domain_set_time (GVirDomain *dom
,GDateTime *date_time
,guint flags
,GError **err
);
This function tries to set guest time to the given value. The passed time must in UTC.
If date_time
is NULL
, the time is reset using the domain's RTC.
Please note that some hypervisors may require guest agent to be configured and running in order for this function to work.
void gvir_domain_set_time_async (GVirDomain *dom
,GDateTime *date_time
,guint flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronous variant of gvir_domain_set_time.
gboolean gvir_domain_set_time_finish (GVirDomain *dom
,GAsyncResult *result
,GError **err
);
Finishes the operation started by gvir_domain_set_time_async.
No flags |
||
Restore or alter metadata |
||
With redefine, make snapshot current |
||
Make snapshot without remembering it |
||
Stop running guest after snapshot |
||
Disk snapshot, not system checkpoint |
||
Reuse any existing external files |
||
Use guest agent to quiesce all mounter file systems within the domain |
||
Atomically avoid partial changes |
List all snapshots |
||
List all descendants, not just children, when listing a snapshot. For historical reasons, groups do not use contiguous bits. |
||
Filter by snapshots with no parents, when listing a domain |
||
Filter by snapshots which have metadata |
||
Filter by snapshots with no children |
||
Filter by snapshots that have children |
||
Filter by snapshots with no metadata |
||
Filter by snapshots taken while guest was shut off |
||
Filter by snapshots taken while guest was active, and with memory state |
||
Filter by snapshots taken while guest was active, but without memory state |
||
Filter by snapshots stored internal to disk images |
||
Filter by snapshots that use files external to disk images |
“handle”
property “handle” GVirDomainHandle *
The domain handle.
Owner: GVirDomain
Flags: Read / Write / Construct Only
“pmsuspended”
signalvoid user_function (GVirDomain *gvirdomain, gpointer user_data)
Flags: No Hooks
“resumed”
signalvoid user_function (GVirDomain *gvirdomain, gpointer user_data)
Flags: No Hooks
“started”
signalvoid user_function (GVirDomain *gvirdomain, gpointer user_data)
Flags: No Hooks
“stopped”
signalvoid user_function (GVirDomain *gvirdomain, gpointer user_data)
Flags: No Hooks
“suspended”
signalvoid user_function (GVirDomain *gvirdomain, gpointer user_data)
Flags: No Hooks
“updated”
signalvoid user_function (GVirDomain *gvirdomain, gpointer user_data)
Flags: No Hooks