Freigeben über


GetSummaryInformation-Methode der Msvm_VirtualSystemManagementService-Klasse

Gibt Zusammenfassungsinformationen für den virtuellen Computer zurück.

Syntax

uint32 GetSummaryInformation(
  [in]  CIM_VirtualSystemSettingData REF SettingData[],
  [in]  uint32                           RequestedInformation[],
  [out] Msvm_SummaryInformationBase      SummaryInformation[]
);

Parameter

SettingData [in]

Typ: CIM_VirtualSystemSettingData[]

Ein Array von CIM_VirtualSystemSettingData Instanzen, die die virtuellen Computer oder Momentaufnahmen angeben, für die Informationen abgerufen werden sollen. Wenn dieser Parameter NULL ist, werden Informationen für alle virtuellen Computer abgerufen.

RequestedInformation [in]

Typ: uint32[]

Ein Array von Enumerationswerten, die den Eigenschaften in der Msvm_SummaryInformation-Klasse entsprechen, die die abzurufenden Daten für die virtuellen Computer und Momentaufnahmen angeben, die im SettingData-Array angegeben sind.

Name (0)

Dies entspricht der Name-Eigenschaft der Msvm_SummaryInformation-Klasse .

Elementname (1)

Dies entspricht der ElementName-Eigenschaft der Msvm_SummaryInformation-Klasse .

Erstellungszeit (2)

Dies entspricht der CreationTime-Eigenschaft der Msvm_SummaryInformation-Klasse .

Hinweise (3)

Dies entspricht der Notes-Eigenschaft der Msvm_SummaryInformation-Klasse .

Anzahl der Prozessoren (4)

Dies entspricht der NumberOfProcessors-Eigenschaft der Msvm_SummaryInformation-Klasse .

Kleines Miniaturbild (80x60) (5)

Dies entspricht der ThumbnailImage-Eigenschaft der Msvm_SummaryInformation-Klasse . Es wird ein Miniaturbild mit den Dimensionen 80 60 abgerufen.

Mittlere Miniaturansicht (160x120) (6)

Dies entspricht der ThumbnailImage-Eigenschaft der Msvm_SummaryInformation-Klasse . Es wird ein Miniaturbild mit den Dimensionen 160 120 abgerufen.

Große Miniaturansicht (320x240) (7)

Dies entspricht der ThumbnailImage-Eigenschaft der Msvm_SummaryInformation-Klasse . Es wird ein Miniaturbild mit den Dimensionen 320 240 abgerufen.

ZugeordnetEGPU (8)

Dies entspricht der AllocatedGPU-Eigenschaft der Msvm_SummaryInformation-Klasse .

VirtualSwitchNames (9)

Version (10)

Hinweis

In Windows 10 und Windows Server 2016 hinzugefügt.

Abgeschirmt (11)

Hinweis

In Windows 10 Version 1703 und Windows Server 2016 hinzugefügt.

EnabledState (100)

Dies entspricht der EnabledState-Eigenschaft der Msvm_SummaryInformation-Klasse .

ProcessorLoad (101)

Dies entspricht der ProcessorLoad-Eigenschaft der Msvm_SummaryInformation-Klasse .

ProcessorLoadHistory (102)

Dies entspricht der ProcessorLoadHistory-Eigenschaft der Msvm_SummaryInformation-Klasse .

MemoryUsage (103)

Dies entspricht der MemoryUsage-Eigenschaft der Msvm_SummaryInformation-Klasse .

Heartbeat (104)

Dies entspricht der Heartbeat-Eigenschaft der Msvm_SummaryInformation-Klasse .

Betriebszeit (105)

Dies entspricht der UpTime-Eigenschaft der Msvm_SummaryInformation-Klasse .

GuestOperatingSystem (106)

Dies entspricht der GuestOperatingSystem-Eigenschaft der Msvm_SummaryInformation-Klasse .

Momentaufnahmen (107)

Dies entspricht der Snapshots-Eigenschaft der Msvm_SummaryInformation-Klasse .

AsynchronousTasks (108)

Dies entspricht der AsynchronousTasks-Eigenschaft der Msvm_SummaryInformation-Klasse .

HealthState (109)

Dies entspricht der HealthState-Eigenschaft der Msvm_SummaryInformation-Klasse .

OperationalStatus (110)

Dies entspricht der OperationalStatus-Eigenschaft der Msvm_SummaryInformation-Klasse .

StatusBeschreibungen (111)

Dies entspricht der StatusDescriptions-Eigenschaft der Msvm_SummaryInformation-Klasse .

Arbeitsspeicher Verfügbar (112)

Dies entspricht der MemoryAvailable-Eigenschaft der Msvm_SummaryInformation-Klasse .

AvailableMemoryBuffer (113)

Dies entspricht der AvailableMemoryBuffer-Eigenschaft der Msvm_SummaryInformation-Klasse .

Replikationsmodus (114)

Dies entspricht der ReplicationMode-Eigenschaft der Msvm_SummaryInformation-Klasse .

Replikationsstatus (115)

Dies entspricht der ReplicationState-Eigenschaft der Msvm_SummaryInformation-Klasse .

ReplikationsintegritätTest-Replikatsystem (116)

Dies entspricht der ReplicationHealth-Eigenschaft der Msvm_SummaryInformation-Klasse .

Anwendungsintegrität (117)

ReplicationStateEx (118)

Dies entspricht der ReplicationState-Eigenschaft der Msvm_ReplicationRelationship-Klasse . Hierbei handelt es sich um ein Array für alle Replikationsstatuswerte in der primären und erweiterten Beziehung. Der Indexwert 0 gilt immer für die primäre Beziehung, und wenn die erweiterte Replikation aktiviert ist, wird er in Index 1 zurückgegeben.

ReplicationHealthEx (119)

Dies entspricht der ReplicationHealth-Eigenschaft der Msvm_ReplicationRelationship-Klasse . Hierbei handelt es sich um ein Array für alle Replikationsintegritätswerte in der primären und erweiterten Beziehung. Der Indexwert 0 gilt immer für die primäre Beziehung, und wenn die erweiterte Replikation aktiviert ist, wird er in Index 1 zurückgegeben.

SwapFilesInUse (120)

Dies entspricht der SwapFilesInUse-Eigenschaft der Msvm_SummaryInformation-Klasse .

IntegrationServicesVersionState (121)

ReplicationProviderId (122)

Dies entspricht der Name-Eigenschaft der Msvm_ReplicationProvider-Klasse .

MemorySpansPhysicalNumaNodes (123)

IntegrationServicesVersionState (132)

Dies entspricht der IntegrationServicesVersionState-Eigenschaft der Msvm_SummaryInformation-Klasse .

OtherEnabledState (132)

Dies entspricht der OtherEnabledState-Eigenschaft der Msvm_SummaryInformation-Klasse .

(133)

ZusammenfassungInformationen [out]

Typ: Msvm_SummaryInformationBase[]

Ein Array von Msvm_SummaryInformationBase Instanzen, die die angeforderten Informationen für die virtuellen Computer und/oder Momentaufnahmen enthalten, die im SettingData-Array angegeben sind. Dieses Array verfügt über die gleiche Anzahl von Elementen wie das SettingData-Array . Jeder dieser Einträge enthält die Name-Eigenschaft , auch wenn diese Eigenschaft nicht angefordert wurde. Wenn der virtuelle Computer oder Momentaufnahme nicht gefunden werden kann oder nicht verfügbar ist, ist die Name-Eigenschaft des entsprechenden Zusammenfassungsinformationseintrags leer.

Eigenschaften, die nicht im Parameter RequestedInformation angegeben sind, weisen den Wert NULL auf.

Hinweis

Der Datentyp wurde von Windows 10 version 1703 von Msvm_SummaryInformation aktualisiert.

Rückgabewert

Typ: uint32

Diese Methode gibt einen der folgenden Werte zurück.

Ohne Fehler abgeschlossen (0)

Methodenparameter überprüft – Auftrag gestartet (4096)

Fehler (32768)

Zugriff verweigert (32769)

Nicht unterstützt (32770)

Status ist unbekannt (32771)

Timeout (32772)

Ungültiger Parameter (32773)

System wird verwendet (32774)

Ungültiger Zustand für diesen Vorgang (32775)

Falscher Datentyp (32776)

System ist nicht verfügbar (32777)

Nicht genügend Arbeitsspeicher (32778)

Bemerkungen

Der Zugriff auf die Msvm_VirtualSystemManagementService-Klasse kann durch die UAC-Filterung eingeschränkt werden. Weitere Informationen finden Sie unter Benutzerkontensteuerung und WMI.

Beispiele

Im folgenden C#-Beispiel werden Zusammenfassungsinformationen angezeigt. Die referenzierten Hilfsprogramme finden Sie unter Allgemeine Hilfsprogramme für die Virtualisierungsbeispiele (V2).

Wichtig

Um ordnungsgemäß zu funktionieren, muss der folgende Code auf dem Hostserver des virtuellen Computers ausgeführt und mit Administratorrechten ausgeführt werden.

public class GetSummaryInformationClassV2
{
    public static void GetSummaryInformation(string[] vmNames)
    {
        ManagementScope scope = new ManagementScope(@"root\virtualization\v2", null);
        ManagementObject virtualSystemService = Utility.GetServiceObject(scope, "Msvm_VirtualSystemManagementService");
        ManagementBaseObject inParams = virtualSystemService.GetMethodParameters("GetSummaryInformation");

        ManagementObject[] virtualSystemSettings = new ManagementObject[vmNames.Length];

        for (int i = 0; i < vmNames.Length; i++)
        {
            virtualSystemSettings[i] = GetVirtualSystemSetting(vmNames[i], scope);
        }

        UInt32[] requestedInformation = new UInt32[4];
        requestedInformation[0] = 1;    // ElementName
        requestedInformation[2] = 103;  // MemoryUsage
        requestedInformation[3] = 112;  // MemoryAvailable

        inParams["SettingData"] = virtualSystemSettings;
        inParams["RequestedInformation"] = requestedInformation;

        ManagementBaseObject outParams = virtualSystemService.InvokeMethod("GetSummaryInformation", inParams, null);

        if ((UInt32)outParams["ReturnValue"] == ReturnCode.Completed)
        {
            Console.WriteLine("Summary information was retrieved successfully.");

            ManagementBaseObject[] summaryInformationArray = 
                (ManagementBaseObject[])outParams["SummaryInformation"];

            foreach (ManagementBaseObject summaryInformation in summaryInformationArray)
            {
                Console.WriteLine("\nVirtual System Summary Information:");
                if ((null == summaryInformation["Name"]) || 
                    (summaryInformation["Name"].ToString().Length == 0))
                {
                    Console.WriteLine("\tThe VM or snapshot could not be found.");
                }
                else
                {
                    Console.WriteLine("\tName: {0}", summaryInformation["Name"].ToString());
                    foreach (UInt32 requested in requestedInformation)
                    {
                        switch (requested)
                        {
                            case 1:
                                Console.WriteLine("\tElementName: {0}", summaryInformation["ElementName"].ToString());
                                break;

                            case 103:
                                Console.WriteLine("\tMemoryUsage: {0}", summaryInformation["MemoryUsage"].ToString());
                                break;

                            case 112:
                                Console.WriteLine("\tMemoryAvailable: {0}", summaryInformation["MemoryAvailable"].ToString());
                                break;
                        }
                    }
                }
            }
        }
        else
        {
            Console.WriteLine("Failed to retrieve virtual system summary information");
        }

        inParams.Dispose();
        outParams.Dispose();
        virtualSystemService.Dispose();
    }

    public static ManagementObject GetVirtualSystemSetting(string vmName, ManagementScope scope)
    {
        ManagementObject virtualSystem = Utility.GetTargetComputer(vmName, scope);

        ManagementObjectCollection virtualSystemSettings = virtualSystem.GetRelated
         (
             "Msvm_VirtualSystemSettingData",
             "Msvm_SettingsDefineState",
             null,
             null,
             "SettingData",
             "ManagedElement",
             false,
             null
         );

        ManagementObject virtualSystemSetting = null;

        foreach (ManagementObject instance in virtualSystemSettings)
        {
            virtualSystemSetting = instance;
            break;
        }

        return virtualSystemSetting;

    }
}

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client)
Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)
Windows Server 2012 [nur Desktop-Apps]
Namespace
Stamm\Virtualization\V2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe

Siehe auch

Msvm_VirtualSystemManagementService

CIM_VirtualSystemSettingData

Msvm_SummaryInformation