types

Documentation

Index

• type BlockDirtyBitmapOptions
• type BlockIOThrottle
• type BlockInfo
• type BlockJobInfo
• type BlockResizeQuery
• type CPUDeviceOptions
• type CPUInfo
• type CPUInfoFast
• type ChardevBackend
• type ChardevInfo
• type ChardevOptions
• type ChardevSocket
• type DeviceName
• type DeviceOptions
• type DriveBackupOptions
• type DriveMirrorOptions
• type HotpluggableCPU
• type InetSocketAddressBase
• type InetSocketAddressLegacy
• type InsertedFileOptions
• type IntID
• type IntValue
• type MigrateSetParameters
• type MigrationCapabilityStatus
• type MigrationInfo
• type NetdevTapOptions
• type PCIInfo
• type QomQuery
• type SocketAddressLegacy
• type StatusInfo
• type StrID
• type Uint64Value
• type UnixSocketAddress

Types

type BlockDirtyBitmapOptions

type BlockDirtyBitmapOptions struct {
	Node string `json:"node"`
	Name string `json:"name"`
}

BlockDirtyBitmapOptions is a common structure for operations with dirty bitmaps.

type BlockIOThrottle

type BlockIOThrottle struct {
	Device string `json:"device"`
	Iops   int    `json:"iops"`
	IopsRd int    `json:"iops_rd"`
	IopsWr int    `json:"iops_wr"`
	Bps    int    `json:"bps"`
	BpsWr  int    `json:"bps_wr"`
	BpsRd  int    `json:"bps_rd"`
}

BlockIOThrottle represents a set of parameters describing block device throttling.

type BlockInfo

type BlockInfo struct {
	Device       string `json:"device"`
	DirtyBitmaps []struct {
		Name string `json:"name"`
	} `json:"dirty-bitmaps"`
	Inserted struct {
		File             string `json:"file"`
		BackingFile      string `json:"backing_file"`
		BackingFileDepth int    `json:"backing_file_depth"`
		ReadOnly         bool   `json:"ro"`
		IopsRd           int    `json:"iops_rd"`
		IopsWr           int    `json:"iops_wr"`
		Image            struct {
			Filename        string `json:"filename"`
			Format          string `json:"format"`
			ActualSize      uint64 `json:"actual-size"`
			VirtualSize     uint64 `json:"virtual-size"`
			BackingFilename string `json:"backing-filename"`
			BackingImage    struct {
				Filename    string `json:"filename"`
				VirtualSize uint64 `json:"virtual-size"`
			} `json:"backing-image"`
		}
		DirtyBitmaps []struct {
			Name string `json:"name"`
		} `json:"dirty-bitmaps"`
	} `json:"inserted"`
	QdevPath string `json:"qdev"`
}

BlockInfo describes a virtual device and the backing device associated with it.

type BlockJobInfo

type BlockJobInfo struct {
	Type   string `json:"type"`
	Device string `json:"device"`
	Len    uint64 `json:"len"`
	Offset uint64 `json:"offset"`
	Busy   bool   `json:"busy"`
	Paused bool   `json:"paused"`
	Speed  uint64 `json:"speed"`
	Ready  bool   `json:"ready"`
}

BlockJobInfo describes a long-running block device operation.

type BlockResizeQuery

type BlockResizeQuery struct {
	Device string `json:"device"`
	Size   int    `json:"size"`
}

BlockResizeQuery is a query struct for the block_resize command. The size value should be in bytes.

type CPUDeviceOptions

type CPUDeviceOptions struct {
	Driver   string `json:"driver"`
	SocketID int    `json:"socket-id"`
	CoreID   int    `json:"core-id"`
	ThreadID int    `json:"thread-id"`
}

type CPUInfo

type CPUInfo struct {
	CPU      int    `json:"CPU"`
	QomPath  string `json:"qom_path"`
	ThreadID int    `json:"thread_id"`
}

CPUInfo describes the properties of a virtual CPU.

type CPUInfoFast

type CPUInfoFast struct {
	CPUIndex int `json:"cpu-index"`
	ThreadID int `json:"thread-id"`
}

CPUInfoFast describes the properties of a virtual CPU.

type ChardevBackend

type ChardevBackend struct {
	Type string        `json:"type"`
	Data ChardevSocket `json:"data"`
}

ChardevBackend represents a set of parameters for the new chardev backend.

type ChardevInfo

type ChardevInfo struct {
	Label        string `json:"label"`
	Filename     string `json:"filename"`
	FrontendOpen bool   `json:"frontend-open"`
}

ChardevInfo describes a character device.

type ChardevOptions

type ChardevOptions struct {
	ID      string         `json:"id"`
	Backend ChardevBackend `json:"backend"`
}

ChardevOptions represents a set of parameters for the new character device.

type ChardevSocket

type ChardevSocket struct {
	Addr   SocketAddressLegacy `json:"addr"`
	Server bool                `json:"server"`
	Wait   bool                `json:"wait"`
}

ChardevSocket describes a (stream) socket character device.

type DeviceName

type DeviceName struct {
	Device string `json:"device"`
}

StrID is a string representation of the ID argument.

type DeviceOptions

type DeviceOptions struct {
	Driver       string `json:"driver"`
	Id           string `json:"id"`
	Bus          string `json:"bus,omitempty"`
	Addr         string `json:"addr,omitempty"`
	Drive        string `json:"drive,omitempty"`
	Netdev       string `json:"netdev,omitempty"`
	Mac          string `json:"mac,omitempty"`
	MQ           bool   `json:"mq,omitempty"`
	Vectors      int    `json:"vectors,omitempty"`
	Bootindex    int    `json:"bootindex,omitempty"`
	Chardev      string `json:"chardev,omitempty"`
	Name         string `json:"name,omitempty"`
	GuestID      uint32 `json:"guest-cid,omitempty"`
	SCSI_Channel int    `json:"channel,omitempty"`
	SCSI_ID      int    `json:"scsi-id,omitempty"`
	SCSI_Lun     int    `json:"lun,omitempty"`
}

DeviceOptions is a common structure for different types of devices.

type DriveBackupOptions

type DriveBackupOptions struct {
	JobID  string `json:"job-id,omitempty"`
	Device string `json:"device"`
	Target string `json:"target"`
	Format string `json:"format,omitempty"`
	Sync   string `json:"sync"`
	Bitmap string `json:"bitmap,omitempty"`
	Mode   string `json:"mode,omitempty"`
	Speed  uint64 `json:"speed,omitempty"`
}

DriveBackupOptions is a set of parameters for setting up a new drive backup process.

type DriveMirrorOptions

type DriveMirrorOptions struct {
	JobID    string `json:"job-id"`
	Device   string `json:"device"`
	Target   string `json:"target"`
	Format   string `json:"format"`
	Sync     string `json:"sync"`
	Mode     string `json:"mode"`
	CopyMode string `json:"copy-mode,omitempty"`
	Speed    uint64 `json:"speed,omitempty"`
}

DriveMirrorOptions is a set of parameters for setting up a new mirroring process.

type HotpluggableCPU

type HotpluggableCPU struct {
	Props struct {
		CoreID   int `json:"core-id"`
		SocketID int `json:"socket-id"`
	} `json:"props"`
	QomPath string `json:"qom-path"`
	Type    string `json:"type"`
}

HotpluggableCPU describes a hot-pluggable CPU.

type InetSocketAddressBase

type InetSocketAddressBase struct {
	Host string `json:"host"`
	Port string `json:"port"`
}

type InetSocketAddressLegacy

type InetSocketAddressLegacy struct {
	Type string                `json:"type"`
	Data InetSocketAddressBase `json:"data"`
}

type InsertedFileOptions

type InsertedFileOptions struct {
	Driver string `json:"driver"`
	File   struct {
		Driver string `json:"driver"`
		// iSCSI specific options
		InitiatorName string `json:"initiator-name"`
		Portal        string `json:"portal"`
		Target        string `json:"target"`
		Lun           string `json:"lun"`
		User          string `json:"user"`
		Password      string `json:"password"`
	} `json:"file"`
}

type IntID

type IntID struct {
	ID int `json:"id"`
}

IntID is an integer representation of the ID argument.

type IntValue

type IntValue struct {
	Value int `json:"value"`
}

IntValue is an integer representation of the Value argument.

type MigrateSetParameters

type MigrateSetParameters struct {
	MaxBandwidth    int `json:"max-bandwidth"`
	XbzrleCacheSize int `json:"xbzrle-cache-size"`
}

MigrateSetParameters represents a set of various migration parameters.

type MigrationCapabilityStatus

type MigrationCapabilityStatus struct {
	Capability string `json:"capability"`
	State      bool   `json:"state"`
}

MigrationCapabilityStatus describes the state (enabled/disabled) of migration capability.

type MigrationInfo

type MigrationInfo struct {
	Status string `json:"status"`
	Ram    struct {
		Total     uint64  `json:"total"`
		Remaining uint64  `json:"remaining"`
		Speed     float64 `json:"mbps"`
	} `json:"ram"`
	ErrDesc string `json:"error-desc"`
}

MigrationInfo describes a running migration process.

type NetdevTapOptions

type NetdevTapOptions struct {
	Type       string `json:"type"`
	ID         string `json:"id"`
	Ifname     string `json:"ifname"`
	Vhost      bool   `json:"vhost"`
	Queues     int    `json:"queues,omitempty"`
	Script     string `json:"script"`
	Downscript string `json:"downscript"`
}

NetdevTapOptions describes a TAP based guest networking device

type PCIInfo

type PCIInfo struct {
	Bus     int `json:"bus"`
	Devices []struct {
		QdevID    string `json:"qdev_id"`
		Slot      int    `json:"slot"`
		ClassInfo struct {
			Class int `json:"class"`
		} `json:"class_info"`
		ID struct {
			Device int `json:"device"`
			Vendor int `json:"vendor"`
		} `json:"id"`
	} `json:"devices"`
}

PCIInfo describes the PCI bus and all its devices.

type QomQuery

type QomQuery struct {
	Path     string `json:"path"`
	Property string `json:"property"`
}

QomQuery is a query struct to get a property value of QOM by the path.

type SocketAddressLegacy

type SocketAddressLegacy struct {
	Type string            `json:"type"`
	Data UnixSocketAddress `json:"data"`
}

type StatusInfo

type StatusInfo struct {
	Running    bool   `json:"running"`
	Singlestep bool   `json:"singlestep"`
	Status     string `json:"status"`
}

StatusInfo represents a guest running status.

type StrID

type StrID struct {
	ID string `json:"id"`
}

StrID is a string representation of the ID argument.

type Uint64Value

type Uint64Value struct {
	Value uint64 `json:"value"`
}

Uint64Value is a uint64 representation of the Value argument.

type UnixSocketAddress

type UnixSocketAddress struct {
	Path string `json:"path"`
}