GVirConfigDomain

GVirConfigDomain

Synopsis

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);
guint64             gvir_config_domain_get_vcpus        (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_vcpus        (GVirConfigDomain *domain,
                                                         guint64 vcpu_count);
void                gvir_config_domain_set_virt_type    (GVirConfigDomain *domain,
                                                         GVirConfigDomainVirtType type);

Object Hierarchy

  GObject
   +----GVirConfigObject
         +----GVirConfigDomain

Properties

  "description"              gchar*                : Read / Write
  "features"                 GStrv                 : Read / Write
  "memory"                   guint64               : Read / Write
  "name"                     gchar*                : Read / Write
  "vcpu"                     guint64               : Read / Write

Description

Details

struct GVirConfigDomain

struct GVirConfigDomain;

struct GVirConfigDomainClass

struct GVirConfigDomainClass {
    GVirConfigObjectClass parent_class;

    gpointer padding[20];
};

enum GVirConfigDomainLifecycleAction

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;

enum GVirConfigDomainLifecycleEvent

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;

enum GVirConfigDomainVirtType

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;

gvir_config_domain_add_device ()

void                gvir_config_domain_add_device       (GVirConfigDomain *domain,
                                                         GVirConfigDomainDevice *device);

gvir_config_domain_get_custom_xml ()

gchar *             gvir_config_domain_get_custom_xml   (GVirConfigDomain *domain,
                                                         const gchar *ns_uri);

gvir_config_domain_get_description ()

const char *        gvir_config_domain_get_description  (GVirConfigDomain *domain);

gvir_config_domain_get_devices ()

GList *             gvir_config_domain_get_devices      (GVirConfigDomain *domain);

Gets the list of devices attached to domain

Returns :

a newly allocated GList of GVirConfigDomainDevice. [element-type LibvirtGConfig.DomainDevice][transfer full]

gvir_config_domain_get_features ()

GStrv               gvir_config_domain_get_features     (GVirConfigDomain *domain);

gvir_config_domain_get_memory ()

guint64             gvir_config_domain_get_memory       (GVirConfigDomain *domain);

domain :

A domain configuration object.

Returns :

amount of RAM in kilobytes (i.e. blocks of 1024 bytes).

gvir_config_domain_get_name ()

const char *        gvir_config_domain_get_name         (GVirConfigDomain *domain);

gvir_config_domain_get_vcpus ()

guint64             gvir_config_domain_get_vcpus        (GVirConfigDomain *domain);

gvir_config_domain_new ()

GVirConfigDomain *  gvir_config_domain_new              (void);

gvir_config_domain_new_from_xml ()

GVirConfigDomain *  gvir_config_domain_new_from_xml     (const gchar *xml,
                                                         GError **error);

gvir_config_domain_set_clock ()

void                gvir_config_domain_set_clock        (GVirConfigDomain *domain,
                                                         GVirConfigDomainClock *klock);

gvir_config_domain_set_custom_xml ()

gboolean            gvir_config_domain_set_custom_xml   (GVirConfigDomain *domain,
                                                         const gchar *xml,
                                                         const gchar *ns,
                                                         const gchar *ns_uri,
                                                         GError **error);

gvir_config_domain_set_description ()

void                gvir_config_domain_set_description  (GVirConfigDomain *domain,
                                                         const char *description);

gvir_config_domain_set_devices ()

void                gvir_config_domain_set_devices      (GVirConfigDomain *domain,
                                                         GList *devices);

devices :

. [in][element-type LibvirtGConfig.DomainDevice]

gvir_config_domain_set_features ()

void                gvir_config_domain_set_features     (GVirConfigDomain *domain,
                                                         const GStrv features);

gvir_config_domain_set_lifecycle ()

void                gvir_config_domain_set_lifecycle    (GVirConfigDomain *domain,
                                                         GVirConfigDomainLifecycleEvent event,
                                                         GVirConfigDomainLifecycleAction action);

gvir_config_domain_set_memory ()

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).

domain :

A domain configuration object.

memory :

The amount of RAM in kilobytes.

gvir_config_domain_set_name ()

void                gvir_config_domain_set_name         (GVirConfigDomain *domain,
                                                         const char *name);

gvir_config_domain_set_os ()

void                gvir_config_domain_set_os           (GVirConfigDomain *domain,
                                                         GVirConfigDomainOs *os);

gvir_config_domain_set_seclabel ()

void                gvir_config_domain_set_seclabel     (GVirConfigDomain *domain,
                                                         GVirConfigDomainSeclabel *seclabel);

gvir_config_domain_set_vcpus ()

void                gvir_config_domain_set_vcpus        (GVirConfigDomain *domain,
                                                         guint64 vcpu_count);

gvir_config_domain_set_virt_type ()

void                gvir_config_domain_set_virt_type    (GVirConfigDomain *domain,
                                                         GVirConfigDomainVirtType type);

Property Details

The "description" property

  "description"              gchar*                : Read / Write

Some human readable description (could be anything).

Default value: NULL


The "features" property

  "features"                 GStrv                 : Read / Write

Hypervisor Features.


The "memory" property

  "memory"                   guint64               : Read / Write

Maximum Guest Memory (in kilobytes).

Default value: 0


The "name" property

  "name"                     gchar*                : Read / Write

Domain Name.

Default value: NULL


The "vcpu" property

  "vcpu"                     guint64               : Read / Write

Maximum Number of Guest Virtual CPUs.

Default value: 1