vboxmanage

README

vboxmanage module

This module can control "power" state of virtualbox VMs via the vboxmanage-rest-api (https://www.npmjs.com/package/vboxmanage-rest-api).

Documentation

Index

• Constants
• Variables
• type Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (m *Config) GetNameUrl() string
  • func (m *Config) GetPollingInterval() string
  • func (m *Config) GetServerUrl() string
  • func (m *Config) GetServers() map[string]*Server
  • func (m *Config) GetUuidUrl() string
  • func (m *Config) Marshal() (dAtA []byte, err error)
  • func (m *Config) MarshalTo(dAtA []byte) (int, error)
  • func (m *Config) MarshalToSizedBuffer(dAtA []byte) (int, error)
  • func (*Config) ProtoMessage()
  • func (m *Config) Reset()
  • func (m *Config) Size() (n int)
  • func (m *Config) String() string
  • func (m *Config) Unmarshal(dAtA []byte) error
  • func (m *Config) XXX_DiscardUnknown()
  • func (m *Config) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Config) XXX_Merge(src proto.Message)
  • func (*Config) XXX_MessageName() string
  • func (m *Config) XXX_Size() int
  • func (m *Config) XXX_Unmarshal(b []byte) error
• type Server
  • func (*Server) Descriptor() ([]byte, []int)
  • func (m *Server) GetIp() string
  • func (m *Server) GetName() string
  • func (m *Server) GetPort() int32
  • func (m *Server) Marshal() (dAtA []byte, err error)
  • func (m *Server) MarshalTo(dAtA []byte) (int, error)
  • func (m *Server) MarshalToSizedBuffer(dAtA []byte) (int, error)
  • func (*Server) ProtoMessage()
  • func (m *Server) Reset()
  • func (m *Server) Size() (n int)
  • func (m *Server) String() string
  • func (m *Server) Unmarshal(dAtA []byte) error
  • func (m *Server) XXX_DiscardUnknown()
  • func (m *Server) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Server) XXX_Merge(src proto.Message)
  • func (*Server) XXX_MessageName() string
  • func (m *Server) XXX_Size() int
  • func (m *Server) XXX_Unmarshal(b []byte) error
• type VBM
  • func (*VBM) ConfigURL() string
  • func (pp *VBM) Entry()
  • func (pp *VBM) Init(api types.ModuleAPIClient)
  • func (*VBM) Name() string
  • func (*VBM) NewConfig() proto.Message
  • func (pp *VBM) SetDiscoveryChan(c chan<- types.Event)
  • func (pp *VBM) SetMutationChan(c <-chan types.Event)
  • func (pp *VBM) Stop()
  • func (pp *VBM) UpdateConfig(cfg proto.Message) (e error)

Constants

const (
	VBMBase        string = "/vboxmanage"
	VBMStat        string = VBMBase + "/showvminfo"
	VBMOn          string = VBMBase + "/startvm"
	VBMOff         string = VBMBase + "/controlvm"
	PlatformString string = "vbox"
)

Variables

var (
	ErrInvalidLengthVboxmanage        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowVboxmanage          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupVboxmanage = fmt.Errorf("proto: unexpected end of group")
)

Types

type Config

type Config struct {
	Servers              map[string]*Server `` /* 155-byte string literal not displayed */
	PollingInterval      string             `protobuf:"bytes,2,opt,name=polling_interval,json=pollingInterval,proto3" json:"polling_interval,omitempty"`
	NameUrl              string             `protobuf:"bytes,3,opt,name=name_url,json=nameUrl,proto3" json:"name_url,omitempty"`
	ServerUrl            string             `protobuf:"bytes,4,opt,name=server_url,json=serverUrl,proto3" json:"server_url,omitempty"`
	UuidUrl              string             `protobuf:"bytes,5,opt,name=uuid_url,json=uuidUrl,proto3" json:"uuid_url,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

func (*Config) GetNameUrl

func (m *Config) GetNameUrl() string

func (*Config) GetPollingInterval

func (m *Config) GetPollingInterval() string

func (*Config) GetServerUrl

func (m *Config) GetServerUrl() string

func (*Config) GetServers

func (m *Config) GetServers() map[string]*Server

func (*Config) GetUuidUrl

func (m *Config) GetUuidUrl() string

func (*Config) Marshal

func (m *Config) Marshal() (dAtA []byte, err error)

func (*Config) MarshalTo

func (m *Config) MarshalTo(dAtA []byte) (int, error)

func (*Config) MarshalToSizedBuffer

func (m *Config) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) Reset

func (m *Config) Reset()

func (*Config) Size

func (m *Config) Size() (n int)

func (*Config) String

func (m *Config) String() string

func (*Config) Unmarshal

func (m *Config) Unmarshal(dAtA []byte) error

func (*Config) XXX_DiscardUnknown

func (m *Config) XXX_DiscardUnknown()

func (*Config) XXX_Marshal

func (m *Config) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Config) XXX_Merge

func (m *Config) XXX_Merge(src proto.Message)

func (*Config) XXX_MessageName

func (*Config) XXX_MessageName() string

func (*Config) XXX_Size

func (m *Config) XXX_Size() int

func (*Config) XXX_Unmarshal

func (m *Config) XXX_Unmarshal(b []byte) error

type Server

type Server struct {
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Ip                   string   `protobuf:"bytes,2,opt,name=ip,proto3" json:"ip,omitempty"`
	Port                 int32    `protobuf:"varint,3,opt,name=port,proto3" json:"port,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*Server) Descriptor

func (*Server) Descriptor() ([]byte, []int)

func (*Server) GetIp

func (m *Server) GetIp() string

func (*Server) GetName

func (m *Server) GetName() string

func (*Server) GetPort

func (m *Server) GetPort() int32

func (*Server) Marshal

func (m *Server) Marshal() (dAtA []byte, err error)

func (*Server) MarshalTo

func (m *Server) MarshalTo(dAtA []byte) (int, error)

func (*Server) MarshalToSizedBuffer

func (m *Server) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Server) ProtoMessage

func (*Server) ProtoMessage()

func (*Server) Reset

func (m *Server) Reset()

func (*Server) Size

func (m *Server) Size() (n int)

func (*Server) String

func (m *Server) String() string

func (*Server) Unmarshal

func (m *Server) Unmarshal(dAtA []byte) error

func (*Server) XXX_DiscardUnknown

func (m *Server) XXX_DiscardUnknown()

func (*Server) XXX_Marshal

func (m *Server) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Server) XXX_Merge

func (m *Server) XXX_Merge(src proto.Message)

func (*Server) XXX_MessageName

func (*Server) XXX_MessageName() string

func (*Server) XXX_Size

func (m *Server) XXX_Size() int

func (*Server) XXX_Unmarshal

func (m *Server) XXX_Unmarshal(b []byte) error

type VBM

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

VBM provides a power on/off interface to the vboxmanage-rest-api interface

func (*VBM) ConfigURL

func (*VBM) ConfigURL() string

ConfigURL gives the any resolver URL for the config

func (*VBM) Entry

func (pp *VBM) Entry()

Entry is the module's executable entrypoint

func (*VBM) Init

func (pp *VBM) Init(api types.ModuleAPIClient)

Init is used to intialize an executable module prior to entrypoint

func (*VBM) Name

func (*VBM) Name() string

Name returns the FQDN of the module

func (*VBM) NewConfig

func (*VBM) NewConfig() proto.Message

NewConfig returns a fully initialized default config

func (*VBM) SetDiscoveryChan

func (pp *VBM) SetDiscoveryChan(c chan<- types.Event)

SetDiscoveryChan sets the current discovery channel this is generally done by the API

func (*VBM) SetMutationChan

func (pp *VBM) SetMutationChan(c <-chan types.Event)

SetMutationChan sets the current mutation channel this is generally done by the API

func (*VBM) Stop

func (pp *VBM) Stop()

Stop should perform a graceful exit

func (*VBM) UpdateConfig

func (pp *VBM) UpdateConfig(cfg proto.Message) (e error)

UpdateConfig updates the running config