hostfolder

Documentation

Index

• Variables
• type CifsHostFolder
  • func (h *CifsHostFolder) Config() config.HostFolderConfig
  • func (h *CifsHostFolder) Mount(driver drivers.Driver) error
  • func (h *CifsHostFolder) Umount(driver drivers.Driver) error
• type HostFolder
  • func NewCifsHostFolder(config config.HostFolderConfig) HostFolder
  • func NewSSHFSHostFolder(config config.HostFolderConfig, globalConfig *miniConfig.GlobalConfigType) HostFolder
• type Manager
  • func NewManager(instanceConfig *miniConfig.InstanceConfigType, ...) (*Manager, error)
  • func (m *Manager) Add(hostFolder HostFolder, allInstances bool)
  • func (m *Manager) Exist(name string) bool
  • func (m *Manager) ExistAny() bool
  • func (m *Manager) List(driver drivers.Driver) ([]MountInfo, error)
  • func (m *Manager) Mount(driver drivers.Driver, name string) error
  • func (m *Manager) MountAll(driver drivers.Driver) error
  • func (m *Manager) Remove(name string) error
  • func (m *Manager) Umount(driver drivers.Driver, name string) error
• type MountInfo
• type SSHFSHostFolder
  • func (h *SSHFSHostFolder) Config() config.HostFolderConfig
  • func (h *SSHFSHostFolder) Mount(driver drivers.Driver) error
  • func (h *SSHFSHostFolder) Umount(driver drivers.Driver) error
• type Type
  • func (t Type) String() string

Variables

var (
	SftpPort = 2022
)

Types

type CifsHostFolder

type CifsHostFolder struct {
	// contains filtered or unexported fields
}

func (*CifsHostFolder) Config

func (h *CifsHostFolder) Config() config.HostFolderConfig

func (*CifsHostFolder) Mount

func (h *CifsHostFolder) Mount(driver drivers.Driver) error

func (*CifsHostFolder) Umount

func (h *CifsHostFolder) Umount(driver drivers.Driver) error

type HostFolder

type HostFolder interface {
	// Config returns the host folder configuration for this HostFolder.
	Config() config.HostFolderConfig

	// Mount mounts the host folder specified by name into the running VM. nil is returned on success.
	// An error is returned, if the VM is not running, the specified host folder does not exist or the mount fails.
	Mount(driver drivers.Driver) error

	// Umount umounts the host folder specified by name. nil is returned on success.
	// An error is returned, if the VM is not running, the specified host folder does not exist or the mount fails.
	Umount(driver drivers.Driver) error
}

func NewCifsHostFolder

func NewCifsHostFolder(config config.HostFolderConfig) HostFolder

func NewSSHFSHostFolder

func NewSSHFSHostFolder(config config.HostFolderConfig, globalConfig *miniConfig.GlobalConfigType) HostFolder

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager is the central point for all operations around managing hostfolders.

func NewManager

func NewManager(instanceConfig *miniConfig.InstanceConfigType, allInstancesConfig *miniConfig.GlobalConfigType) (*Manager, error)

NewAddOnManager creates a new add-on manager for the specified add-on directory.

func (*Manager) Add

func (m *Manager) Add(hostFolder HostFolder, allInstances bool)

Add adds teh specified host folder to the configuration. Depending on the allInstances flag the configuration is either saved to the instance configuration or the global all instances configuration.

func (*Manager) Exist

func (m *Manager) Exist(name string) bool

Exist returns true if the host folder with the specified name exist, false otherwise.

func (*Manager) ExistAny

func (m *Manager) ExistAny() bool

ExistAny returns true if at least one host folder configuration exists, false otherwise.

func (*Manager) List

func (m *Manager) List(driver drivers.Driver) ([]MountInfo, error)

List returns a list of MountInfo instances for the configured host folders. If an error occurs nil is returned together with the error.

func (*Manager) Mount

func (m *Manager) Mount(driver drivers.Driver, name string) error

Mount mounts the host folder specified by name into the running VM. nil is returned on success. An error is returned, if the VM is not running, the specified host folder does not exist or the mount fails.

func (*Manager) MountAll

func (m *Manager) MountAll(driver drivers.Driver) error

MountAll mounts all defined host folders.

func (*Manager) Remove

func (m *Manager) Remove(name string) error

Remove removes the specified host folder from the configuration. If the host folder does not exist an error is returned.

func (*Manager) Umount

func (m *Manager) Umount(driver drivers.Driver, name string) error

Umount umounts the host folder specified by name. nil is returned on success. An error is returned, if the VM is not running, the specified host folder does not exist or the mount fails.

type MountInfo

type MountInfo struct {
	Name       string
	Type       string
	Source     string
	MountPoint string
	Mounted    bool
}

type SSHFSHostFolder

type SSHFSHostFolder struct {
	// contains filtered or unexported fields
}

func (*SSHFSHostFolder) Config

func (h *SSHFSHostFolder) Config() config.HostFolderConfig

func (*SSHFSHostFolder) Mount

func (h *SSHFSHostFolder) Mount(driver drivers.Driver) error

func (*SSHFSHostFolder) Umount

func (h *SSHFSHostFolder) Umount(driver drivers.Driver) error

type Type

type Type int

const (
	// SSHFS defines the constant to be used for the SSFS host folder type.
	SSHFS Type = iota

	// CIFS defines the constant to be used for the CIFS host folder type.
	CIFS
)

func (Type) String

func (t Type) String() string