Метод RequestStateChange класса Msvm_ComputerSystem
Запрашивает изменение состояния виртуальной машины на указанное значение. Несколько раз вызов метода RequestStateChange может привести к перезаписи или потере более ранних запросов. Этот метод поддерживается только для экземпляров класса Msvm_ComputerSystem , представляющих виртуальную машину.
Во время изменения состояния свойство RequestedState изменяется на значение параметра RequestedState .
Синтаксис
uint32 RequestStateChange(
[in] uint16 RequestedState,
[out] CIM_ConcreteJob REF Job,
[in] datetime TimeoutPeriod
);
Параметры
-
RequestedState [in]
-
Тип: uint16
Новое состояние. Значения, превышающие 32767, являются предложенными значениями DMTF и могут изменяться.
Ниже приведены возможные значения.
-
Другое (1)
-
Соответствует CIM_EnabledLogicalElement.EnabledState = Other.
-
Включено (2)
-
Соответствует CIM_EnabledLogicalElement.EnabledState = Enabled.
-
Отключено (3)
-
Соответствует CIM_EnabledLogicalElement.EnabledState = Disabled.
-
Завершение работы (4)
-
Допустимо только в версии 1 (V1) Hyper-V. Виртуальная машина завершает работу через службу завершения работы. Соответствует CIM_EnabledLogicalElement.EnabledState = ShuttingDown.
-
Автономный (6)
-
Соответствует CIM_EnabledLogicalElement.EnabledState = Включено, но в автономном режиме.
-
Тест (7)
-
Отложить (8)
-
Заморажи ( 9)
-
Соответствует CIM_EnabledLogicalElement.EnabledState = Quiesce, Enabled, but paused.
-
Перезагрузка (10)
-
Переход состояния с "Выкл. " или "Сохранено" на "Выполняется".
-
Сброс (11)
-
Сбросьте виртуальную машину. Соответствует CIM_EnabledLogicalElement.EnabledState = Reset.
-
Сохранение (32773)
-
В hyper-V версии 1 (V1) соответствует EnabledStateSaving.
-
Приостановка (32776)
-
В версии 1 (V1) Hyper-V соответствует EnabledStatePausing.
-
Возобновление (32777)
-
В hyper-V версии 1 (V1) соответствует EnabledStateResuming. Переход состояния с Приостановлено на Выполняется.
-
FastSaved (32779)
-
Соответствует EnabledStateFastSuspend.
-
FastSaving (32780)
-
Соответствует EnabledStateFastSuspending. Переход состояния с Выполняется на FastSaved.
Эти значения представляют критические состояния:
RunningCritical (32781)
OffCritical (32782)
ОстановкаCritical (32783)
SavedCritical (32784)
PausedCritical (32785)
StartingCritical (32786)
ResetCritical (32787)
SavingCritical (32788)
ПриостановкаCritical (32789)
ResumingCritical (32790)
FastSavedCritical (32791)
FastSavingCritical (32792)
Задание [out]
Тип: CIM_ConcreteJob
Необязательная ссылка на объект Msvm_ConcreteJob , который возвращается, если операция выполняется асинхронно. Если она есть, возвращаемую ссылку можно использовать для отслеживания хода выполнения и получения результата метода .
TimeoutPeriod [in]
Тип: datetime
Этот параметр не используется.
Возвращаемое значение
Тип: uint32
Этот метод возвращает одно из следующих значений.
| Возвращаемый код/значение | Описание |
|---|---|
|
Успешно. |
|
Переход является асинхронным. |
|
Доступ запрещен. |
|
|
|
|
|
|
|
|
|
|
|
|
|
Значение, указанное в параметре RequestedState , не поддерживается. |
|
|
|
|
|
Комментарии
Доступ к классу Msvm_ComputerSystem может быть ограничен фильтрацией UAC. Дополнительные сведения см. в разделе Контроль учетных записей и инструментарий WMI.
Примеры
В следующем примере C# запускается или отключается виртуальная машина. Ссылки на служебные программы можно найти в разделе Общие служебные программы для примеров виртуализации (версия 2).
Важно!
Для правильной работы следующий код должен выполняться на сервере узла виртуальной машины и выполняться с правами администратора.
using System;
using System.Management;
namespace HyperVSamples
{
public class RequestStateChangeClass
{
public static void RequestStateChange(string vmName, string action)
{
ManagementScope scope = new ManagementScope(@"\\.\root\virtualization\v2", null);
ManagementObject vm = Utility.GetTargetComputer(vmName, scope);
if (null == vm)
{
throw new ArgumentException(
string.Format(
"The virtual machine '{0}' could not be found.",
vmName));
}
ManagementBaseObject inParams = vm.GetMethodParameters("RequestStateChange");
const int Enabled = 2;
const int Disabled = 3;
if (action.ToLower() == "start")
{
inParams["RequestedState"] = Enabled;
}
else if (action.ToLower() == "stop")
{
inParams["RequestedState"] = Disabled;
}
else
{
throw new Exception("Wrong action is specified");
}
ManagementBaseObject outParams = vm.InvokeMethod(
"RequestStateChange",
inParams,
null);
if ((UInt32)outParams["ReturnValue"] == ReturnCode.Started)
{
if (Utility.JobCompleted(outParams, scope))
{
Console.WriteLine(
"{0} state was changed successfully.",
vmName);
}
else
{
Console.WriteLine("Failed to change virtual system state");
}
}
else if ((UInt32)outParams["ReturnValue"] == ReturnCode.Completed)
{
Console.WriteLine(
"{0} state was changed successfully.",
vmName);
}
else
{
Console.WriteLine(
"Change virtual system state failed with error {0}",
outParams["ReturnValue"]);
}
}
public static void Main(string[] args)
{
if (args != null && args.Length != 2)
{
Console.WriteLine("Usage: <application> vmName action");
Console.WriteLine("action: start|stop");
return;
}
RequestStateChange(args[0], args[1]);
}
}
}
В следующем примере Visual Basic Scripting Edition (VBScript) запускается или отключается виртуальная машина.
Важно!
Для правильной работы следующий код должен выполняться на сервере узла виртуальной машины и выполняться с правами администратора.
dim objWMIService
dim fileSystem
const JobStarting = 3
const JobRunning = 4
const JobCompleted = 7
const wmiStarted = 4096
const Enabled = 2
const Disabled = 3
Main()
'-----------------------------------------------------------------
' Main routine
'-----------------------------------------------------------------
Sub Main()
set fileSystem = Wscript.CreateObject("Scripting.FileSystemObject")
strComputer = "."
set objWMIService = GetObject("winmgmts:\\" & strComputer & "\root\virtualization\v2")
set objArgs = WScript.Arguments
if WScript.Arguments.Count = 2 then
vmName= objArgs.Unnamed.Item(0)
action = objArgs.Unnamed.Item(1)
else
WScript.Echo "usage: cscript StartVM.vbs vmName start|stop"
WScript.Quit
end if
set computerSystem = GetComputerSystem(vmName)
if RequestStateChange(computerSystem, action) then
WriteLog "Done"
WScript.Quit(0)
else
WriteLog "RequestStateChange failed"
WScript.Quit(1)
end if
End Sub
'-----------------------------------------------------------------
' Retrieve Msvm_VirtualComputerSystem from base on its ElementName
'
'-----------------------------------------------------------------
Function GetComputerSystem(vmElementName)
On Error Resume Next
query = Format1("select * from Msvm_ComputerSystem where ElementName = '{0}'", vmElementName)
set GetComputerSystem = objWMIService.ExecQuery(query).ItemIndex(0)
if (Err.Number <> 0) then
WriteLog Format1("Err.Number: {0}", Err.Number)
WriteLog Format1("Err.Description:{0}",Err.Description)
WScript.Quit(1)
end if
End Function
'-----------------------------------------------------------------
' Turn on a virtual machine
'-----------------------------------------------------------------
Function RequestStateChange(computerSystem, action)
WriteLog Format2("RequestStateChange({0}, {1})", computerSystem.ElementName, action)
RequestStateChange = false
set objInParam = computerSystem.Methods_("RequestStateChange").InParameters.SpawnInstance_()
if action = "start" then
objInParam.RequestedState = Enabled
else
objInParam.RequestedState = Disabled
end if
set objOutParams = computerSystem.ExecMethod_("RequestStateChange", objInParam)
if (WMIMethodStarted(objOutParams)) then
if (WMIJobCompleted(objOutParams)) then
WriteLog Format1("VM {0} was started successfully", computerSystem.ElementName)
RequestStateChange = true
end if
end if
End Function
'-----------------------------------------------------------------
' Handle wmi return values
'-----------------------------------------------------------------
Function WMIMethodStarted(outParam)
WMIMethodStarted = false
if Not IsNull(outParam) then
wmiStatus = outParam.ReturnValue
if wmiStatus = wmiStarted then
WMIMethodStarted = true
end if
end if
End Function
'-----------------------------------------------------------------
' Handle wmi Job object
'-----------------------------------------------------------------
Function WMIJobCompleted(outParam)
dim WMIJob
set WMIJob = objWMIService.Get(outParam.Job)
WMIJobCompleted = true
jobState = WMIJob.JobState
while jobState = JobRunning or jobState = JobStarting
WScript.Sleep(1000)
set WMIJob = objWMIService.Get(outParam.Job)
jobState = WMIJob.JobState
wend
if (jobState <> JobCompleted) then
WriteLog Format1("ErrorDescription:{0}", WMIJob.ErrorDescription)
WMIJobCompleted = false
end if
End Function
'-----------------------------------------------------------------
' Create the console log files.
'-----------------------------------------------------------------
Sub WriteLog(line)
dim fileStream
set fileStream = fileSystem.OpenTextFile(".\StartVM.log", 8, true)
WScript.Echo line
fileStream.WriteLine line
fileStream.Close
End Sub
'------------------------------------------------------------------------------
' The string formatting functions to avoid string concatenation.
'------------------------------------------------------------------------------
Function Format2(myString, arg0, arg1)
Format2 = Format1(myString, arg0)
Format2 = Replace(Format2, "{1}", arg1)
End Function
'------------------------------------------------------------------------------
' The string formatting functions to avoid string concatenation.
'------------------------------------------------------------------------------
Function Format1(myString, arg0)
Format1 = Replace(myString, "{0}", arg0)
End Function
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента |
Windows 8 [только классические приложения] |
| Минимальная версия сервера |
Windows Server 2012 [только классические приложения] |
| Пространство имен |
Root\Virtualization\V2 |
| MOF |
|
| DLL |
|