vz

package module

Go to main page

Versions in this module

v3

v3.6.0

Jan 6, 2025

Changes in this version

+ type USBController struct

+ func (u *USBController) Attach(device USBDevice) error

+ func (u *USBController) Detach(device USBDevice) error

+ func (u *USBController) USBDevices() []USBDevice

+ type USBControllerConfiguration interface

+ type USBDevice interface

+ UUID func() string

+ func NewUSBMassStorageDevice(config *USBMassStorageDeviceConfiguration) (USBDevice, error)

type VirtualMachine

+ func (v *VirtualMachine) USBControllers() []*USBController

type VirtualMachineConfiguration

+ func (v *VirtualMachineConfiguration) SetUSBControllersVirtualMachineConfiguration(us []USBControllerConfiguration)

+ func (v *VirtualMachineConfiguration) USBControllers() []USBControllerConfiguration

+ type XHCIControllerConfiguration struct

+ func NewXHCIControllerConfiguration() (*XHCIControllerConfiguration, error)

v3.5.1

Nov 21, 2024

v3.5.0

Nov 20, 2024

Changes in this version

type ErrorCode

+ const ErrorDeviceAlreadyAttached

+ const ErrorDeviceInitializationFailure

+ const ErrorDeviceNotFound

+ const ErrorNetworkBlockDeviceDisconnected

+ const ErrorNetworkBlockDeviceNegotiationFailed

+ const ErrorRestore

+ const ErrorSave

+ const ErrorUSBControllerNotFound

+ type StartGraphicApplicationOption func(*startGraphicApplicationOptions) error

+ func WithController(enable bool) StartGraphicApplicationOption

+ func WithWindowTitle(title string) StartGraphicApplicationOption

v3.4.0

Nov 5, 2024

Changes in this version

type BridgedNetworkDeviceAttachment

+ func (*BridgedNetworkDeviceAttachment) String() string

+ type DisconnectedError struct

+ Config *VirtioNetworkDeviceConfiguration

+ Err error

+ func (e *DisconnectedError) Error() string

+ func (e *DisconnectedError) Unwrap() error

type FileHandleNetworkDeviceAttachment

+ func (*FileHandleNetworkDeviceAttachment) String() string

type NATNetworkDeviceAttachment

+ func (*NATNetworkDeviceAttachment) String() string

type VirtioNetworkDeviceConfiguration

+ func (v *VirtioNetworkDeviceConfiguration) Attachment() NetworkDeviceAttachment

type VirtualMachine

+ func (v *VirtualMachine) NetworkDeviceAttachmentWasDisconnected() (<-chan *DisconnectedError, error)

v3.3.0

Nov 2, 2024

Changes in this version

type NVMExpressControllerDeviceConfiguration

+ func (b NVMExpressControllerDeviceConfiguration) Attachment() StorageDeviceAttachment

type NetworkBlockDeviceStorageDeviceAttachment

+ func (n *NetworkBlockDeviceStorageDeviceAttachment) Connected() <-chan struct{}

+ func (n *NetworkBlockDeviceStorageDeviceAttachment) DidEncounterError() <-chan error

type StorageDeviceConfiguration

+ Attachment func() StorageDeviceAttachment

type USBMassStorageDeviceConfiguration

+ func (b USBMassStorageDeviceConfiguration) Attachment() StorageDeviceAttachment

type VirtioBlockDeviceConfiguration

+ func (b VirtioBlockDeviceConfiguration) Attachment() StorageDeviceAttachment

type VirtualMachineConfiguration

+ func (v *VirtualMachineConfiguration) StorageDevices() []StorageDeviceConfiguration

v3.2.0

Oct 19, 2024

Changes in this version

+ func IsNestedVirtualizationSupported() bool

type BridgedNetwork

+ func NetworkInterfaces() []BridgedNetwork

type GenericPlatformConfiguration

+ func (m *GenericPlatformConfiguration) SetNestedVirtualizationEnabled(enable bool) error

+ type NetworkBlockDeviceStorageDeviceAttachment struct

+ func NewNetworkBlockDeviceStorageDeviceAttachment(url string, timeout time.Duration, forcedReadOnly bool, ...) (*NetworkBlockDeviceStorageDeviceAttachment, error)

v3.1.0

Oct 22, 2023

Changes in this version

+ type DiskBlockDeviceStorageDeviceAttachment struct

+ func NewDiskBlockDeviceStorageDeviceAttachment(file *os.File, readOnly bool, syncMode DiskSynchronizationMode) (*DiskBlockDeviceStorageDeviceAttachment, error)

+ type DiskSynchronizationMode int

+ const DiskSynchronizationModeFull

+ const DiskSynchronizationModeNone

+ type NVMExpressControllerDeviceConfiguration struct

+ func NewNVMExpressControllerDeviceConfiguration(attachment StorageDeviceAttachment) (*NVMExpressControllerDeviceConfiguration, error)

type VirtualMachineState

+ const VirtualMachineStateRestoring

+ const VirtualMachineStateSaving

v3.0.6

May 5, 2023

v3.0.5

Apr 15, 2023

v3.0.4

Jan 22, 2023

v3.0.3

Dec 23, 2022

Changes in this version

+ type DiskImageCachingMode int

+ const DiskImageCachingModeAutomatic

+ const DiskImageCachingModeCached

+ const DiskImageCachingModeUncached

type DiskImageStorageDeviceAttachment

+ func NewDiskImageStorageDeviceAttachmentWithCacheAndSync(diskPath string, readOnly bool, cachingMode DiskImageCachingMode, ...) (*DiskImageStorageDeviceAttachment, error)

+ type DiskImageSynchronizationMode int

+ const DiskImageSynchronizationModeFsync

+ const DiskImageSynchronizationModeFull

+ const DiskImageSynchronizationModeNone

v3.0.2

Nov 28, 2022

v3.0.1

Nov 22, 2022

v3.0.0

Nov 2, 2022

Changes in this version

+ var ErrBuildTargetOSVersion = errors.New("unsupported build target macOS version")

+ var ErrUnsupportedOSVersion = errors.New("unsupported macOS version")

+ func CreateDiskImage(pathname string, size int64) error

+ func MacOSGuestAutomountTag() (string, error)

+ func SpiceAgentPortAttachmentName() (string, error)

+ func VirtualMachineConfigurationMaximumAllowedCPUCount() uint

+ func VirtualMachineConfigurationMaximumAllowedMemorySize() uint64

+ func VirtualMachineConfigurationMinimumAllowedCPUCount() uint

+ func VirtualMachineConfigurationMinimumAllowedMemorySize() uint64

+ type AudioDeviceConfiguration interface

+ type BootLoader interface

+ type BridgedNetwork interface

+ Identifier func() string

+ LocalizedDisplayName func() string

+ NetworkInterfaces func() []BridgedNetwork

+ type BridgedNetworkDeviceAttachment struct

+ func NewBridgedNetworkDeviceAttachment(networkInterface BridgedNetwork) (*BridgedNetworkDeviceAttachment, error)

+ type ConsoleDeviceConfiguration interface

+ type ConsolePortConfiguration interface

+ type DirectoryShare interface

+ type DirectorySharingDeviceConfiguration interface

+ type DiskImageStorageDeviceAttachment struct

+ func NewDiskImageStorageDeviceAttachment(diskPath string, readOnly bool) (*DiskImageStorageDeviceAttachment, error)

+ type EFIBootLoader struct

+ func NewEFIBootLoader(opts ...NewEFIBootLoaderOption) (*EFIBootLoader, error)

+ func (e *EFIBootLoader) VariableStore() *EFIVariableStore

+ type EFIVariableStore struct

+ func NewEFIVariableStore(path string, opts ...NewEFIVariableStoreOption) (*EFIVariableStore, error)

+ func (e *EFIVariableStore) Path() string

+ type ErrorCode int

+ const ErrorInstallationFailed

+ const ErrorInstallationRequiresUpdate

+ const ErrorInternal

+ const ErrorInvalidDiskImage

+ const ErrorInvalidRestoreImage

+ const ErrorInvalidRestoreImageCatalog

+ const ErrorInvalidVirtualMachineConfiguration

+ const ErrorInvalidVirtualMachineState

+ const ErrorInvalidVirtualMachineStateTransition

+ const ErrorNetworkError

+ const ErrorNoSupportedRestoreImagesInCatalog

+ const ErrorNotSupported

+ const ErrorOperationCancelled

+ const ErrorOutOfDiskSpace

+ const ErrorRestoreImageCatalogLoadFailed

+ const ErrorRestoreImageLoadFailed

+ const ErrorVirtualMachineLimitExceeded

+ func (i ErrorCode) String() string

+ type FileHandleNetworkDeviceAttachment struct

+ func NewFileHandleNetworkDeviceAttachment(file *os.File) (*FileHandleNetworkDeviceAttachment, error)

+ func (f *FileHandleNetworkDeviceAttachment) MaximumTransmissionUnit() int

+ func (f *FileHandleNetworkDeviceAttachment) SetMaximumTransmissionUnit(mtu int) error

+ type FileHandleSerialPortAttachment struct

+ func NewFileHandleSerialPortAttachment(read, write *os.File) (*FileHandleSerialPortAttachment, error)

+ type FileSerialPortAttachment struct

+ func NewFileSerialPortAttachment(path string, shouldAppend bool) (*FileSerialPortAttachment, error)

+ type GenericMachineIdentifier struct

+ func NewGenericMachineIdentifier() (*GenericMachineIdentifier, error)

+ func NewGenericMachineIdentifierWithData(b []byte) (*GenericMachineIdentifier, error)

+ func NewGenericMachineIdentifierWithDataPath(pathname string) (*GenericMachineIdentifier, error)

+ func (g *GenericMachineIdentifier) DataRepresentation() []byte

+ type GenericPlatformConfiguration struct

+ func NewGenericPlatformConfiguration(opts ...GenericPlatformConfigurationOption) (*GenericPlatformConfiguration, error)

+ func (m *GenericPlatformConfiguration) MachineIdentifier() *GenericMachineIdentifier

+ type GenericPlatformConfigurationOption func(*GenericPlatformConfiguration) error

+ func WithGenericMachineIdentifier(m *GenericMachineIdentifier) GenericPlatformConfigurationOption

+ type GraphicsDeviceConfiguration interface

+ type KeyboardConfiguration interface

+ type LinuxBootLoader struct

+ func NewLinuxBootLoader(vmlinuz string, opts ...LinuxBootLoaderOption) (*LinuxBootLoader, error)

+ func (b *LinuxBootLoader) String() string

+ type LinuxBootLoaderOption func(b *LinuxBootLoader) error

+ func WithCommandLine(cmdLine string) LinuxBootLoaderOption

+ func WithInitrd(initrdPath string) LinuxBootLoaderOption

+ type MACAddress struct

+ func NewMACAddress(macAddr net.HardwareAddr) (*MACAddress, error)

+ func NewRandomLocallyAdministeredMACAddress() (*MACAddress, error)

+ func (m *MACAddress) HardwareAddr() net.HardwareAddr

+ func (m *MACAddress) String() string

+ type MemoryBalloonDeviceConfiguration interface

+ type MultipleDirectoryShare struct

+ func NewMultipleDirectoryShare(shares map[string]*SharedDirectory) (*MultipleDirectoryShare, error)

+ type NATNetworkDeviceAttachment struct

+ func NewNATNetworkDeviceAttachment() (*NATNetworkDeviceAttachment, error)

+ type NSError struct

+ Code int

+ Domain string

+ LocalizedDescription string

+ UserInfo string

+ func (n *NSError) Error() string

+ type NetworkDeviceAttachment interface

+ type NewEFIBootLoaderOption func(b *EFIBootLoader)

+ func WithEFIVariableStore(variableStore *EFIVariableStore) NewEFIBootLoaderOption

+ type NewEFIVariableStoreOption func(*EFIVariableStore) error

+ func WithCreatingEFIVariableStore() NewEFIVariableStoreOption

+ type NewVirtioConsolePortConfigurationOption func(*VirtioConsolePortConfiguration)

+ func WithVirtioConsolePortConfigurationAttachment(attachment SerialPortAttachment) NewVirtioConsolePortConfigurationOption

+ func WithVirtioConsolePortConfigurationIsConsole(isConsole bool) NewVirtioConsolePortConfigurationOption

+ func WithVirtioConsolePortConfigurationName(name string) NewVirtioConsolePortConfigurationOption

+ type PlatformConfiguration interface

+ type PointingDeviceConfiguration interface

+ type SerialPortAttachment interface

+ type SharedDirectory struct

+ func NewSharedDirectory(dirPath string, readOnly bool) (*SharedDirectory, error)

+ type SingleDirectoryShare struct

+ func NewSingleDirectoryShare(share *SharedDirectory) (*SingleDirectoryShare, error)

+ type SocketDeviceConfiguration interface

+ type SpiceAgentPortAttachment struct

+ func NewSpiceAgentPortAttachment() (*SpiceAgentPortAttachment, error)

+ func (s *SpiceAgentPortAttachment) SetSharesClipboard(enable bool)

+ func (s *SpiceAgentPortAttachment) SharesClipboard() bool

+ type StorageDeviceAttachment interface

+ type StorageDeviceConfiguration interface

+ type USBKeyboardConfiguration struct

+ func NewUSBKeyboardConfiguration() (*USBKeyboardConfiguration, error)

+ type USBMassStorageDeviceConfiguration struct

+ func NewUSBMassStorageDeviceConfiguration(attachment StorageDeviceAttachment) (*USBMassStorageDeviceConfiguration, error)

+ type USBScreenCoordinatePointingDeviceConfiguration struct

+ func NewUSBScreenCoordinatePointingDeviceConfiguration() (*USBScreenCoordinatePointingDeviceConfiguration, error)

+ type VirtioBlockDeviceConfiguration struct

+ func NewVirtioBlockDeviceConfiguration(attachment StorageDeviceAttachment) (*VirtioBlockDeviceConfiguration, error)

+ func (v *VirtioBlockDeviceConfiguration) BlockDeviceIdentifier() (string, error)

+ func (v *VirtioBlockDeviceConfiguration) SetBlockDeviceIdentifier(identifier string) error

+ type VirtioConsoleDeviceConfiguration struct

+ func NewVirtioConsoleDeviceConfiguration() (*VirtioConsoleDeviceConfiguration, error)

+ func (v *VirtioConsoleDeviceConfiguration) MaximumPortCount() uint32

+ func (v *VirtioConsoleDeviceConfiguration) SetVirtioConsolePortConfiguration(idx int, portConfig *VirtioConsolePortConfiguration)

+ type VirtioConsoleDeviceSerialPortConfiguration struct

+ func NewVirtioConsoleDeviceSerialPortConfiguration(attachment SerialPortAttachment) (*VirtioConsoleDeviceSerialPortConfiguration, error)

+ type VirtioConsolePortConfiguration struct

+ func NewVirtioConsolePortConfiguration(opts ...NewVirtioConsolePortConfigurationOption) (*VirtioConsolePortConfiguration, error)

+ func (v *VirtioConsolePortConfiguration) Attachment() SerialPortAttachment

+ func (v *VirtioConsolePortConfiguration) IsConsole() bool

+ func (v *VirtioConsolePortConfiguration) Name() string

+ type VirtioEntropyDeviceConfiguration struct

+ func NewVirtioEntropyDeviceConfiguration() (*VirtioEntropyDeviceConfiguration, error)

+ type VirtioFileSystemDeviceConfiguration struct

+ func NewVirtioFileSystemDeviceConfiguration(tag string) (*VirtioFileSystemDeviceConfiguration, error)

+ func (c *VirtioFileSystemDeviceConfiguration) SetDirectoryShare(share DirectoryShare)

+ type VirtioGraphicsDeviceConfiguration struct

+ func NewVirtioGraphicsDeviceConfiguration() (*VirtioGraphicsDeviceConfiguration, error)

+ func (v *VirtioGraphicsDeviceConfiguration) SetScanouts(scanoutConfigs ...*VirtioGraphicsScanoutConfiguration)

+ type VirtioGraphicsScanoutConfiguration struct

+ func NewVirtioGraphicsScanoutConfiguration(widthInPixels int64, heightInPixels int64) (*VirtioGraphicsScanoutConfiguration, error)

+ type VirtioNetworkDeviceConfiguration struct

+ func NewVirtioNetworkDeviceConfiguration(attachment NetworkDeviceAttachment) (*VirtioNetworkDeviceConfiguration, error)

+ func (v *VirtioNetworkDeviceConfiguration) SetMACAddress(macAddress *MACAddress)

+ type VirtioSocketConnection struct

+ func (v *VirtioSocketConnection) Close() error

+ func (v *VirtioSocketConnection) DestinationPort() uint32

+ func (v *VirtioSocketConnection) LocalAddr() net.Addr

+ func (v *VirtioSocketConnection) Read(b []byte) (n int, err error)

+ func (v *VirtioSocketConnection) RemoteAddr() net.Addr

+ func (v *VirtioSocketConnection) SetDeadline(t time.Time) error

+ func (v *VirtioSocketConnection) SetReadDeadline(t time.Time) error

+ func (v *VirtioSocketConnection) SetWriteDeadline(t time.Time) error

+ func (v *VirtioSocketConnection) SourcePort() uint32

+ func (v *VirtioSocketConnection) Write(b []byte) (n int, err error)

+ type VirtioSocketDevice struct

+ func (v *VirtioSocketDevice) Connect(port uint32) (*VirtioSocketConnection, error)

+ func (v *VirtioSocketDevice) Listen(port uint32) (*VirtioSocketListener, error)

+ type VirtioSocketDeviceConfiguration struct

+ func NewVirtioSocketDeviceConfiguration() (*VirtioSocketDeviceConfiguration, error)

+ type VirtioSocketListener struct

+ func (v *VirtioSocketListener) Accept() (net.Conn, error)

+ func (v *VirtioSocketListener) AcceptVirtioSocketConnection() (*VirtioSocketConnection, error)

+ func (v *VirtioSocketListener) Addr() net.Addr

+ func (v *VirtioSocketListener) Close() error

+ type VirtioSocketListenerAddr struct

+ CID uint32

+ Port uint32

+ func (a *VirtioSocketListenerAddr) Network() string

+ func (a *VirtioSocketListenerAddr) String() string

+ type VirtioSoundDeviceConfiguration struct

+ func NewVirtioSoundDeviceConfiguration() (*VirtioSoundDeviceConfiguration, error)

+ func (v *VirtioSoundDeviceConfiguration) SetStreams(streams ...VirtioSoundDeviceStreamConfiguration)

+ type VirtioSoundDeviceHostInputStreamConfiguration struct

+ func NewVirtioSoundDeviceHostInputStreamConfiguration() (*VirtioSoundDeviceHostInputStreamConfiguration, error)

+ type VirtioSoundDeviceHostOutputStreamConfiguration struct

+ func NewVirtioSoundDeviceHostOutputStreamConfiguration() (*VirtioSoundDeviceHostOutputStreamConfiguration, error)

+ type VirtioSoundDeviceStreamConfiguration interface

+ type VirtioTraditionalMemoryBalloonDeviceConfiguration struct

+ func NewVirtioTraditionalMemoryBalloonDeviceConfiguration() (*VirtioTraditionalMemoryBalloonDeviceConfiguration, error)

+ type VirtualMachine struct

+ func NewVirtualMachine(config *VirtualMachineConfiguration) (*VirtualMachine, error)

+ func (v *VirtualMachine) CanPause() bool

+ func (v *VirtualMachine) CanRequestStop() bool

+ func (v *VirtualMachine) CanResume() bool

+ func (v *VirtualMachine) CanStart() bool

+ func (v *VirtualMachine) CanStop() bool

+ func (v *VirtualMachine) Pause() error

+ func (v *VirtualMachine) RequestStop() (bool, error)

+ func (v *VirtualMachine) Resume() error

+ func (v *VirtualMachine) SocketDevices() []*VirtioSocketDevice

+ func (v *VirtualMachine) Start(opts ...VirtualMachineStartOption) error

+ func (v *VirtualMachine) StartGraphicApplication(width, height float64) error

+ func (v *VirtualMachine) State() VirtualMachineState

+ func (v *VirtualMachine) StateChangedNotify() <-chan VirtualMachineState

+ func (v *VirtualMachine) Stop() error

+ type VirtualMachineConfiguration struct

+ func NewVirtualMachineConfiguration(bootLoader BootLoader, cpu uint, memorySize uint64) (*VirtualMachineConfiguration, error)

+ func (v *VirtualMachineConfiguration) NetworkDevices() []*VirtioNetworkDeviceConfiguration

+ func (v *VirtualMachineConfiguration) SetAudioDevicesVirtualMachineConfiguration(cs []AudioDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SetConsoleDevicesVirtualMachineConfiguration(cs []ConsoleDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SetDirectorySharingDevicesVirtualMachineConfiguration(cs []DirectorySharingDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SetEntropyDevicesVirtualMachineConfiguration(cs []*VirtioEntropyDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SetGraphicsDevicesVirtualMachineConfiguration(cs []GraphicsDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SetKeyboardsVirtualMachineConfiguration(cs []KeyboardConfiguration)

+ func (v *VirtualMachineConfiguration) SetMemoryBalloonDevicesVirtualMachineConfiguration(cs []MemoryBalloonDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SetNetworkDevicesVirtualMachineConfiguration(cs []*VirtioNetworkDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SetPlatformVirtualMachineConfiguration(c PlatformConfiguration)

+ func (v *VirtualMachineConfiguration) SetPointingDevicesVirtualMachineConfiguration(cs []PointingDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SetSerialPortsVirtualMachineConfiguration(cs []*VirtioConsoleDeviceSerialPortConfiguration)

+ func (v *VirtualMachineConfiguration) SetSocketDevicesVirtualMachineConfiguration(cs []SocketDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SetStorageDevicesVirtualMachineConfiguration(cs []StorageDeviceConfiguration)

+ func (v *VirtualMachineConfiguration) SocketDevices() []SocketDeviceConfiguration

+ func (v *VirtualMachineConfiguration) Validate() (bool, error)

+ type VirtualMachineStartOption func(*virtualMachineStartOptions) error

+ type VirtualMachineState int

+ const VirtualMachineStateError

+ const VirtualMachineStatePaused

+ const VirtualMachineStatePausing

+ const VirtualMachineStateResuming

+ const VirtualMachineStateRunning

+ const VirtualMachineStateStarting

+ const VirtualMachineStateStopped

+ const VirtualMachineStateStopping

+ func (i VirtualMachineState) String() string

Other modules containing this package

github.com/Code-Hex/vz

github.com/Code-Hex/vz/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL