Operations at HyperVManagement

This page describes the backend methods at this endpoint.

Signature | Description
--- | ---
Guid AddHyperVServerAgent(AddHyperVServerRequest request) | Deploy agent(s) and protect the HyperV server with virtual machines.
Guid AddHyperVVirtualMachineAgents(String hyperVServerAgentId, AddVirtualMachinesRequest addVirtualMachinesRequest) | Add Hyper-V virtual machines nodes to existing Hyper-V server agent
AddAgentsResponse AddSmbAgents(String relatedAgentId, StringCollection smbHostNames) | Protect SMB servers
Guid AddUnprotectedHyperVClusterNodes(String hyperVClusterAgentId) | Add Hyper-V server nodes to existing Hyper-V cluster agent
DeleteAgentsResponse DeleteSmbAgents(StringCollection smbServerAgentIds) | Remove the SMB servers from protection
AgentHyperVServerProtectionSettings GetAgentHyperVServerProtectionSettings(String hyperVServerAgentId) | Gets the auto-protection settings for the agent.
ClusterNodeCollection GetClusterNodesRequiredForProtect(String hyperVClusterAgentId) | Gets Hyper-V Cluster Nodes required for protect
HyperVConfiguration GetHyperVConfiguration() | Gets general global Hyper-V settings.
HyperVVirtualMachinesRelatedServers GetHyperVServerRelatedServers(RelatedServersRequest request) | Gets a collection of servers that host disks connected to the protected virtual machines located on Hyper-V Server
HyperVServerSummary GetHyperVServerSummary(AgentDescriptor hyperVServerDescriptor) | Connects to a specified HyperV server and requests the server's summary metadata
HyperVVirtualMachineAgentSettings GetHyperVVirtualMachineAgentSettings(String hyperVVirtualMachineAgentId) | Gets settings for the specified virtual machine agent.
HyperVVirtualMachineAgentSettingsCollection GetHyperVVirtualMachineAgentsSettings(String hyperVServerAgentId) | Gets virtual machines agents settings for the specified HyperV server or cluster.
HyperVVirtualMachineRelatedServers GetHyperVVirtualMachineRelatedServers(RelatedServersRequest request) | Gets a collection of servers that host disks connected to the provided virtual machine
HyperVVirtualMachinesRelatedServers GetHyperVVirtualMachinesRelatedServers(RelatedServersRequestCollection requests) | Gets a collection of servers that host disks connected to the provided virtual machines
HyperVVirtualMachineSummaryCollection GetSharedDiskConnectedVMs(String hyperVClusterAgentId, HyperVSharedVhdx sharedDisk) | Gets VMs that have access to shared disk
Guid ProtectSharedVirtualDisks(String hyperVClusterAgentId, HyperVSharedVhdxCollection sharedVirtualDisks) | Protects shared virtual disks with existing Hyper-V cluster agent
Guid RemoveSharedVirtualDisks(HyperVSharedVhdxUnprotectRequest request) | Unprotects shared virtual disks for specified Hyper-V cluster
Void SetHyperVAutoProtectedPauseConfiguration(String hyperVServerAgentId, ProtectionPauseConfiguration pauseConfiguration) | Sets or updates pause configuration for auto protected objects
Void SetHyperVAutoProtectedTransferSchedule(String hyperVServerAgentId, TransferScheduleConfiguration scheduleConfiguration) | Sets or updates transfer schedule for auto protected objects
Void SetHyperVAutoProtectionState(String hyperVServerAgentId, String isAutoProtectionEnabled) | Sets auto-protection state for an existing Hyper-V agent
Void SetHyperVConfiguration(HyperVConfiguration configuration) | Applies general global Hyper-V settings.
Void SetHyperVProtectionRules(String hyperVServerAgentId, HyperVProtectionRules protectionRules) | Sets or updates protection rules to apply to machines protected automatically or by using the protection wizard
Void SetHyperVVirtualMachineAgentsSettings(HyperVVirtualMachineAgentSettingsCollection settings) | Sets specified settings for the virtual machine agent(s)
Void SetMaxConcurrentHyperVTransfersSetting(String hyperVServerAgentId, String maxConcurrentHyperVTransfers) | Sets maximum concurrent transfers for Hyper-V server agent
Void ValidateHyperVCluster(HyperVCredential hyperVCredential) | Validates Hyper-V cluster
Void ValidateHyperVServer(HyperVCredential hyperVCredential) | Validates Hyper-V server installed, runned and credentials are true
Void ValidateHyperVVirtualMachineRequest(AddAgentRequest request) | Validates add HyperV virtual machine request.