client

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 21, 2025 License: Apache-2.0 Imports: 18 Imported by: 15

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AcknowledgeVm

func AcknowledgeVm(client srpc.ClientI, ipAddress net.IP) error

func AddVmVolumes

func AddVmVolumes(client srpc.ClientI, ipAddress net.IP, sizes []uint64) error

func BecomePrimaryVmOwner added in v0.8.0

func BecomePrimaryVmOwner(client srpc.ClientI, ipAddress net.IP) error

func ChangeVmConsoleType added in v0.4.0

func ChangeVmConsoleType(client srpc.ClientI, ipAddress net.IP,
	consoleType proto.ConsoleType) error

func ChangeVmCpuPriority added in v0.4.0

func ChangeVmCpuPriority(client srpc.ClientI,
	request proto.ChangeVmCpuPriorityRequest) error

func ChangeVmDestroyProtection added in v0.8.0

func ChangeVmDestroyProtection(client srpc.ClientI, ipAddress net.IP,
	destroyProtection bool) error

func ChangeVmHostname added in v0.8.0

func ChangeVmHostname(client srpc.ClientI, ipAddress net.IP,
	hostname string) error

func ChangeVmMachineType added in v0.4.0

func ChangeVmMachineType(client srpc.ClientI, ipAddress net.IP,
	machineType proto.MachineType) error

func ChangeVmNumNetworkQueues added in v0.10.0

func ChangeVmNumNetworkQueues(client srpc.ClientI, ipAddress net.IP,
	numQueuesPerInterface []uint) error

func ChangeVmOwnerGroups added in v0.8.0

func ChangeVmOwnerGroups(client srpc.ClientI, ipAddress net.IP,
	ownerGroups []string) error

func ChangeVmOwnerUsers added in v0.8.0

func ChangeVmOwnerUsers(client srpc.ClientI, ipAddress net.IP,
	ownerUsers []string) error

func ChangeVmSize

func ChangeVmSize(client srpc.ClientI,
	request proto.ChangeVmSizeRequest) error

func ChangeVmSubnet added in v0.7.0

func ChangeVmSubnet(client srpc.ClientI,
	request proto.ChangeVmSubnetRequest) (proto.ChangeVmSubnetResponse, error)

func ChangeVmTags added in v0.8.0

func ChangeVmTags(client srpc.ClientI, ipAddress net.IP, tgs tags.Tags) error

func ChangeVmVolumeInterfaces added in v0.4.0

func ChangeVmVolumeInterfaces(client srpc.ClientI, ipAddress net.IP,
	volumeInterfaces []proto.VolumeInterface) error

func ChangeVmVolumeSize added in v0.3.2

func ChangeVmVolumeSize(client srpc.ClientI, ipAddress net.IP, index uint,
	size uint64) error

func ChangeVmVolumeStorageIndex added in v0.9.0

func ChangeVmVolumeStorageIndex(client srpc.ClientI, ipAddress net.IP,
	storageIndex, volumeIndex uint) error

func CommitImportedVm added in v0.8.0

func CommitImportedVm(client srpc.ClientI, ipAddress net.IP) error

func ConnectToVmConsole

func ConnectToVmConsole(client srpc.ClientI, ipAddress net.IP,
	vncViewerCommand string, logger log.DebugLogger) error

func ConnectToVmManager added in v0.8.0

func ConnectToVmManager(hypervisorAddress string, ipAddress net.IP,
	connectionHandler func(conn FlushReadWriter) error) error

func ConnectToVmSerialPort added in v0.8.0

func ConnectToVmSerialPort(hypervisorAddress string, ipAddress net.IP,
	serialPortNumber uint,
	connectionHandler func(conn FlushReadWriter) error) error

func CopyVm added in v0.8.0

func CopyVm(client srpc.ClientI, request proto.CopyVmRequest,
	logger log.DebugLogger) (proto.CopyVmResponse, error)

func CreateVm

func CreateVm(client srpc.ClientI, request proto.CreateVmRequest,
	reply *proto.CreateVmResponse, logger log.DebugLogger) error

func DebugVmImage added in v0.8.0

func DebugVmImage(client srpc.ClientI, request proto.DebugVmImageRequest,
	imageReader io.Reader, imageSize int64,
	logger log.DebugLogger) (bool, error)

func DeleteVmVolume

func DeleteVmVolume(client srpc.ClientI, ipAddress net.IP, accessToken []byte,
	volumeIndex uint) error

func DestroyVm

func DestroyVm(client srpc.ClientI, ipAddress net.IP,
	accessToken []byte) error

func DiscardVmAccessToken added in v0.8.0

func DiscardVmAccessToken(client srpc.ClientI, ipAddress net.IP,
	token []byte) error

func DiscardVmOldImage added in v0.8.0

func DiscardVmOldImage(client srpc.ClientI, ipAddress net.IP) error

func DiscardVmOldUserData added in v0.8.0

func DiscardVmOldUserData(client srpc.ClientI, ipAddress net.IP) error

func DiscardVmSnapshot added in v0.8.0

func DiscardVmSnapshot(client srpc.ClientI, ipAddress net.IP,
	name string) error

func ExportLocalVm

func ExportLocalVm(client srpc.ClientI, ipAddress net.IP,
	verificationCookie []byte) (proto.ExportLocalVmInfo, error)

func GetCapacity added in v0.3.4

func GetCapacity(client srpc.ClientI) (proto.GetCapacityResponse, error)

func GetIdentityProvider added in v0.4.0

func GetIdentityProvider(client srpc.ClientI) (string, error)

GetIdentityProvider will get the base URL of the Identity Provider.

func GetPublicKey added in v0.4.0

func GetPublicKey(client srpc.ClientI) ([]byte, error)

GetPublicKey will get the PEM-encoded public key for the Hypervisor.

func GetRootCookiePath

func GetRootCookiePath(client srpc.ClientI) (string, error)

func GetUpdates added in v0.8.0

func GetUpdates(client srpc.ClientI, params GetUpdatesParams) error

func GetVmAccessToken added in v0.8.0

func GetVmAccessToken(client srpc.ClientI, ipAddress net.IP,
	lifetime time.Duration) ([]byte, error)

func GetVmCreateRequest added in v0.8.0

func GetVmCreateRequest(client srpc.ClientI, ipAddress net.IP) (
	proto.CreateVmRequest, error)

func GetVmInfo

func GetVmInfo(client srpc.ClientI, ipAddress net.IP) (proto.VmInfo, error)

func GetVmInfos added in v0.4.0

func GetVmInfos(client srpc.ClientI,
	request proto.GetVmInfosRequest) ([]proto.VmInfo, error)

func GetVmLastPatchLog added in v0.3.4

func GetVmLastPatchLog(client srpc.ClientI, ipAddress net.IP) (
	[]byte, time.Time, error)

func GetVmUserData added in v0.8.0

func GetVmUserData(client srpc.ClientI, ipAddress net.IP,
	accessToken []byte) (io.ReadCloser, uint64, error)

func GetVmVolume added in v0.8.0

func GetVmVolume(client srpc.ClientI, request proto.GetVmVolumeRequest,
	writer io.WriteSeeker, reader io.Reader, initialFileSize, size uint64,
	logger log.DebugLogger) (proto.GetVmVolumeResponse, error)

func GetVmVolumeStorageConfiguration added in v0.9.0

func GetVmVolumeStorageConfiguration(client srpc.ClientI, ipAddress net.IP) (
	proto.GetVmVolumeStorageConfigurationResponse, error)

func HoldLock added in v0.3.3

func HoldLock(client srpc.ClientI, timeout time.Duration,
	writeLock bool) error

func HoldVmLock added in v0.3.3

func HoldVmLock(client srpc.ClientI, ipAddress net.IP, timeout time.Duration,
	writeLock bool) error

func ImportLocalVm added in v0.8.0

func ImportLocalVm(client srpc.ClientI,
	request proto.ImportLocalVmRequest) error

func ListSubnets

func ListSubnets(client srpc.ClientI, doSort bool) ([]proto.Subnet, error)

func ListVMs added in v0.4.0

func ListVMs(client srpc.ClientI,
	request proto.ListVMsRequest) ([]net.IP, error)

func ListVolumeDirectories added in v0.3.4

func ListVolumeDirectories(client srpc.ClientI, doSort bool) ([]string, error)

func MigrateVm added in v0.8.0

func MigrateVm(client srpc.ClientI, request proto.MigrateVmRequest,
	commitFunc func() bool, logger log.DebugLogger) error

func OpenCreateVmConn added in v0.8.0

func OpenCreateVmConn(client srpc.ClientI, request proto.CreateVmRequest) (
	*srpc.Conn, error)

func PatchVmImage added in v0.8.0

func PatchVmImage(client srpc.ClientI, request proto.PatchVmImageRequest,
	logger log.DebugLogger) (bool, error)

func PowerOff

func PowerOff(client srpc.ClientI, stopVMs bool) error

func PrepareVmForMigration

func PrepareVmForMigration(client srpc.ClientI, ipAddress net.IP,
	accessToken []byte, enable bool) error

func ProbeVmPort added in v0.8.0

func ProbeVmPort(client srpc.ClientI, request proto.ProbeVmPortRequest) (
	proto.ProbeVmPortResponse, error)

func ProcessCreateVmResponses added in v0.8.0

func ProcessCreateVmResponses(conn *srpc.Conn,
	logger log.DebugLogger) (proto.CreateVmResponse, error)

func RebootVm added in v0.8.0

func RebootVm(client srpc.ClientI, ipAddress net.IP,
	dhcpTimeout time.Duration) (bool, error)

func RegisterExternalLeases

func RegisterExternalLeases(client srpc.ClientI, addressList proto.AddressList,
	hostnames []string) error

func ReorderVmVolumes added in v0.3.2

func ReorderVmVolumes(client srpc.ClientI, ipAddress net.IP, accessToken []byte,
	volumeIndices []uint) error

func ReplaceVmCredentials added in v0.8.0

func ReplaceVmCredentials(client srpc.ClientI,
	request proto.ReplaceVmCredentialsRequest) error

func ReplaceVmIdentity added in v0.4.0

func ReplaceVmIdentity(client srpc.ClientI,
	request proto.ReplaceVmIdentityRequest) error

func ReplaceVmImage added in v0.8.0

func ReplaceVmImage(client srpc.ClientI, request proto.ReplaceVmImageRequest,
	imageReader io.Reader, logger log.DebugLogger) (bool, error)

func ReplaceVmUserData added in v0.8.0

func ReplaceVmUserData(client srpc.ClientI, ipAddress net.IP,
	userData io.Reader, size uint64, logger log.DebugLogger) error

func RestoreVmFromSnapshot added in v0.8.0

func RestoreVmFromSnapshot(client srpc.ClientI,
	request proto.RestoreVmFromSnapshotRequest) error

func RestoreVmImage added in v0.8.0

func RestoreVmImage(client srpc.ClientI,
	request proto.RestoreVmImageRequest) error

func RestoreVmUserData added in v0.8.0

func RestoreVmUserData(client srpc.ClientI, ipAddress net.IP) error

func ScanVmRoot

func ScanVmRoot(client srpc.ClientI, ipAddress net.IP,
	scanFilter *filter.Filter) (*filesystem.FileSystem, error)

func SetDisabledState added in v0.3.3

func SetDisabledState(client srpc.ClientI, disable bool) error

func SnapshotVm added in v0.8.0

func SnapshotVm(client srpc.ClientI,
	request proto.SnapshotVmRequest) error

func StartVm

func StartVm(client srpc.ClientI, ipAddress net.IP, accessToken []byte) error

func StartVmDhcpTimeout added in v0.8.0

func StartVmDhcpTimeout(client srpc.ClientI, ipAddress net.IP,
	accessToken []byte, dhcpTimeout time.Duration) (bool, error)

func StopVm

func StopVm(client srpc.ClientI, ipAddress net.IP, accessToken []byte) error

func TraceVmMetadata added in v0.8.0

func TraceVmMetadata(client srpc.ClientI, ipAddress net.IP,
	pathHandler func(path string) error) error

func WatchDhcp added in v0.8.0

func WatchDhcp(client srpc.ClientI, request proto.WatchDhcpRequest,
	handlePacket func(ifName string, rawPacket []byte) error) error

Types

type FlushReadWriter added in v0.8.0

type FlushReadWriter interface {
	Flush() error
	io.ReadWriter
}

type GetUpdatesParams added in v0.8.0

type GetUpdatesParams struct {
	ConnectedHandler func() error
	Logger           log.DebugLogger
	RequestsChannel  <-chan proto.GetUpdatesRequest
	UpdateHandler    func(update proto.Update) error
}

Jump to

Keyboard shortcuts

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