Operations at HyperVAgentManagement

This page describes the backend methods at this endpoint.

Signature Description
Void AddDvdDrive(String virtualMachineId) Adds a DVD drive to current virtual machine
Void AddIsoImage(String virtualMachineId, String isoPath) Adds an ISO image to a DVD drive. If DVD drive doesn't exist - creates it
Void AddNetworkAdapter(String virtualMachineId, String networkAdapterName) Adds new network adapter to current virtual machine
HyperVVirtualMachineResponse AttachToExistingVirtualMachine(HyperVVirtualMachineRequest hyperVVirtualMachineRequest) Gets virtual machine identified by bios serial number
Void AttachVirtualDisk(String virtualMachineId, String diskPath, String storageController) Attaches a virtual disk to current virtual machine
Void DeleteFile(String path) Deletes a specified file
Void DeleteVirtualMachine(String virtualMachineId) Deletes current virtual machine and detaches from it
Void DetachVirtualDisk(String virtualMachineId, String diskPath) Detaches a virtual disk from current virtual machine
Boolean EndSession(String virtualMachineId) Tells Hyper-V Agent to finish session with the virtual machine
Boolean ExistFile(String path) Checks is specified file existed
Void FinalizeDataTransferSession(String id, String deleteData) Signals to a remote host that data transfer is over. If needed, can delete data for failed transfers
VirtualNetworksCollection GetAvailableVirtualNetworks(String virtualMachineId) Gets a list of virtual network adapters on Hyper-V server available for a virtual machine
ConfigurationSetupStatus GetConfigurationSetupStatus(String virtualMachineId) Gets virtual machine configuration setup status
UInt64 GetFreeSpace(String path) Gets free space on the disk
Int32 GetMaximumProcessorCount(String operatingSystemFamily) Gets the maximum number of virtual CPUs that could be attached to virtual machine
HyperVVirtualMachineResponse GetOrCreateVirtualMachineAndAttach(HyperVVirtualMachineRequest hyperVVirtualMachineRequest) Gets or creates virtual machine specified in request parameter
Int32 GetSnapshotsCount(String virtualMachineId) Get the count of snapshots for virtual machine
Version GetVersion() Gets hyper-V agent version
VirtualApplianceDisksInformationSummary GetVirtualApplianceDisksSummary(VirtualApplianceDisksInStorageLocationsRequest request) Gets disks that are related to this virtual appliance
VirtualDiskCollection GetVirtualDisks(String virtualMachineId) Gets a list of virtual disks currently attached to current virtual machine
String GetVirtualMachineName(String virtualMachineId) Gets name of current virtual machine
Guid InitializeDataTransferSession(String target) Prepares a file on the remote host to receive data stream
Void InsertIntegrationServices(String virtualMachineId) Mounts the integration services setup disk
Void PingSession(String virtualMachineId) Indicates that session is still being used
Void RearrangeBootOrder(String virtualMachineId) Changes the boot order for a Hyper-V virtual machine
Void RenameVirtualMachine(String virtualMachineId, String newVirtualMachineName) Renames current virtual machine
Void SetAssetTag(String virtualMachineId, String assetTag) Changes asset tag for the current virtual machine
Void SetProcessorCount(String virtualMachineId, String processorCount) Changes number of virtual CPUs in current virtual machine
Void SetRamMegabytes(String virtualMachineId, String ramValue) Changes amount of RAM in current virtual machine
Void TransferData(String id, String count, Stream stream) Writes a block of data to a file on the remote host. You need to open the session before sending data
Boolean VerifyConnection() Verifies connection to the running HyperV Agent