Hyper-V의 가상 머신을 C#으로 제어하는 방법
Hyper-V의 가상 머신을 이용하면 다양한 테스트 환경을 구성할 수 있어, 사용 제품을 만드는 개발자 입장에서는 (개인적인 생각으로) 거의 필수 구성요소까지 되어 버렸습니다.
그런데, 사실 개발자의 테스트 머신으로 아직 이 정도의 사양을 바라는 것은 무리이고,
작업 관리자 화면 - 96개의 코어 + 512GB 메모리
; https://www.sysnet.pe.kr/0/0/223
현재, PC 수준에서 구성할 수 있는 최대 시스템은 아마 이 정도일 것입니다.
24GB 메모리 ^^
; https://www.sysnet.pe.kr/0/0/342
처음에는 24GB 메모리가 많은 듯해도... 하나 둘씩 Virtual Machine이 늘어나다 보면, 어느새 Hyper-V를 호스팅하고 있는 컴퓨터는 메모리 부족 현상에 시달리게 됩니다. 이쯤 되면, Hyper-V 호스트를 한 대 더 구매하던가... 아니면 부족한 메모리 내에서 기존 VM을 중지시키고 새로운 VM을 시작시키는 방법을 사용해야 합니다.
제 경우에, 2가지 제품을 위한 테스트 VM들이 구성되어 있고 개별 제품에 대해 약 4개 정도의 VM들이 테스트를 위해 할당되어 있습니다. 따라서, 제품이 새롭게 빌드될 때마다 그에 맞는 VM들이 올라와서 테스트가 진행되어야 하는데 메모리 문제로 인해 8개의 VM을 모두 올릴 수 없게 되었습니다.
자... 그렇다고 테스트할 때마다 매번 Hyper-V 관리자에서 4개의 VM을 내리고, 또 다른 4개의 VM을 올리는 것을 '수작업'으로 진행할 수는 없는 노릇입니다. 그렇죠. ^^ 배치 파일로 적절하게 구성해 두어야 합니다. 처음에는 이 작업을 하느라 시간이 걸려도 결국 시간이 지날수록 이렇게 한번 구성해 놓은 자동화 시스템이 전체적으로 시간 절약을 해줍니다. 자... 그럼... 으쌰~~~ 한번 만들어 볼까요? ^^
우선, Hyper-V의 가상머신을 제어하는 방법을 찾아야 하는데요. 다행히 WMI로 이 기능을 제공해 주고 있으니 그대로 사용하시면 됩니다. 하지만, 기왕이면 Hyper-V와 관련된 WMI 개체들을 잘 래핑해주고 있는 공개 라이브러리를 이용하는 것도 좋은 선택입니다.
HyperV C# Library
; http://hypervlib.codeplex.com/
Codeplex이니 소스 코드도 당연히 공개되어 있습니다. 다운로드 탭에서 빌드된 DLL보다는, hypervlib-69039.zip 압축 파일로 되어 있는 소스 코드를 다운로드 받습니다. 거기 있는 모든 소스 코드를 사용할 필요는 없고, System.Management.HyperV 폴더만 복사해서 자신의 솔루션에 System.Management.HyperV.csproj 프로젝트만 추가해 주면 됩니다.
한 가지 그 소스 코드에서 이해할 수 없는 것은, 너무 과할 정도로 접근 제한을 두었다는 것인데 그래서 이번 예제를 따라하시려면 다음의 파일 내용을 변경해 주어야 합니다.
\System.Management.HyperV\Model\Msvm\ComputerSystem.cs
ComputerSystem 클래스 생성자를 internal protected에서 public으로 변경
자... 이제 ^^ 여러분들의 예제 프로젝트에 "System.Management.HyperV" 프로젝트를 참조 추가하고, .NET Framework에서 기본 제공되는 System.Management.dll도 추가해 줍니다.
그런 다음, 아래와 같이 코드를 만들어 주시면 현재 Hyper-V에 설치된 모든 가상 머신의 목록 및 그 상태를 알 수 있습니다.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Management;
using System.Management.HyperV.Model.Msvm;
namespace ConsoleApplication1
{
class Program
{
static void Main(string[] args)
{
using (var searcher = new ManagementObjectSearcher(@"root\virtualization", "SELECT * FROM Msvm_ComputerSystem WHERE Caption = 'Virtual Machine'"))
{
var vmList = from mo in searcher.Get().OfType<ManagementObject>()
select new ComputerSystem(mo);
foreach (var vm in vmList)
{
if (vm.CreationClassName != "Msvm_ComputerSystem")
{
continue;
}
if (vm.OperationalStatus.Length == 0 || vm.OperationalStatus[0] != 2)
{
continue;
}
Console.Write(vm.ElementName);
Console.Write(" ");
switch (vm.EnabledState)
{
case 0:
Console.Write("Unknown");
break;
...[생략]...
case 32777:
Console.Write("Resuming");
break;
}
Console.WriteLine();
}
}
return;
}
}
}
EnabledState의 값이나 Msvm_ComputerSystem에서 제공되는 전체적인 속성값들이 궁금하실 텐데요. 그에 대해서는 다음의 도움말을 참고하시면 됩니다.
Msvm_ComputerSystem Class
; https://docs.microsoft.com/en-us/previous-versions/windows/desktop/virtual/msvm-computersystem
VM 열람은 했고... 이제 남은 단계는 VM 시작/중지인데요. 아쉽게도 이에 대한 구현이 System.Management.HyperV 어셈블리에 미구현되어 있습니다. "\System.Management.HyperV\Model\Msvm\CIM\EnabledLogicalElement.cs" 파일에 보면 다음과 같이 뼈대만 구성되어 있는 것을 볼 수 있습니다.
internal Job RequestStateChange(ushort requestedState, object timeout)
{
throw new NotImplementedException();
}
그래도 괜찮습니다. ^^ 어렵지 않거든요.
우선, VM을 제어하기 위해서는 Msvm_ComputerSystem 클래스에서 제공되는 WMI 메서드가 있어야 합니다. 찾아보니 위의 메서드 이름과 동일한 RequestStateChange 가 있습니다.
RequestStateChange Method of the Msvm_ComputerSystem Class
; https://docs.microsoft.com/en-us/previous-versions/windows/desktop/virtual/requeststatechange-msvm-computersystem
이를 이용해서, 다음과 같이 메서드를 마저 완성해 줄 수 있습니다.
public void RequestStateChange(ushort requestedState, object timeout)
{
ManagementScope scope = new ManagementScope(@"\\.\root\virtualization", null);
ManagementBaseObject inParams = WmiInstance.GetMethodParameters("RequestStateChange");
inParams["RequestedState"] = requestedState;
ManagementBaseObject outParams = WmiInstance.InvokeMethod(
"RequestStateChange", inParams, null);
if ((ReturnCode)outParams["ReturnValue"] == ReturnCode.Started)
{
if (JobCompleted(outParams, scope))
{
Console.WriteLine("state was changed successfully.");
}
else
{
Console.WriteLine("Failed to change virtual system state");
}
}
else if ((ReturnCode)outParams["ReturnValue"] == ReturnCode.Completed)
{
Console.WriteLine("state was changed successfully.");
}
else
{
Console.WriteLine(
"Change virtual system state failed with error {0}",
outParams["ReturnValue"]);
}
}
public static bool JobCompleted(ManagementBaseObject outParams, ManagementScope scope)
{
bool jobCompleted = true;
//Retrieve msvc_StorageJob path. This is a full wmi path
string JobPath = (string)outParams["Job"];
ManagementObject Job = new ManagementObject(scope,
new ManagementPath(JobPath), null);
//Try to get storage job information
Job.Get();
while ((JobState)Job["JobState"] == JobState.Starting
|| (JobState)Job["JobState"] == JobState.Running)
{
Console.WriteLine("In progress... {0}% completed.",
Job["PercentComplete"]);
Thread.Sleep(1000);
Job.Get();
}
//Figure out if job failed
UInt16 jobState = (UInt16)Job["JobState"];
if ((JobState)jobState != JobState.Completed)
{
UInt16 jobErrorCode = (UInt16)Job["ErrorCode"];
Console.WriteLine("Error Code:{0}", jobErrorCode);
Console.WriteLine("ErrorDescription: {0}",
(string)Job["ErrorDescription"]);
jobCompleted = false;
}
return jobCompleted;
}
참고로, ^^ 위의 메서드는 이미 다음의 글에서 제공되어 있었습니다. (그 외에도 참고해 둘 만한 점들이 있으니 Hyper-V 제어에 관심 있으신 분들은 읽어보시면 도움이 될 것입니다. ^^)
Working With Windows Management Instrumentation (WMI) - Part 1
; http://www.codeproject.com/Articles/54064/Working-With-Windows-Management-Instrumentation-WM
Working With Windows Management Instrumentation (WMI) - Part 2
; http://www.codeproject.com/Articles/55740/Working-With-Windows-Management-Instrumentation-WM
Working With Windows Management Instrumentation (WMI) - Part 3
; http://www.codeproject.com/Articles/59113/Working-With-Windows-Management-Instrumentation-WM
그리하여... 다음과 같이 VM을 제어해 줄 수 있습니다.
foreach (var vm in vmList)
{
...[생략]...
if (vm.ElementName == "MyVMTest")
{
const int Enabled = 2;
const int Disabled = 3;
const int Saved = 32769;
vm.RequestStateChange(Saved, 0);
}
}
경험해 보니, VM을 스위칭할 때 Start/Stop 상태로 바꾸는 것은 권장하지 않습니다. 왜냐하면, Stop은 상관없지만 Start인 경우 VM을 부팅하기 시작한 순간까지만을 알 수 있을 뿐, 해당 VM 내의 운영체제가 완전히 부팅 완료된 상태가 되었는지는 알 수 없기 때문입니다. (Integration Service 관련해서 Heartbeat 상태를 알 수 있는 방법이 있을 것 같은데... 일단 이번에는 생략합니다. ^^)
그래서, 차라리 Saved (Hibernation) 상태와 Start 상태로 스위칭하는 것이 좋습니다. 그렇게 되면, 메서드를 동기적으로 반환할 수 있고 곧바로 VM 테스트로 진입하는 것이 가능하기 때문입니다.
위의 진행 상황까지 반영된 프로젝트를 첨부했으니 참고하시고. 제 경우에는 이 글에 첨부된 프로젝트를 적절하게 확장해서 다음과 같은 exe 파일을 하나 만들어서 지금 잘 사용하고 있습니다. ^^
VMController.exe start ...[VM 이름목록]...
VMController.exe stop ...[VM 이름목록]...
VMController.exe save ...[VM 이름목록]...
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]