Msvm_SummaryInformation Class (Windows)

Msvm_SummaryInformation Class

Msvm_SummaryInformation Class

Used in the GetSummaryInformation method in the Msvm_VirtualSystemManagementService class to quickly retrieve common information related to a virtual system or snapshot.

The following syntax is simplified Managed Object Format (MOF) code.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider")]class Msvm_SummaryInformation
{
  string                       Name;
  string                       ElementName;
  uint16                       EnabledState;
  uint16                       HealthState;
  string                       Notes;
  uint16                       NumberOfProcessors;
  uint8                        ThumbnailImage[];
  DateTime                     CreationTime;
  uint16                       ProcessorLoad;
  uint16                       ProcessorLoadHistory[];
  uint64                       MemoryUsage;
  uint16                       Heartbeat;
  uint64                       UpTime;
  string                       GuestOperatingSystem;
  uint16                       OperationalStatus[];
  string                       StatusDescriptions[];
  CIM_VirtualSystemSettingData Snapshots[];
  CIM_ConcreteJob              AsynchronousTasks[];
};

Members

The Msvm_SummaryInformation class defines the following members:

Properties

Properties

The Msvm_SummaryInformation class defines the following properties.

AsynchronousTasks

Data type: CIM_ConcreteJob array
Access type: Read-only

An array of Msvm_ConcreteJob instances representing any asynchronous operations related to the virtual system which are currently executing. This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

CreationTime

Data type: DateTime
Access type: Read-only

The time at which the virtual system or snapshot was created.

ElementName

Data type: string
Access type: Read-only

The friendly name for the virtual system or snapshot.

EnabledState

Data type: uint16
Access type: Read-only

The current state of the virtual system or snapshot.

GuestOperatingSystem

Data type: string
Access type: Read-only

The name of the guest operating system, if available. If this information is not available, the value of this property is NULL. This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

HealthState

Data type: uint16
Access type: Read-only

The current health state for the virtual system. This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

Heartbeat

Data type: uint16
Access type: Read-only

The current heartbeat status for the virtual system. For more information, see the documentation for the StatusDescriptions property of the Msvm_HeartbeatComponent class. This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

Name	Value
OK	2
Error	6
No Contact	12
Lost Communication	13

MemoryUsage

Data type: uint64
Access type: Read-only

The current memory usage of the virtual system. This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

Name

Data type: string
Access type: Read-only

The unique name for the virtual system or snapshot.

Notes

Data type: string
Access type: Read-only

The notes associated with the virtual system or snapshot.

NumberOfProcessors

Data type: uint16
Access type: Read-only

The total number of virtual processors allocated to the virtual system or snapshot.

OperationalStatus

Data type: uint16 array
Access type: Read-only

The current statuses of the virtual system. This corresponds to the OperationalStatus property of the Msvm_ComputerSystem class.

Windows Server 2008: This property is not supported before Windows Server 2008 R2.

ProcessorLoad

Data type: uint16
Access type: Read-only

The current processor usage of the virtual system. This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

ProcessorLoadHistory

Data type: uint16 array
Access type: Read-only

An array of the previous 100 samples of the processor usage for the virtual system. This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

Snapshots

Data type: CIM_VirtualSystemSettingData array
Access type: Read-only

An array of Msvm_VirtualSystemSettingData instances representing the snapshots for the virtual system. This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

StatusDescriptions

Data type: string array
Access type: Read-only

Strings that describe the corresponding OperationalStatus array values. This corresponds to the StatusDescriptions property of the Msvm_ComputerSystem class.

Windows Server 2008: This property is not supported before Windows Server 2008 R2.

ThumbnailImage

Data type: uint8 array
Access type: Read-only

An array containing a small, thumbnail-sized image of the desktop for the virtual system or snapshot in RGB565 format.

UpTime

Data type: uint64
Access type: Read-only

The amount of time since the virtual system was last booted. This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

Remarks

Access to the Msvm_SummaryInformation class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008
MOF	WindowsVirtualization.mof
Namespace	\\.\Root\Virtualization

Syntax

Members

Properties

Remarks

Requirements

See Also