vmv1connect

package
v0.0.0-...-94cd6a6 Latest Latest
Warning

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

Go to latest
Published: Apr 17, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// VmServiceAddIpToVmNicProcedure is the fully-qualified name of the VmService's AddIpToVmNic RPC.
	VmServiceAddIpToVmNicProcedure = "/cloudstack.management.vm.v1.VmService/AddIpToVmNic"
	// VmServiceAddNicToVMProcedure is the fully-qualified name of the VmService's AddNicToVM RPC.
	VmServiceAddNicToVMProcedure = "/cloudstack.management.vm.v1.VmService/AddNicToVM"
	// VmServiceAddNicToVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// AddNicToVMCmdByAdmin RPC.
	VmServiceAddNicToVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/AddNicToVMCmdByAdmin"
	// VmServiceAssignVMProcedure is the fully-qualified name of the VmService's AssignVM RPC.
	VmServiceAssignVMProcedure = "/cloudstack.management.vm.v1.VmService/AssignVM"
	// VmServiceCreateVMScheduleProcedure is the fully-qualified name of the VmService's
	// CreateVMSchedule RPC.
	VmServiceCreateVMScheduleProcedure = "/cloudstack.management.vm.v1.VmService/CreateVMSchedule"
	// VmServiceDeleteVMScheduleProcedure is the fully-qualified name of the VmService's
	// DeleteVMSchedule RPC.
	VmServiceDeleteVMScheduleProcedure = "/cloudstack.management.vm.v1.VmService/DeleteVMSchedule"
	// VmServiceDeployVMProcedure is the fully-qualified name of the VmService's DeployVM RPC.
	VmServiceDeployVMProcedure = "/cloudstack.management.vm.v1.VmService/DeployVM"
	// VmServiceDeployVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// DeployVMCmdByAdmin RPC.
	VmServiceDeployVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/DeployVMCmdByAdmin"
	// VmServiceDeployVnfApplianceProcedure is the fully-qualified name of the VmService's
	// DeployVnfAppliance RPC.
	VmServiceDeployVnfApplianceProcedure = "/cloudstack.management.vm.v1.VmService/DeployVnfAppliance"
	// VmServiceDeployVnfApplianceCmdByAdminProcedure is the fully-qualified name of the VmService's
	// DeployVnfApplianceCmdByAdmin RPC.
	VmServiceDeployVnfApplianceCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/DeployVnfApplianceCmdByAdmin"
	// VmServiceDestroyVMProcedure is the fully-qualified name of the VmService's DestroyVM RPC.
	VmServiceDestroyVMProcedure = "/cloudstack.management.vm.v1.VmService/DestroyVM"
	// VmServiceDestroyVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// DestroyVMCmdByAdmin RPC.
	VmServiceDestroyVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/DestroyVMCmdByAdmin"
	// VmServiceExpungeVMProcedure is the fully-qualified name of the VmService's ExpungeVM RPC.
	VmServiceExpungeVMProcedure = "/cloudstack.management.vm.v1.VmService/ExpungeVM"
	// VmServiceGetVMPasswordProcedure is the fully-qualified name of the VmService's GetVMPassword RPC.
	VmServiceGetVMPasswordProcedure = "/cloudstack.management.vm.v1.VmService/GetVMPassword"
	// VmServiceGetVMUserDataProcedure is the fully-qualified name of the VmService's GetVMUserData RPC.
	VmServiceGetVMUserDataProcedure = "/cloudstack.management.vm.v1.VmService/GetVMUserData"
	// VmServiceImportUnmanagedInstanceProcedure is the fully-qualified name of the VmService's
	// ImportUnmanagedInstance RPC.
	VmServiceImportUnmanagedInstanceProcedure = "/cloudstack.management.vm.v1.VmService/ImportUnmanagedInstance"
	// VmServiceImportVmProcedure is the fully-qualified name of the VmService's ImportVm RPC.
	VmServiceImportVmProcedure = "/cloudstack.management.vm.v1.VmService/ImportVm"
	// VmServiceListAffectedVmsForStorageScopeChangeProcedure is the fully-qualified name of the
	// VmService's ListAffectedVmsForStorageScopeChange RPC.
	VmServiceListAffectedVmsForStorageScopeChangeProcedure = "/cloudstack.management.vm.v1.VmService/ListAffectedVmsForStorageScopeChange"
	// VmServiceListNicsProcedure is the fully-qualified name of the VmService's ListNics RPC.
	VmServiceListNicsProcedure = "/cloudstack.management.vm.v1.VmService/ListNics"
	// VmServiceListUnmanagedInstancesProcedure is the fully-qualified name of the VmService's
	// ListUnmanagedInstances RPC.
	VmServiceListUnmanagedInstancesProcedure = "/cloudstack.management.vm.v1.VmService/ListUnmanagedInstances"
	// VmServiceListVMScheduleProcedure is the fully-qualified name of the VmService's ListVMSchedule
	// RPC.
	VmServiceListVMScheduleProcedure = "/cloudstack.management.vm.v1.VmService/ListVMSchedule"
	// VmServiceListVMsProcedure is the fully-qualified name of the VmService's ListVMs RPC.
	VmServiceListVMsProcedure = "/cloudstack.management.vm.v1.VmService/ListVMs"
	// VmServiceListVMsCmdByAdminProcedure is the fully-qualified name of the VmService's
	// ListVMsCmdByAdmin RPC.
	VmServiceListVMsCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/ListVMsCmdByAdmin"
	// VmServiceListVmsForImportProcedure is the fully-qualified name of the VmService's
	// ListVmsForImport RPC.
	VmServiceListVmsForImportProcedure = "/cloudstack.management.vm.v1.VmService/ListVmsForImport"
	// VmServiceListVnfAppliancesProcedure is the fully-qualified name of the VmService's
	// ListVnfAppliances RPC.
	VmServiceListVnfAppliancesProcedure = "/cloudstack.management.vm.v1.VmService/ListVnfAppliances"
	// VmServiceListVnfAppliancesCmdByAdminProcedure is the fully-qualified name of the VmService's
	// ListVnfAppliancesCmdByAdmin RPC.
	VmServiceListVnfAppliancesCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/ListVnfAppliancesCmdByAdmin"
	// VmServiceMigrateVMProcedure is the fully-qualified name of the VmService's MigrateVM RPC.
	VmServiceMigrateVMProcedure = "/cloudstack.management.vm.v1.VmService/MigrateVM"
	// VmServiceMigrateVirtualMachineWithVolumeProcedure is the fully-qualified name of the VmService's
	// MigrateVirtualMachineWithVolume RPC.
	VmServiceMigrateVirtualMachineWithVolumeProcedure = "/cloudstack.management.vm.v1.VmService/MigrateVirtualMachineWithVolume"
	// VmServiceRebootVMProcedure is the fully-qualified name of the VmService's RebootVM RPC.
	VmServiceRebootVMProcedure = "/cloudstack.management.vm.v1.VmService/RebootVM"
	// VmServiceRebootVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// RebootVMCmdByAdmin RPC.
	VmServiceRebootVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/RebootVMCmdByAdmin"
	// VmServiceRecoverVMProcedure is the fully-qualified name of the VmService's RecoverVM RPC.
	VmServiceRecoverVMProcedure = "/cloudstack.management.vm.v1.VmService/RecoverVM"
	// VmServiceRemoveIpFromVmNicProcedure is the fully-qualified name of the VmService's
	// RemoveIpFromVmNic RPC.
	VmServiceRemoveIpFromVmNicProcedure = "/cloudstack.management.vm.v1.VmService/RemoveIpFromVmNic"
	// VmServiceRemoveNicFromVMProcedure is the fully-qualified name of the VmService's RemoveNicFromVM
	// RPC.
	VmServiceRemoveNicFromVMProcedure = "/cloudstack.management.vm.v1.VmService/RemoveNicFromVM"
	// VmServiceRemoveNicFromVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// RemoveNicFromVMCmdByAdmin RPC.
	VmServiceRemoveNicFromVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/RemoveNicFromVMCmdByAdmin"
	// VmServiceResetVMPasswordProcedure is the fully-qualified name of the VmService's ResetVMPassword
	// RPC.
	VmServiceResetVMPasswordProcedure = "/cloudstack.management.vm.v1.VmService/ResetVMPassword"
	// VmServiceResetVMPasswordCmdByAdminProcedure is the fully-qualified name of the VmService's
	// ResetVMPasswordCmdByAdmin RPC.
	VmServiceResetVMPasswordCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/ResetVMPasswordCmdByAdmin"
	// VmServiceResetVMSSHKeyProcedure is the fully-qualified name of the VmService's ResetVMSSHKey RPC.
	VmServiceResetVMSSHKeyProcedure = "/cloudstack.management.vm.v1.VmService/ResetVMSSHKey"
	// VmServiceResetVMSSHKeyCmdByAdminProcedure is the fully-qualified name of the VmService's
	// ResetVMSSHKeyCmdByAdmin RPC.
	VmServiceResetVMSSHKeyCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/ResetVMSSHKeyCmdByAdmin"
	// VmServiceResetVMUserDataProcedure is the fully-qualified name of the VmService's ResetVMUserData
	// RPC.
	VmServiceResetVMUserDataProcedure = "/cloudstack.management.vm.v1.VmService/ResetVMUserData"
	// VmServiceResetVMUserDataCmdAdminProcedure is the fully-qualified name of the VmService's
	// ResetVMUserDataCmdAdmin RPC.
	VmServiceResetVMUserDataCmdAdminProcedure = "/cloudstack.management.vm.v1.VmService/ResetVMUserDataCmdAdmin"
	// VmServiceRestoreVMProcedure is the fully-qualified name of the VmService's RestoreVM RPC.
	VmServiceRestoreVMProcedure = "/cloudstack.management.vm.v1.VmService/RestoreVM"
	// VmServiceRestoreVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// RestoreVMCmdByAdmin RPC.
	VmServiceRestoreVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/RestoreVMCmdByAdmin"
	// VmServiceScaleVMProcedure is the fully-qualified name of the VmService's ScaleVM RPC.
	VmServiceScaleVMProcedure = "/cloudstack.management.vm.v1.VmService/ScaleVM"
	// VmServiceScaleVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// ScaleVMCmdByAdmin RPC.
	VmServiceScaleVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/ScaleVMCmdByAdmin"
	// VmServiceStartVMProcedure is the fully-qualified name of the VmService's StartVM RPC.
	VmServiceStartVMProcedure = "/cloudstack.management.vm.v1.VmService/StartVM"
	// VmServiceStartVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// StartVMCmdByAdmin RPC.
	VmServiceStartVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/StartVMCmdByAdmin"
	// VmServiceStopVMProcedure is the fully-qualified name of the VmService's StopVM RPC.
	VmServiceStopVMProcedure = "/cloudstack.management.vm.v1.VmService/StopVM"
	// VmServiceStopVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// StopVMCmdByAdmin RPC.
	VmServiceStopVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/StopVMCmdByAdmin"
	// VmServiceUnmanageVMInstanceProcedure is the fully-qualified name of the VmService's
	// UnmanageVMInstance RPC.
	VmServiceUnmanageVMInstanceProcedure = "/cloudstack.management.vm.v1.VmService/UnmanageVMInstance"
	// VmServiceUpdateDefaultNicForVMProcedure is the fully-qualified name of the VmService's
	// UpdateDefaultNicForVM RPC.
	VmServiceUpdateDefaultNicForVMProcedure = "/cloudstack.management.vm.v1.VmService/UpdateDefaultNicForVM"
	// VmServiceUpdateDefaultNicForVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// UpdateDefaultNicForVMCmdByAdmin RPC.
	VmServiceUpdateDefaultNicForVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/UpdateDefaultNicForVMCmdByAdmin"
	// VmServiceUpdateVMProcedure is the fully-qualified name of the VmService's UpdateVM RPC.
	VmServiceUpdateVMProcedure = "/cloudstack.management.vm.v1.VmService/UpdateVM"
	// VmServiceUpdateVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// UpdateVMCmdByAdmin RPC.
	VmServiceUpdateVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/UpdateVMCmdByAdmin"
	// VmServiceUpdateVMScheduleProcedure is the fully-qualified name of the VmService's
	// UpdateVMSchedule RPC.
	VmServiceUpdateVMScheduleProcedure = "/cloudstack.management.vm.v1.VmService/UpdateVMSchedule"
	// VmServiceUpdateVmNicIpProcedure is the fully-qualified name of the VmService's UpdateVmNicIp RPC.
	VmServiceUpdateVmNicIpProcedure = "/cloudstack.management.vm.v1.VmService/UpdateVmNicIp"
	// VmServiceUpgradeVMProcedure is the fully-qualified name of the VmService's UpgradeVM RPC.
	VmServiceUpgradeVMProcedure = "/cloudstack.management.vm.v1.VmService/UpgradeVM"
	// VmServiceUpgradeVMCmdByAdminProcedure is the fully-qualified name of the VmService's
	// UpgradeVMCmdByAdmin RPC.
	VmServiceUpgradeVMCmdByAdminProcedure = "/cloudstack.management.vm.v1.VmService/UpgradeVMCmdByAdmin"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// VmServiceName is the fully-qualified name of the VmService service.
	VmServiceName = "cloudstack.management.vm.v1.VmService"
)

Variables

This section is empty.

Functions

func NewVmServiceHandler

func NewVmServiceHandler(svc VmServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewVmServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type UnimplementedVmServiceHandler

type UnimplementedVmServiceHandler struct{}

UnimplementedVmServiceHandler returns CodeUnimplemented from all methods.

type VmServiceClient

type VmServiceClient interface {
	// AddIpToVmNic Assigns secondary IP to NIC
	AddIpToVmNic(context.Context, *connect.Request[v1.AddIpToVmNicRequest]) (*connect.Response[v1.AddIpToVmNicResponse], error)
	// AddNicToVM Adds VM to specified network by creating a NIC
	AddNicToVM(context.Context, *connect.Request[v1.AddNicToVMRequest]) (*connect.Response[v1.AddNicToVMResponse], error)
	// AddNicToVMCmdByAdmin Adds VM to specified network by creating a NIC
	AddNicToVMCmdByAdmin(context.Context, *connect.Request[v1.AddNicToVMCmdByAdminRequest]) (*connect.Response[v1.AddNicToVMCmdByAdminResponse], error)
	// AssignVM Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.
	AssignVM(context.Context, *connect.Request[v1.AssignVMRequest]) (*connect.Response[v1.AssignVMResponse], error)
	// CreateVMSchedule Create VM Schedule
	CreateVMSchedule(context.Context, *connect.Request[v1.CreateVMScheduleRequest]) (*connect.Response[v1.CreateVMScheduleResponse], error)
	// DeleteVMSchedule Delete VM Schedule.
	DeleteVMSchedule(context.Context, *connect.Request[v1.DeleteVMScheduleRequest]) (*connect.Response[v1.DeleteVMScheduleResponse], error)
	// DeployVM Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.
	DeployVM(context.Context, *connect.Request[v1.DeployVMRequest]) (*connect.Response[v1.DeployVMResponse], error)
	// DeployVMCmdByAdmin Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.
	DeployVMCmdByAdmin(context.Context, *connect.Request[v1.DeployVMCmdByAdminRequest]) (*connect.Response[v1.DeployVMCmdByAdminResponse], error)
	// DeployVnfAppliance Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.
	DeployVnfAppliance(context.Context, *connect.Request[v1.DeployVnfApplianceRequest]) (*connect.Response[v1.DeployVnfApplianceResponse], error)
	// DeployVnfApplianceCmdByAdmin Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.
	DeployVnfApplianceCmdByAdmin(context.Context, *connect.Request[v1.DeployVnfApplianceCmdByAdminRequest]) (*connect.Response[v1.DeployVnfApplianceCmdByAdminResponse], error)
	// DestroyVM Destroys a virtual machine.
	DestroyVM(context.Context, *connect.Request[v1.DestroyVMRequest]) (*connect.Response[v1.DestroyVMResponse], error)
	// DestroyVMCmdByAdmin Destroys a virtual machine. Once destroyed, only the administrator can recover it.
	DestroyVMCmdByAdmin(context.Context, *connect.Request[v1.DestroyVMCmdByAdminRequest]) (*connect.Response[v1.DestroyVMCmdByAdminResponse], error)
	// ExpungeVM Expunge a virtual machine. Once expunged, it cannot be recoverd.
	ExpungeVM(context.Context, *connect.Request[v1.ExpungeVMRequest]) (*connect.Response[v1.ExpungeVMResponse], error)
	// GetVMPassword Returns an encrypted password for the VM
	GetVMPassword(context.Context, *connect.Request[v1.GetVMPasswordRequest]) (*connect.Response[v1.GetVMPasswordResponse], error)
	// GetVMUserData Returns user data associated with the VM
	GetVMUserData(context.Context, *connect.Request[v1.GetVMUserDataRequest]) (*connect.Response[v1.GetVMUserDataResponse], error)
	// ImportUnmanagedInstance Import unmanaged virtual machine from a given cluster.
	ImportUnmanagedInstance(context.Context, *connect.Request[v1.ImportUnmanagedInstanceRequest]) (*connect.Response[v1.ImportUnmanagedInstanceResponse], error)
	// ImportVm Import virtual machine from a unmanaged host into CloudStack
	ImportVm(context.Context, *connect.Request[v1.ImportVmRequest]) (*connect.Response[v1.ImportVmResponse], error)
	// ListAffectedVmsForStorageScopeChange List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster.
	ListAffectedVmsForStorageScopeChange(context.Context, *connect.Request[v1.ListAffectedVmsForStorageScopeChangeRequest]) (*connect.Response[v1.ListAffectedVmsForStorageScopeChangeResponse], error)
	// ListNics list the vm nics  IP to NIC
	ListNics(context.Context, *connect.Request[v1.ListNicsRequest]) (*connect.Response[v1.ListNicsResponse], error)
	// ListUnmanagedInstances Lists unmanaged virtual machines for a given cluster.
	ListUnmanagedInstances(context.Context, *connect.Request[v1.ListUnmanagedInstancesRequest]) (*connect.Response[v1.ListUnmanagedInstancesResponse], error)
	// ListVMSchedule List VM Schedules.
	ListVMSchedule(context.Context, *connect.Request[v1.ListVMScheduleRequest]) (*connect.Response[v1.ListVMScheduleResponse], error)
	// ListVMs List the virtual machines owned by the account.
	ListVMs(context.Context, *connect.Request[v1.ListVMsRequest]) (*connect.Response[v1.ListVMsResponse], error)
	// ListVMsCmdByAdmin List the virtual machines owned by the account.
	ListVMsCmdByAdmin(context.Context, *connect.Request[v1.ListVMsCmdByAdminRequest]) (*connect.Response[v1.ListVMsCmdByAdminResponse], error)
	// ListVmsForImport Lists virtual machines on a unmanaged host
	ListVmsForImport(context.Context, *connect.Request[v1.ListVmsForImportRequest]) (*connect.Response[v1.ListVmsForImportResponse], error)
	// ListVnfAppliances List VNF appliance owned by the account.
	ListVnfAppliances(context.Context, *connect.Request[v1.ListVnfAppliancesRequest]) (*connect.Response[v1.ListVnfAppliancesResponse], error)
	// ListVnfAppliancesCmdByAdmin List VNF appliance owned by the account.
	ListVnfAppliancesCmdByAdmin(context.Context, *connect.Request[v1.ListVnfAppliancesCmdByAdminRequest]) (*connect.Response[v1.ListVnfAppliancesCmdByAdminResponse], error)
	// MigrateVM Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool
	MigrateVM(context.Context, *connect.Request[v1.MigrateVMRequest]) (*connect.Response[v1.MigrateVMResponse], error)
	// MigrateVirtualMachineWithVolume Attempts Migration of a VM with its volumes to a different host
	MigrateVirtualMachineWithVolume(context.Context, *connect.Request[v1.MigrateVirtualMachineWithVolumeRequest]) (*connect.Response[v1.MigrateVirtualMachineWithVolumeResponse], error)
	// RebootVM Reboots a virtual machine.
	RebootVM(context.Context, *connect.Request[v1.RebootVMRequest]) (*connect.Response[v1.RebootVMResponse], error)
	// RebootVMCmdByAdmin Reboots a virtual machine.
	RebootVMCmdByAdmin(context.Context, *connect.Request[v1.RebootVMCmdByAdminRequest]) (*connect.Response[v1.RebootVMCmdByAdminResponse], error)
	// RecoverVM Recovers a virtual machine.
	RecoverVM(context.Context, *connect.Request[v1.RecoverVMRequest]) (*connect.Response[v1.RecoverVMResponse], error)
	// RemoveIpFromVmNic Removes secondary IP from the NIC.
	RemoveIpFromVmNic(context.Context, *connect.Request[v1.RemoveIpFromVmNicRequest]) (*connect.Response[v1.RemoveIpFromVmNicResponse], error)
	// RemoveNicFromVM Removes VM from specified network by deleting a NIC
	RemoveNicFromVM(context.Context, *connect.Request[v1.RemoveNicFromVMRequest]) (*connect.Response[v1.RemoveNicFromVMResponse], error)
	// RemoveNicFromVMCmdByAdmin Removes VM from specified network by deleting a NIC
	RemoveNicFromVMCmdByAdmin(context.Context, *connect.Request[v1.RemoveNicFromVMCmdByAdminRequest]) (*connect.Response[v1.RemoveNicFromVMCmdByAdminResponse], error)
	// ResetVMPassword Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async]
	ResetVMPassword(context.Context, *connect.Request[v1.ResetVMPasswordRequest]) (*connect.Response[v1.ResetVMPasswordResponse], error)
	// ResetVMPasswordCmdByAdmin Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async]
	ResetVMPasswordCmdByAdmin(context.Context, *connect.Request[v1.ResetVMPasswordCmdByAdminRequest]) (*connect.Response[v1.ResetVMPasswordCmdByAdminResponse], error)
	// ResetVMSSHKey Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async]
	ResetVMSSHKey(context.Context, *connect.Request[v1.ResetVMSSHKeyRequest]) (*connect.Response[v1.ResetVMSSHKeyResponse], error)
	// ResetVMSSHKeyCmdByAdmin Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async]
	ResetVMSSHKeyCmdByAdmin(context.Context, *connect.Request[v1.ResetVMSSHKeyCmdByAdminRequest]) (*connect.Response[v1.ResetVMSSHKeyCmdByAdminResponse], error)
	// ResetVMUserData Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state.
	ResetVMUserData(context.Context, *connect.Request[v1.ResetVMUserDataRequest]) (*connect.Response[v1.ResetVMUserDataResponse], error)
	// ResetVMUserDataCmdAdmin Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state. [async]
	ResetVMUserDataCmdAdmin(context.Context, *connect.Request[v1.ResetVMUserDataCmdAdminRequest]) (*connect.Response[v1.ResetVMUserDataCmdAdminResponse], error)
	// RestoreVM Restore a VM to original template/ISO or new template/ISO
	RestoreVM(context.Context, *connect.Request[v1.RestoreVMRequest]) (*connect.Response[v1.RestoreVMResponse], error)
	// RestoreVMCmdByAdmin Restore a VM to original template/ISO or new template/ISO
	RestoreVMCmdByAdmin(context.Context, *connect.Request[v1.RestoreVMCmdByAdminRequest]) (*connect.Response[v1.RestoreVMCmdByAdminResponse], error)
	// ScaleVM Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.
	ScaleVM(context.Context, *connect.Request[v1.ScaleVMRequest]) (*connect.Response[v1.ScaleVMResponse], error)
	// ScaleVMCmdByAdmin Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.
	ScaleVMCmdByAdmin(context.Context, *connect.Request[v1.ScaleVMCmdByAdminRequest]) (*connect.Response[v1.ScaleVMCmdByAdminResponse], error)
	// StartVM Starts a virtual machine.
	StartVM(context.Context, *connect.Request[v1.StartVMRequest]) (*connect.Response[v1.StartVMResponse], error)
	// StartVMCmdByAdmin Starts a virtual machine.
	StartVMCmdByAdmin(context.Context, *connect.Request[v1.StartVMCmdByAdminRequest]) (*connect.Response[v1.StartVMCmdByAdminResponse], error)
	// StopVM Stops a virtual machine.
	StopVM(context.Context, *connect.Request[v1.StopVMRequest]) (*connect.Response[v1.StopVMResponse], error)
	// StopVMCmdByAdmin Stops a virtual machine.
	StopVMCmdByAdmin(context.Context, *connect.Request[v1.StopVMCmdByAdminRequest]) (*connect.Response[v1.StopVMCmdByAdminResponse], error)
	// UnmanageVMInstance Unmanage a guest virtual machine.
	UnmanageVMInstance(context.Context, *connect.Request[v1.UnmanageVMInstanceRequest]) (*connect.Response[v1.UnmanageVMInstanceResponse], error)
	// UpdateDefaultNicForVM Changes the default NIC on a VM
	UpdateDefaultNicForVM(context.Context, *connect.Request[v1.UpdateDefaultNicForVMRequest]) (*connect.Response[v1.UpdateDefaultNicForVMResponse], error)
	// UpdateDefaultNicForVMCmdByAdmin Changes the default NIC on a VM
	UpdateDefaultNicForVMCmdByAdmin(context.Context, *connect.Request[v1.UpdateDefaultNicForVMCmdByAdminRequest]) (*connect.Response[v1.UpdateDefaultNicForVMCmdByAdminResponse], error)
	// UpdateVM Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.
	UpdateVM(context.Context, *connect.Request[v1.UpdateVMRequest]) (*connect.Response[v1.UpdateVMResponse], error)
	// UpdateVMCmdByAdmin Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.
	UpdateVMCmdByAdmin(context.Context, *connect.Request[v1.UpdateVMCmdByAdminRequest]) (*connect.Response[v1.UpdateVMCmdByAdminResponse], error)
	// UpdateVMSchedule Update VM Schedule.
	UpdateVMSchedule(context.Context, *connect.Request[v1.UpdateVMScheduleRequest]) (*connect.Response[v1.UpdateVMScheduleResponse], error)
	// UpdateVmNicIp Update the default Ip of a VM Nic
	UpdateVmNicIp(context.Context, *connect.Request[v1.UpdateVmNicIpRequest]) (*connect.Response[v1.UpdateVmNicIpResponse], error)
	// UpgradeVM (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect.
	UpgradeVM(context.Context, *connect.Request[v1.UpgradeVMRequest]) (*connect.Response[v1.UpgradeVMResponse], error)
	// UpgradeVMCmdByAdmin (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect.
	UpgradeVMCmdByAdmin(context.Context, *connect.Request[v1.UpgradeVMCmdByAdminRequest]) (*connect.Response[v1.UpgradeVMCmdByAdminResponse], error)
}

VmServiceClient is a client for the cloudstack.management.vm.v1.VmService service.

func NewVmServiceClient

func NewVmServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) VmServiceClient

NewVmServiceClient constructs a client for the cloudstack.management.vm.v1.VmService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type VmServiceHandler

type VmServiceHandler interface {
	// AddIpToVmNic Assigns secondary IP to NIC
	AddIpToVmNic(context.Context, *connect.Request[v1.AddIpToVmNicRequest]) (*connect.Response[v1.AddIpToVmNicResponse], error)
	// AddNicToVM Adds VM to specified network by creating a NIC
	AddNicToVM(context.Context, *connect.Request[v1.AddNicToVMRequest]) (*connect.Response[v1.AddNicToVMResponse], error)
	// AddNicToVMCmdByAdmin Adds VM to specified network by creating a NIC
	AddNicToVMCmdByAdmin(context.Context, *connect.Request[v1.AddNicToVMCmdByAdminRequest]) (*connect.Response[v1.AddNicToVMCmdByAdminResponse], error)
	// AssignVM Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.
	AssignVM(context.Context, *connect.Request[v1.AssignVMRequest]) (*connect.Response[v1.AssignVMResponse], error)
	// CreateVMSchedule Create VM Schedule
	CreateVMSchedule(context.Context, *connect.Request[v1.CreateVMScheduleRequest]) (*connect.Response[v1.CreateVMScheduleResponse], error)
	// DeleteVMSchedule Delete VM Schedule.
	DeleteVMSchedule(context.Context, *connect.Request[v1.DeleteVMScheduleRequest]) (*connect.Response[v1.DeleteVMScheduleResponse], error)
	// DeployVM Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.
	DeployVM(context.Context, *connect.Request[v1.DeployVMRequest]) (*connect.Response[v1.DeployVMResponse], error)
	// DeployVMCmdByAdmin Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.
	DeployVMCmdByAdmin(context.Context, *connect.Request[v1.DeployVMCmdByAdminRequest]) (*connect.Response[v1.DeployVMCmdByAdminResponse], error)
	// DeployVnfAppliance Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.
	DeployVnfAppliance(context.Context, *connect.Request[v1.DeployVnfApplianceRequest]) (*connect.Response[v1.DeployVnfApplianceResponse], error)
	// DeployVnfApplianceCmdByAdmin Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.
	DeployVnfApplianceCmdByAdmin(context.Context, *connect.Request[v1.DeployVnfApplianceCmdByAdminRequest]) (*connect.Response[v1.DeployVnfApplianceCmdByAdminResponse], error)
	// DestroyVM Destroys a virtual machine.
	DestroyVM(context.Context, *connect.Request[v1.DestroyVMRequest]) (*connect.Response[v1.DestroyVMResponse], error)
	// DestroyVMCmdByAdmin Destroys a virtual machine. Once destroyed, only the administrator can recover it.
	DestroyVMCmdByAdmin(context.Context, *connect.Request[v1.DestroyVMCmdByAdminRequest]) (*connect.Response[v1.DestroyVMCmdByAdminResponse], error)
	// ExpungeVM Expunge a virtual machine. Once expunged, it cannot be recoverd.
	ExpungeVM(context.Context, *connect.Request[v1.ExpungeVMRequest]) (*connect.Response[v1.ExpungeVMResponse], error)
	// GetVMPassword Returns an encrypted password for the VM
	GetVMPassword(context.Context, *connect.Request[v1.GetVMPasswordRequest]) (*connect.Response[v1.GetVMPasswordResponse], error)
	// GetVMUserData Returns user data associated with the VM
	GetVMUserData(context.Context, *connect.Request[v1.GetVMUserDataRequest]) (*connect.Response[v1.GetVMUserDataResponse], error)
	// ImportUnmanagedInstance Import unmanaged virtual machine from a given cluster.
	ImportUnmanagedInstance(context.Context, *connect.Request[v1.ImportUnmanagedInstanceRequest]) (*connect.Response[v1.ImportUnmanagedInstanceResponse], error)
	// ImportVm Import virtual machine from a unmanaged host into CloudStack
	ImportVm(context.Context, *connect.Request[v1.ImportVmRequest]) (*connect.Response[v1.ImportVmResponse], error)
	// ListAffectedVmsForStorageScopeChange List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster.
	ListAffectedVmsForStorageScopeChange(context.Context, *connect.Request[v1.ListAffectedVmsForStorageScopeChangeRequest]) (*connect.Response[v1.ListAffectedVmsForStorageScopeChangeResponse], error)
	// ListNics list the vm nics  IP to NIC
	ListNics(context.Context, *connect.Request[v1.ListNicsRequest]) (*connect.Response[v1.ListNicsResponse], error)
	// ListUnmanagedInstances Lists unmanaged virtual machines for a given cluster.
	ListUnmanagedInstances(context.Context, *connect.Request[v1.ListUnmanagedInstancesRequest]) (*connect.Response[v1.ListUnmanagedInstancesResponse], error)
	// ListVMSchedule List VM Schedules.
	ListVMSchedule(context.Context, *connect.Request[v1.ListVMScheduleRequest]) (*connect.Response[v1.ListVMScheduleResponse], error)
	// ListVMs List the virtual machines owned by the account.
	ListVMs(context.Context, *connect.Request[v1.ListVMsRequest]) (*connect.Response[v1.ListVMsResponse], error)
	// ListVMsCmdByAdmin List the virtual machines owned by the account.
	ListVMsCmdByAdmin(context.Context, *connect.Request[v1.ListVMsCmdByAdminRequest]) (*connect.Response[v1.ListVMsCmdByAdminResponse], error)
	// ListVmsForImport Lists virtual machines on a unmanaged host
	ListVmsForImport(context.Context, *connect.Request[v1.ListVmsForImportRequest]) (*connect.Response[v1.ListVmsForImportResponse], error)
	// ListVnfAppliances List VNF appliance owned by the account.
	ListVnfAppliances(context.Context, *connect.Request[v1.ListVnfAppliancesRequest]) (*connect.Response[v1.ListVnfAppliancesResponse], error)
	// ListVnfAppliancesCmdByAdmin List VNF appliance owned by the account.
	ListVnfAppliancesCmdByAdmin(context.Context, *connect.Request[v1.ListVnfAppliancesCmdByAdminRequest]) (*connect.Response[v1.ListVnfAppliancesCmdByAdminResponse], error)
	// MigrateVM Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool
	MigrateVM(context.Context, *connect.Request[v1.MigrateVMRequest]) (*connect.Response[v1.MigrateVMResponse], error)
	// MigrateVirtualMachineWithVolume Attempts Migration of a VM with its volumes to a different host
	MigrateVirtualMachineWithVolume(context.Context, *connect.Request[v1.MigrateVirtualMachineWithVolumeRequest]) (*connect.Response[v1.MigrateVirtualMachineWithVolumeResponse], error)
	// RebootVM Reboots a virtual machine.
	RebootVM(context.Context, *connect.Request[v1.RebootVMRequest]) (*connect.Response[v1.RebootVMResponse], error)
	// RebootVMCmdByAdmin Reboots a virtual machine.
	RebootVMCmdByAdmin(context.Context, *connect.Request[v1.RebootVMCmdByAdminRequest]) (*connect.Response[v1.RebootVMCmdByAdminResponse], error)
	// RecoverVM Recovers a virtual machine.
	RecoverVM(context.Context, *connect.Request[v1.RecoverVMRequest]) (*connect.Response[v1.RecoverVMResponse], error)
	// RemoveIpFromVmNic Removes secondary IP from the NIC.
	RemoveIpFromVmNic(context.Context, *connect.Request[v1.RemoveIpFromVmNicRequest]) (*connect.Response[v1.RemoveIpFromVmNicResponse], error)
	// RemoveNicFromVM Removes VM from specified network by deleting a NIC
	RemoveNicFromVM(context.Context, *connect.Request[v1.RemoveNicFromVMRequest]) (*connect.Response[v1.RemoveNicFromVMResponse], error)
	// RemoveNicFromVMCmdByAdmin Removes VM from specified network by deleting a NIC
	RemoveNicFromVMCmdByAdmin(context.Context, *connect.Request[v1.RemoveNicFromVMCmdByAdminRequest]) (*connect.Response[v1.RemoveNicFromVMCmdByAdminResponse], error)
	// ResetVMPassword Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async]
	ResetVMPassword(context.Context, *connect.Request[v1.ResetVMPasswordRequest]) (*connect.Response[v1.ResetVMPasswordResponse], error)
	// ResetVMPasswordCmdByAdmin Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect. [async]
	ResetVMPasswordCmdByAdmin(context.Context, *connect.Request[v1.ResetVMPasswordCmdByAdminRequest]) (*connect.Response[v1.ResetVMPasswordCmdByAdminResponse], error)
	// ResetVMSSHKey Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async]
	ResetVMSSHKey(context.Context, *connect.Request[v1.ResetVMSSHKeyRequest]) (*connect.Response[v1.ResetVMSSHKeyResponse], error)
	// ResetVMSSHKeyCmdByAdmin Resets the SSH Key for virtual machine. The virtual machine must be in a "Stopped" state. [async]
	ResetVMSSHKeyCmdByAdmin(context.Context, *connect.Request[v1.ResetVMSSHKeyCmdByAdminRequest]) (*connect.Response[v1.ResetVMSSHKeyCmdByAdminResponse], error)
	// ResetVMUserData Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state.
	ResetVMUserData(context.Context, *connect.Request[v1.ResetVMUserDataRequest]) (*connect.Response[v1.ResetVMUserDataResponse], error)
	// ResetVMUserDataCmdAdmin Resets the UserData for virtual machine. The virtual machine must be in a "Stopped" state. [async]
	ResetVMUserDataCmdAdmin(context.Context, *connect.Request[v1.ResetVMUserDataCmdAdminRequest]) (*connect.Response[v1.ResetVMUserDataCmdAdminResponse], error)
	// RestoreVM Restore a VM to original template/ISO or new template/ISO
	RestoreVM(context.Context, *connect.Request[v1.RestoreVMRequest]) (*connect.Response[v1.RestoreVMResponse], error)
	// RestoreVMCmdByAdmin Restore a VM to original template/ISO or new template/ISO
	RestoreVMCmdByAdmin(context.Context, *connect.Request[v1.RestoreVMCmdByAdminRequest]) (*connect.Response[v1.RestoreVMCmdByAdminResponse], error)
	// ScaleVM Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.
	ScaleVM(context.Context, *connect.Request[v1.ScaleVMRequest]) (*connect.Response[v1.ScaleVMResponse], error)
	// ScaleVMCmdByAdmin Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.
	ScaleVMCmdByAdmin(context.Context, *connect.Request[v1.ScaleVMCmdByAdminRequest]) (*connect.Response[v1.ScaleVMCmdByAdminResponse], error)
	// StartVM Starts a virtual machine.
	StartVM(context.Context, *connect.Request[v1.StartVMRequest]) (*connect.Response[v1.StartVMResponse], error)
	// StartVMCmdByAdmin Starts a virtual machine.
	StartVMCmdByAdmin(context.Context, *connect.Request[v1.StartVMCmdByAdminRequest]) (*connect.Response[v1.StartVMCmdByAdminResponse], error)
	// StopVM Stops a virtual machine.
	StopVM(context.Context, *connect.Request[v1.StopVMRequest]) (*connect.Response[v1.StopVMResponse], error)
	// StopVMCmdByAdmin Stops a virtual machine.
	StopVMCmdByAdmin(context.Context, *connect.Request[v1.StopVMCmdByAdminRequest]) (*connect.Response[v1.StopVMCmdByAdminResponse], error)
	// UnmanageVMInstance Unmanage a guest virtual machine.
	UnmanageVMInstance(context.Context, *connect.Request[v1.UnmanageVMInstanceRequest]) (*connect.Response[v1.UnmanageVMInstanceResponse], error)
	// UpdateDefaultNicForVM Changes the default NIC on a VM
	UpdateDefaultNicForVM(context.Context, *connect.Request[v1.UpdateDefaultNicForVMRequest]) (*connect.Response[v1.UpdateDefaultNicForVMResponse], error)
	// UpdateDefaultNicForVMCmdByAdmin Changes the default NIC on a VM
	UpdateDefaultNicForVMCmdByAdmin(context.Context, *connect.Request[v1.UpdateDefaultNicForVMCmdByAdminRequest]) (*connect.Response[v1.UpdateDefaultNicForVMCmdByAdminResponse], error)
	// UpdateVM Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.
	UpdateVM(context.Context, *connect.Request[v1.UpdateVMRequest]) (*connect.Response[v1.UpdateVMResponse], error)
	// UpdateVMCmdByAdmin Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.
	UpdateVMCmdByAdmin(context.Context, *connect.Request[v1.UpdateVMCmdByAdminRequest]) (*connect.Response[v1.UpdateVMCmdByAdminResponse], error)
	// UpdateVMSchedule Update VM Schedule.
	UpdateVMSchedule(context.Context, *connect.Request[v1.UpdateVMScheduleRequest]) (*connect.Response[v1.UpdateVMScheduleResponse], error)
	// UpdateVmNicIp Update the default Ip of a VM Nic
	UpdateVmNicIp(context.Context, *connect.Request[v1.UpdateVmNicIpRequest]) (*connect.Response[v1.UpdateVmNicIpResponse], error)
	// UpgradeVM (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect.
	UpgradeVM(context.Context, *connect.Request[v1.UpgradeVMRequest]) (*connect.Response[v1.UpgradeVMResponse], error)
	// UpgradeVMCmdByAdmin (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect.
	UpgradeVMCmdByAdmin(context.Context, *connect.Request[v1.UpgradeVMCmdByAdminRequest]) (*connect.Response[v1.UpgradeVMCmdByAdminResponse], error)
}

VmServiceHandler is an implementation of the cloudstack.management.vm.v1.VmService service.

Jump to

Keyboard shortcuts

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