Versions in this module Expand all Collapse all v7 v7.0.0 May 1, 2026 Changes in this version + const ConsoleTypeConsole + const ConsoleTypeVGA + const HookStart + const HookStop + const HookStopNS + const PowerStateRunning + const PowerStateStopped + var Create func(s *state.State, args db.InstanceArgs, p api.Project, ...) (Instance, revert.Hook, error) + var ErrNotImplemented = errors.New("Not implemented") + var Load func(s *state.State, args db.InstanceArgs, p api.Project) (Instance, error) + var ValidDevices func(state *state.State, p api.Project, instanceType instancetype.Type, ...) error + func AllowedUnprivilegedOnlyMap(rawIdmap string) error + func BackupLoadByName(s *state.State, project, name string) (*backup.InstanceBackup, error) + func DeviceNextInterfaceHWAddr(pattern string) (string, error) + func FilterFull(instances []*api.InstanceFull, clauses filter.ClauseSet) ([]*api.InstanceFull, error) + func IsSameLogicalInstance(inst Instance, dbInst *db.InstanceArgs) bool + func LoadInstanceDatabaseObject(ctx context.Context, tx *db.ClusterTx, project, name string) (*cluster.Instance, error) + func MoveTemporaryName(inst Instance) (string, error) + func NextSnapshotName(s *state.State, inst Instance, defaultPattern string) (string, error) + func ResolveImage(ctx context.Context, tx *db.ClusterTx, projectName string, ...) (string, error) + func ResourceUsage(instConfig map[string]string, instDevices map[string]map[string]string, ...) (int64, int64, int64, error) + func SnapshotProtobufToInstanceArgs(s *state.State, inst Instance, snap *migration.Snapshot) (*db.InstanceArgs, error) + func SnapshotToProtobuf(snap *api.InstanceSnapshot) *migration.Snapshot + func SuitableArchitectures(ctx context.Context, s *state.State, tx *db.ClusterTx, projectName string, ...) ([]int, error) + func ValidConfig(sysOS *sys.OS, config map[string]string, expanded bool, ...) error + func ValidName(instanceName string, isSnapshot bool) error + type Cmd interface + PID func() int + Signal func(s unix.Signal) error + Wait func() (int, error) + WindowResize func(fd, winchWidth, winchHeight int) error + type ConfigReader interface + Architecture func() int + ExpandedConfig func() map[string]string + ExpandedDevices func() deviceConfig.Devices + ID func() int + LocalConfig func() map[string]string + LocalDevices func() deviceConfig.Devices + Name func() string + Project func() api.Project + Type func() instancetype.Type + type Container interface + ConsoleLog func(opts liblxc.ConsoleLogOptions) (string, error) + CurrentIdmap func() (*idmap.Set, error) + DevptsFd func() (*os.File, error) + DiskIdmap func() (*idmap.Set, error) + IdmappedStorage func(path string, fstype string) idmap.StorageType + InsertSeccompUnixDevice func(prefix string, m deviceConfig.Device, pid int) error + NextIdmap func() (*idmap.Set, error) + type CriuMigrationArgs struct + ActionScript bool + Cmd uint + DumpDir string + Features liblxc.CriuFeatures + Function string + Op *operationlock.InstanceOperation + PreDumpDir string + StateDir string + Stop bool + type Info struct + Error error + Features map[string]any + Name string + Type instancetype.Type + Version string + type Instance interface + Backups func() ([]backup.InstanceBackup, error) + CGroup func() (*cgroup.CGroup, error) + CanLiveMigrate func() bool + CanMigrate func() string + CloudInitID func() string + ConnectNBD func(diskName string, diskSize int64, writable bool) (net.Conn, func(), error) + Console func(protocol string) (*os.File, chan error, error) + ConsoleBufferLogPath func() string + CreateBitmap func(deviceNames []string, data api.StorageVolumeBitmapsPost) error + CreateQcow2Snapshot func(diskPath string, devName string, snapshotName string, backingFilename string, ...) error + CreationDate func() time.Time + DeferTemplateApply func(trigger TemplateTrigger) error + Delete func(force bool, cleanupDependencies bool) error + DeleteBitmap func(deviceName string, bitmapName string) error + DeleteQcow2Snapshot func(devName string, snapshotIndex int, backingFilename string) error + Description func() string + DeviceEventHandler func(*deviceConfig.RunConfig) error + DevicesPath func() string + ETag func() []any + Exec func(req api.InstanceExecPost, stdin *os.File, stdout *os.File, stderr *os.File) (Cmd, error) + ExecOutputPath func() string + ExpiryDate func() time.Time + Export func(meta io.Writer, roofs io.Writer, properties map[string]string, ...) (*api.ImageMetadata, error) + ExportQcow2Block func(diskName string, blockIndex int) (func(), string, error) + FileSFTP func() (*sftp.Client, error) + FileSFTPConn func() (net.Conn, error) + FillNetworkDevice func(name string, m deviceConfig.Device) (deviceConfig.Device, error) + ForEachDependentDiskType func(diskAction func(dev deviceConfig.DeviceNamed) error) error + Freeze func() error + GetBitmaps func(deviceName string) ([]api.StorageVolumeBitmap, error) + GuestOS func() string + HasDependentDisk func() bool + Info func() Info + InitPID func() int + IsEphemeral func() bool + IsFrozen func() bool + IsPrivileged func() bool + IsRunning func() bool + IsSnapshot func() bool + IsStateful func() bool + LastUsedDate func() time.Time + Location func() string + LockExclusive func() (*operationlock.InstanceOperation, error) + LogFilePath func() string + LogPath func() string + MACPattern func() string + Metrics func(hostInterfaces []net.Interface) (*metrics.MetricSet, error) + MigrateReceive func(args MigrateReceiveArgs) error + MigrateSend func(args MigrateSendArgs) error + OnHook func(hookName string, args map[string]string) error + Operation func() *operations.Operation + Path func() string + Profiles func() []api.Profile + Rebuild func(img *api.Image, op *operations.Operation) error + RegisterDevices func() + ReloadDevice func(devName string) error + Rename func(newName string, applyTemplateTrigger bool) error + Render func() (any, any, error) + RenderFull func(hostInterfaces []net.Interface) (*api.InstanceFull, any, error) + RenderState func(hostInterfaces []net.Interface) (*api.InstanceState, error) + RenderWithUsage func() (any, any, error) + Restart func(timeout time.Duration) error + Restore func(source Instance, stateful bool, diskOnly bool) error + RootfsPath func() string + RunPath func() string + SetOperation func(op *operations.Operation) + Shutdown func(timeout time.Duration) error + Snapshot func(name string, expiry time.Time, stateful bool) error + Snapshots func() ([]Instance, error) + Start func(stateful bool) error + State func() string + StatePath func() string + Stop func(stateful bool) error + StoragePool func() (string, error) + TemplatesPath func() string + Unfreeze func() error + Update func(newConfig db.InstanceArgs, userRequested bool) error + UpdateBackupFile func() error + UpdateDevices func(devices deviceConfig.Devices) error + VolatileSet func(changes map[string]string) error + func CreateInternal(s *state.State, args db.InstanceArgs, op *operations.Operation, ...) (Instance, *operationlock.InstanceOperation, revert.Hook, error) + func LoadByID(s *state.State, id int) (Instance, error) + func LoadByProjectAndName(s *state.State, projectName string, instanceName string) (Instance, error) + func LoadFromBackup(s *state.State, projectName string, instancePath string, applyProfiles bool) (Instance, error) + func LoadNodeAll(s *state.State, instanceType instancetype.Type) ([]Instance, error) + type MigrateArgs struct + ClusterMoveSourceName string + ControlReceive func(m proto.Message, handshake bool) error + ControlSend func(m proto.Message) error + Disconnect func() + FilesystemConn func(ctx context.Context) (io.ReadWriteCloser, error) + Live bool + Snapshots bool + StateConn func(ctx context.Context) (io.ReadWriteCloser, error) + StoragePool string + type MigrateReceiveArgs struct + InstanceOperation *operationlock.InstanceOperation + Refresh bool + RefreshExcludeOlder bool + type MigrateSendArgs struct + AllowInconsistent bool + Devices api.DevicesMap + type TemplateTrigger string + const TemplateTriggerCopy + const TemplateTriggerCreate + const TemplateTriggerRename + type VM interface + AgentCertificate func() *x509.Certificate + ConsoleLog func() (string, error) + ConsoleScreenshot func(screenshotFile *os.File) error + DumpGuestMemory func(w *os.File, format string) error Other modules containing this package github.com/lxc/incus github.com/lxc/incus/v6
Go to main page