| Libvirt-gconfig Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
struct GVirConfigDomain; struct GVirConfigDomainClass; enum GVirConfigDomainLifecycleAction; enum GVirConfigDomainLifecycleEvent; enum GVirConfigDomainVirtType; void gvir_config_domain_add_device (GVirConfigDomain *domain,GVirConfigDomainDevice *device); gchar * gvir_config_domain_get_custom_xml (GVirConfigDomain *domain,const gchar *ns_uri); const char * gvir_config_domain_get_description (GVirConfigDomain *domain); GList * gvir_config_domain_get_devices (GVirConfigDomain *domain); GStrv gvir_config_domain_get_features (GVirConfigDomain *domain); guint64 gvir_config_domain_get_memory (GVirConfigDomain *domain); const char * gvir_config_domain_get_name (GVirConfigDomain *domain); GVirConfigDomainOs * gvir_config_domain_get_os (GVirConfigDomain *domain); const char * gvir_config_domain_get_title (GVirConfigDomain *domain); guint64 gvir_config_domain_get_vcpus (GVirConfigDomain *domain); GVirConfigDomainVirtType gvir_config_domain_get_virt_type (GVirConfigDomain *domain); GVirConfigDomain * gvir_config_domain_new (void); GVirConfigDomain * gvir_config_domain_new_from_xml (const gchar *xml,GError **error); void gvir_config_domain_set_clock (GVirConfigDomain *domain,GVirConfigDomainClock *klock); gboolean gvir_config_domain_set_custom_xml (GVirConfigDomain *domain,const gchar *xml,const gchar *ns,const gchar *ns_uri,GError **error); void gvir_config_domain_set_description (GVirConfigDomain *domain,const char *description); void gvir_config_domain_set_devices (GVirConfigDomain *domain,GList *devices); void gvir_config_domain_set_features (GVirConfigDomain *domain,const GStrv features); void gvir_config_domain_set_lifecycle (GVirConfigDomain *domain,GVirConfigDomainLifecycleEvent event,GVirConfigDomainLifecycleAction action); void gvir_config_domain_set_memory (GVirConfigDomain *domain,guint64 memory); void gvir_config_domain_set_name (GVirConfigDomain *domain,const char *name); void gvir_config_domain_set_os (GVirConfigDomain *domain,GVirConfigDomainOs *os); void gvir_config_domain_set_seclabel (GVirConfigDomain *domain,GVirConfigDomainSeclabel *seclabel); void gvir_config_domain_set_title (GVirConfigDomain *domain,const char *title); void gvir_config_domain_set_vcpus (GVirConfigDomain *domain,guint64 vcpu_count); void gvir_config_domain_set_virt_type (GVirConfigDomain *domain,GVirConfigDomainVirtType type);
"description" gchar* : Read / Write "features" GStrv : Read / Write "memory" guint64 : Read / Write "name" gchar* : Read / Write "title" gchar* : Read / Write "vcpu" guint64 : Read / Write
struct GVirConfigDomainClass {
GVirConfigObjectClass parent_class;
gpointer padding[20];
};
typedef enum {
GVIR_CONFIG_DOMAIN_LIFECYCLE_DESTROY,
GVIR_CONFIG_DOMAIN_LIFECYCLE_RESTART,
GVIR_CONFIG_DOMAIN_LIFECYCLE_PRESERVE,
GVIR_CONFIG_DOMAIN_LIFECYCLE_RENAME_RESTART,
GVIR_CONFIG_DOMAIN_LIFECYCLE_COREDUMP_DESTROY,
GVIR_CONFIG_DOMAIN_LIFECYCLE_COREDUMP_RESTART
} GVirConfigDomainLifecycleAction;
typedef enum {
GVIR_CONFIG_DOMAIN_LIFECYCLE_ON_POWEROFF, /*< nick=on_poweroff >*/
GVIR_CONFIG_DOMAIN_LIFECYCLE_ON_REBOOT, /*< nick=on_reboot >*/
GVIR_CONFIG_DOMAIN_LIFECYCLE_ON_CRASH /*< nick=on_crash >*/
} GVirConfigDomainLifecycleEvent;
typedef enum {
GVIR_CONFIG_DOMAIN_VIRT_QEMU,
GVIR_CONFIG_DOMAIN_VIRT_KQEMU,
GVIR_CONFIG_DOMAIN_VIRT_KVM,
GVIR_CONFIG_DOMAIN_VIRT_XEN,
GVIR_CONFIG_DOMAIN_VIRT_LXC,
GVIR_CONFIG_DOMAIN_VIRT_UML,
GVIR_CONFIG_DOMAIN_VIRT_OPENVZ,
GVIR_CONFIG_DOMAIN_VIRT_VSERVER,
GVIR_CONFIG_DOMAIN_VIRT_LDOM,
GVIR_CONFIG_DOMAIN_VIRT_TEST,
GVIR_CONFIG_DOMAIN_VIRT_VMWARE,
GVIR_CONFIG_DOMAIN_VIRT_HYPERV,
GVIR_CONFIG_DOMAIN_VIRT_VBOX,
GVIR_CONFIG_DOMAIN_VIRT_ONE,
GVIR_CONFIG_DOMAIN_VIRT_PHYP
} GVirConfigDomainVirtType;
void gvir_config_domain_add_device (GVirConfigDomain *domain,GVirConfigDomainDevice *device);
gchar * gvir_config_domain_get_custom_xml (GVirConfigDomain *domain,const gchar *ns_uri);
const char * gvir_config_domain_get_description (GVirConfigDomain *domain);
GList * gvir_config_domain_get_devices (GVirConfigDomain *domain);
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().
|
a GVirConfigDomain |
Returns : |
a newly allocated GList of GVirConfigDomainDevice. [element-type LibvirtGConfig.DomainDevice][transfer full] |
GStrv gvir_config_domain_get_features (GVirConfigDomain *domain);
|
a GVirConfigDomain |
Returns : |
The returned list should be freed with
g_strfreev() when no longer needed. [transfer full]
|
guint64 gvir_config_domain_get_memory (GVirConfigDomain *domain);
|
a GVirConfigDomain |
Returns : |
amount of RAM in kilobytes (i.e. blocks of 1024 bytes). |
GVirConfigDomainOs * gvir_config_domain_get_os (GVirConfigDomain *domain);
Gets the operating system configuration of domain
|
a GVirConfigDomain |
Returns : |
A GVirConfigDomainOs. The returned
object should be unreffed with g_object_unref() when no longer needed. [transfer full]
|
const char * gvir_config_domain_get_title (GVirConfigDomain *domain);
GVirConfigDomainVirtType gvir_config_domain_get_virt_type
(GVirConfigDomain *domain);
GVirConfigDomain * gvir_config_domain_new_from_xml (const gchar *xml,GError **error);
void gvir_config_domain_set_clock (GVirConfigDomain *domain,GVirConfigDomainClock *klock);
|
a GVirConfigDomain |
|
. [allow-none] |
gboolean gvir_config_domain_set_custom_xml (GVirConfigDomain *domain,const gchar *xml,const gchar *ns,const gchar *ns_uri,GError **error);
void gvir_config_domain_set_description (GVirConfigDomain *domain,const char *description);
|
a GVirConfigDomain |
|
. [allow-none] |
void gvir_config_domain_set_devices (GVirConfigDomain *domain,GList *devices);
|
a GVirConfigDomain |
|
. [in][element-type LibvirtGConfig.DomainDevice] |
void gvir_config_domain_set_features (GVirConfigDomain *domain,const GStrv features);
void gvir_config_domain_set_lifecycle (GVirConfigDomain *domain,GVirConfigDomainLifecycleEvent event,GVirConfigDomainLifecycleAction action);
void gvir_config_domain_set_memory (GVirConfigDomain *domain,guint64 memory);
Sets the amount of RAM allocated to domain in kilobytes (i.e. blocks of 1024 bytes).
|
a GVirConfigDomain |
|
The amount of RAM in kilobytes. |
void gvir_config_domain_set_name (GVirConfigDomain *domain,const char *name);
|
a GVirConfigDomain |
|
. [allow-none] |
void gvir_config_domain_set_os (GVirConfigDomain *domain,GVirConfigDomainOs *os);
|
a GVirConfigDomain |
|
the os configuration to set. [allow-none] |
void gvir_config_domain_set_seclabel (GVirConfigDomain *domain,GVirConfigDomainSeclabel *seclabel);
|
a GVirConfigDomain |
|
the security label configuration to set. [allow-none] |
void gvir_config_domain_set_title (GVirConfigDomain *domain,const char *title);
Sets the title of the domain. This is an optional short textual description of the domain. Passing a NULL title
unsets the current domain title.
|
a GVirConfigDomain |
|
title of the domain. [allow-none] |
void gvir_config_domain_set_vcpus (GVirConfigDomain *domain,guint64 vcpu_count);
void gvir_config_domain_set_virt_type (GVirConfigDomain *domain,GVirConfigDomainVirtType type);
"description" property"description" gchar* : Read / Write
Some human readable description (could be anything).
Default value: NULL
"memory" property"memory" guint64 : Read / Write
Maximum Guest Memory (in kilobytes).
Default value: 0
"title" property"title" gchar* : Read / Write
A short description - title - of the domain.
Default value: NULL
"vcpu" property"vcpu" guint64 : Read / Write
Maximum Number of Guest Virtual CPUs.
Default value: 1