Método RequestStateChange da classe Msvm_ComputerSystem
Solicita que o estado da máquina virtual seja alterado para o valor especificado. Invocar o método RequestStateChange várias vezes pode resultar na substituição ou perda de solicitações anteriores. Esse método só tem suporte para instâncias da classe Msvm_ComputerSystem que representam uma máquina virtual.
Enquanto a alteração de estado está em andamento, a propriedade RequestedState é alterada para o valor do parâmetro RequestedState .
Sintaxe
uint32 RequestStateChange(
[in] uint16 RequestedState,
[out] CIM_ConcreteJob REF Job,
[in] datetime TimeoutPeriod
);
Parâmetros
-
RequestedState [in]
-
Tipo: uint16
O novo estado. Valores maiores que 32767 são valores propostos por DMTF e estão sujeitos a alterações.
Aqui estão os valores possíveis:
-
Outros (1)
-
Corresponde a CIM_EnabledLogicalElement.EnabledState = Outros.
-
Habilitado (2)
-
Corresponde a CIM_EnabledLogicalElement.EnabledState = Enabled.
-
Desabilitado (3)
-
Corresponde a CIM_EnabledLogicalElement.EnabledState = Desabilitado.
-
Desligar (4)
-
Válido somente na versão 1 (V1) do Hyper-V. A máquina virtual está sendo desligada por meio do serviço de desligamento. Corresponde a CIM_EnabledLogicalElement.EnabledState = ShuttingDown.
-
Offline (6)
-
Corresponde a CIM_EnabledLogicalElement.EnabledState = Habilitado, mas offline.
-
Teste (7)
-
Adiar (8)
-
Quiesce (9)
-
Corresponde a CIM_EnabledLogicalElement.EnabledState = Quiesce, Habilitado, mas em pausa.
-
Reinicialização (10)
-
Transição de estado de Desativado ou Salvo para Em Execução.
-
Redefinir (11)
-
Redefina a máquina virtual. Corresponde a CIM_EnabledLogicalElement.EnabledState = Reset.
-
Salvando (32773)
-
Na versão 1 (V1) do Hyper-V, corresponde a EnabledStateSaving.
-
Pausa ( 32776)
-
Na versão 1 (V1) do Hyper-V, corresponde a EnabledStatePausing.
-
Retomando (32777)
-
Na versão 1 (V1) do Hyper-V, corresponde a EnabledStateResuming. Transição de estado de Pausado para Em Execução.
-
FastSaved (32779)
-
Corresponde a EnabledStateFastSuspend.
-
FastSaving (32780)
-
Corresponde a EnabledStateFastSuspending. Transição de estado de Executando para FastSaved.
Esses valores representam estados críticos:
RunningCritical (32781)
OffCritical (32782)
StopCritical (32783)
SavedCritical (32784)
PausedCritical (32785)
StartingCritical (32786)
ResetCritical (32787)
SavingCritical (32788)
PausingCritical (32789)
ResumingCritical (32790)
FastSavedCritical (32791)
FastSavingCritical (32792)
Trabalho [out]
Tipo: CIM_ConcreteJob
Uma referência opcional a um objeto Msvm_ConcreteJob que será retornado se a operação for executada de forma assíncrona. Se presente, a referência retornada pode ser usada para monitorar o progresso e obter o resultado do método.
TimeoutPeriod [in]
Tipo: datetime
Este parâmetro não é usado.
Valor retornado
Tipo: uint32
Esse método retorna um dos valores a seguir.
| Código/valor de retorno | Descrição |
|---|---|
|
Sucesso. |
|
A transição é assíncrona. |
|
Acesso negado. |
|
|
|
|
|
|
|
|
|
|
|
|
|
Não há suporte para o valor especificado no parâmetro RequestedState . |
|
|
|
|
|
Comentários
O acesso à classe Msvm_ComputerSystem pode ser restrito pela Filtragem UAC. Para obter mais informações, consulte Controle de conta de usuário e WMI.
Exemplos
O exemplo de C# a seguir inicia ou desabilita uma máquina virtual. Os utilitários referenciados podem ser encontrados em Utilitários comuns para os exemplos de virtualização (V2).
Importante
Para funcionar corretamente, o código a seguir deve ser executado no servidor host da máquina virtual e deve ser executado com privilégios de administrador.
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]);
}
}
}
O exemplo do Visual Basic Scripting Edition (VBScript) a seguir inicia ou desabilita uma máquina virtual.
Importante
Para funcionar corretamente, o código a seguir deve ser executado no servidor host da máquina virtual e deve ser executado com privilégios de administrador.
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
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte |
Windows 8 [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte |
Windows Server 2012 [somente aplicativos da área de trabalho] |
| Namespace |
Root\Virtualization\V2 |
| MOF |
|
| DLL |
|