GetSummaryInformation-Methode der Msvm _ VirtualSystemManagementService-Klasse

Gibt Zusammenfassungsinformationen für virtuelle 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 (80 x 60) (5)

Dies entspricht der ThumbnailImage-Eigenschaft der Msvm _ SummaryInformation-Klasse. Ein Miniaturbild mit den Dimensionen 80 60 wird abgerufen.

Mittlere Miniaturansicht (160 x 120) (6)

Dies entspricht der ThumbnailImage-Eigenschaft der Msvm _ SummaryInformation-Klasse. Ein Miniaturbild mit den Dimensionen 160 120 wird abgerufen.

Große Miniaturansicht (320 x 240) (7)

Dies entspricht der ThumbnailImage-Eigenschaft der Msvm _ SummaryInformation-Klasse. Ein Miniaturbild mit den Dimensionen 320 240 wird abgerufen.

AllocatedGPU (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.

StatusDescriptions (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.

ReplikationszustandTestreplikatsystem (116)

Dies entspricht der ReplicationHealth-Eigenschaft der Msvm _ SummaryInformation-Klasse.

Anwendungszustand (117)

ReplicationStateEx (118)

Dies entspricht der ReplicationState-Eigenschaft der Msvm _ ReplicationRelationship-Klasse. Dies ist ein Array für alle Replikationszustandswerte in der primären und erweiterten Beziehung. Der Indexwert 0 ist 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. Dies ist ein Array für alle Replikationszustandswerte in der primären und erweiterten Beziehung. Der Indexwert 0 ist 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)

SummaryInformation [ out]

Typ: Msvm _ SummaryInformationBase[]

Ein Array von Msvm _ SummaryInformationBase-Instanzen, das die angeforderten Informationen für die virtuellen Computer und/oder Momentaufnahmen enthält, die im SettingData-Array angegeben sind. Dieses Array hat 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 die Momentaufnahme nicht gefunden werden kann oder nicht verfügbar ist, ist die Name-Eigenschaft des entsprechenden Zusammenfassungsinformationseintrags leer.

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

Hinweis

Der Datentyp wurde von in Windows 10 Version 1703 von Msvm _ SummaryInformation aktualisiert.

Rückgabewert

Typ: uint32

Diese Methode gibt einen der folgenden Werte zurück.

Abgeschlossen ohne Fehler (0)

Überprüfte Methodenparameter – 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)

Hinweise

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

Beispiele

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

Wichtig

Damit der folgende Code ordnungsgemäß funktioniert, muss er auf dem Hostserver des virtuellen Computers 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
Root \ Virtualization \ V2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe

Weitere Informationen

Msvm _ VirtualSystemManagementService

CIM _ VirtualSystemSettingData

Msvm _ SummaryInformation