GVirDesignerDomain

GVirDesignerDomain

Synopsis

struct              GVirDesignerDomain;
struct              GVirDesignerDomainClass;
enum                GVirDesignerDomainResources;
GVirConfigDomainDisk * gvir_designer_domain_add_disk_device
                                                        (GVirDesignerDomain *design,
                                                         const char *devpath,
                                                         GError **error);
GVirConfigDomainDisk * gvir_designer_domain_add_disk_file
                                                        (GVirDesignerDomain *design,
                                                         const char *filepath,
                                                         const char *format,
                                                         GError **error);
GVirConfigDomainInterface * gvir_designer_domain_add_interface_network
                                                        (GVirDesignerDomain *design,
                                                         const char *network,
                                                         GError **error);
GVirConfigCapabilities * gvir_designer_domain_get_capabilities
                                                        (GVirDesignerDomain *design);
GVirConfigDomain *  gvir_designer_domain_get_config     (GVirDesignerDomain *design);
OsinfoOs *          gvir_designer_domain_get_os         (GVirDesignerDomain *design);
OsinfoPlatform *    gvir_designer_domain_get_platform   (GVirDesignerDomain *design);
GVirDesignerDomain * gvir_designer_domain_new           (OsinfoOs *os,
                                                         OsinfoPlatform *platform,
                                                         GVirConfigCapabilities *caps);
gboolean            gvir_designer_domain_setup_container
                                                        (GVirDesignerDomain *design,
                                                         GError **error);
gboolean            gvir_designer_domain_setup_container_full
                                                        (GVirDesignerDomain *design,
                                                         const char *arch,
                                                         GError **error);
gboolean            gvir_designer_domain_setup_machine  (GVirDesignerDomain *design,
                                                         GError **error);
gboolean            gvir_designer_domain_setup_machine_full
                                                        (GVirDesignerDomain *design,
                                                         const char *arch,
                                                         GVirConfigDomainOsType ostype,
                                                         GError **error);
gboolean            gvir_designer_domain_setup_resources
                                                        (GVirDesignerDomain *design,
                                                         GVirDesignerDomainResources req,
                                                         GError **error);
gboolean            gvir_designer_domain_supports_container
                                                        (GVirDesignerDomain *design);
gboolean            gvir_designer_domain_supports_container_full
                                                        (GVirDesignerDomain *design,
                                                         const char *arch);
gboolean            gvir_designer_domain_supports_machine
                                                        (GVirDesignerDomain *design);
gboolean            gvir_designer_domain_supports_machine_full
                                                        (GVirDesignerDomain *design,
                                                         const char *arch,
                                                         GVirConfigDomainOsType ostype);

Object Hierarchy

  GObject
   +----GVirDesignerDomain

Properties

  "capabilities"             GVirConfigCapabilities*  : Read / Write / Construct Only
  "config"                   GVirConfigDomain*     : Read
  "os"                       OsinfoOs*             : Read / Write / Construct Only
  "platform"                 OsinfoPlatform*       : Read / Write / Construct Only

Description

Details

struct GVirDesignerDomain

struct GVirDesignerDomain;

struct GVirDesignerDomainClass

struct GVirDesignerDomainClass {
    GObjectClass parent_class;

    gpointer padding[20];
};

enum GVirDesignerDomainResources

typedef enum {
    GVIR_DESIGNER_DOMAIN_RESOURCES_MINIMAL,
    GVIR_DESIGNER_DOMAIN_RESOURCES_RECOMMENDED,
} GVirDesignerDomainResources;

gvir_designer_domain_add_disk_device ()

GVirConfigDomainDisk * gvir_designer_domain_add_disk_device
                                                        (GVirDesignerDomain *design,
                                                         const char *devpath,
                                                         GError **error);

Add given device as a new disk to the domain designer instance.

design :

the domain designer instance. [transfer none]

devpath :

path to the device. [transfer none]

error :

return location for a GError, or NULL

Returns :

the pointer to the new disk. If something fails NULL is returned and error is set. [transfer none]

gvir_designer_domain_add_disk_file ()

GVirConfigDomainDisk * gvir_designer_domain_add_disk_file
                                                        (GVirDesignerDomain *design,
                                                         const char *filepath,
                                                         const char *format,
                                                         GError **error);

Add a new disk to the domain.

design :

the domain designer instance. [transfer none]

filepath :

the path to a file. [transfer none]

format :

disk format. [transfer none]

error :

return location for a GError, or NULL

Returns :

the pointer to new disk. If something fails NULL is returned and error is set. [transfer none]

gvir_designer_domain_add_interface_network ()

GVirConfigDomainInterface * gvir_designer_domain_add_interface_network
                                                        (GVirDesignerDomain *design,
                                                         const char *network,
                                                         GError **error);

Add new network interface card into design. The interface is of 'network' type with network used as the source network.

design :

the domain designer instance. [transfer none]

network :

network name. [transfer none]

error :

return location for a GError, or NULL

Returns :

the pointer to the new interface. [transfer none]

gvir_designer_domain_get_capabilities ()

GVirConfigCapabilities * gvir_designer_domain_get_capabilities
                                                        (GVirDesignerDomain *design);

Retrieves the capabilities object associated with the designer The object should not be modified by the caller.

design :

the domain designer instance. [transfer none]

Returns :

the capabilities. [transfer none]

gvir_designer_domain_get_config ()

GVirConfigDomain *  gvir_designer_domain_get_config     (GVirDesignerDomain *design);

Retrieves the domain config object associated with the designer The object may be modified by the caller at will, but should not be freed.

design :

the domain designer instance. [transfer none]

Returns :

the domain config. [transfer none]

gvir_designer_domain_get_os ()

OsinfoOs *          gvir_designer_domain_get_os         (GVirDesignerDomain *design);

Retrieves the operating system object associated with the designer. The object should not be modified by the caller.

design :

the domain designer instance. [transfer none]

Returns :

the operating system. [transfer none]

gvir_designer_domain_get_platform ()

OsinfoPlatform *    gvir_designer_domain_get_platform   (GVirDesignerDomain *design);

Retrieves the virtualization platform object associated with the designer. The object should not be modified by the caller.

design :

the domain designer instance. [transfer none]

Returns :

the virtualization platform. [transfer none]

gvir_designer_domain_new ()

GVirDesignerDomain * gvir_designer_domain_new           (OsinfoOs *os,
                                                         OsinfoPlatform *platform,
                                                         GVirConfigCapabilities *caps);

gvir_designer_domain_setup_container ()

gboolean            gvir_designer_domain_setup_container
                                                        (GVirDesignerDomain *design,
                                                         GError **error);

gvir_designer_domain_setup_container_full ()

gboolean            gvir_designer_domain_setup_container_full
                                                        (GVirDesignerDomain *design,
                                                         const char *arch,
                                                         GError **error);

gvir_designer_domain_setup_machine ()

gboolean            gvir_designer_domain_setup_machine  (GVirDesignerDomain *design,
                                                         GError **error);

gvir_designer_domain_setup_machine_full ()

gboolean            gvir_designer_domain_setup_machine_full
                                                        (GVirDesignerDomain *design,
                                                         const char *arch,
                                                         GVirConfigDomainOsType ostype,
                                                         GError **error);

gvir_designer_domain_setup_resources ()

gboolean            gvir_designer_domain_setup_resources
                                                        (GVirDesignerDomain *design,
                                                         GVirDesignerDomainResources req,
                                                         GError **error);

Set minimal or recommended resources on design.

design :

the domain designer instance. [transfer none]

req :

requirements to set. [transfer none]

error :

return location for a GError, or NULL

Returns :

TRUE when successfully set, FALSE otherwise. [transfer none]

gvir_designer_domain_supports_container ()

gboolean            gvir_designer_domain_supports_container
                                                        (GVirDesignerDomain *design);

gvir_designer_domain_supports_container_full ()

gboolean            gvir_designer_domain_supports_container_full
                                                        (GVirDesignerDomain *design,
                                                         const char *arch);

gvir_designer_domain_supports_machine ()

gboolean            gvir_designer_domain_supports_machine
                                                        (GVirDesignerDomain *design);

gvir_designer_domain_supports_machine_full ()

gboolean            gvir_designer_domain_supports_machine_full
                                                        (GVirDesignerDomain *design,
                                                         const char *arch,
                                                         GVirConfigDomainOsType ostype);

Property Details

The "capabilities" property

  "capabilities"             GVirConfigCapabilities*  : Read / Write / Construct Only

Capabilities.


The "config" property

  "config"                   GVirConfigDomain*     : Read

Domain config.


The "os" property

  "os"                       OsinfoOs*             : Read / Write / Construct Only

Operating system.


The "platform" property

  "platform"                 OsinfoPlatform*       : Read / Write / Construct Only

Platform.