Msvm_SummaryInformation class

Article
04/26/2022

Used in the GetSummaryInformation and GetDefinitionFileSummaryInformation methods in the Msvm_VirtualSystemManagementService class to quickly retrieve common information related to a virtual machine or snapshot.

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

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_SummaryInformation : Msvm_SummaryInformationBase
{
  string                       InstanceID;
  string                       AllocatedGPU;
  boolean                      Shielded;
  CIM_ConcreteJob              AsynchronousTasks[];
  DateTime                     CreationTime;
  string                       ElementName;
  uint16                       EnabledState;
  string                       OtherEnabledState;
  string                       GuestOperatingSystem;
  uint16                       HealthState;
  uint16                       Heartbeat;
  uint64                       MemoryUsage;
  sint32                       MemoryAvailable;
  sint32                       AvailableMemoryBuffer;
  boolean                      SwapFilesInUse;
  string                       Name;
  string                       Notes;
  string                       Version;
  uint16                       NumberOfProcessors;
  uint16                       OperationalStatus[];
  uint16                       ProcessorLoad;
  uint16                       ProcessorLoadHistory[];
  CIM_VirtualSystemSettingData Snapshots[];
  string                       StatusDescriptions[];
  uint8                        ThumbnailImage[];
  uint16                       ThumbnailImageHeight;
  uint16                       ThumbnailImageWidth;
  uint64                       UpTime;
  uint16                       ReplicationState;
  uint16                       ReplicationStateEx[];
  uint16                       ReplicationHealth;
  uint16                       ReplicationHealthEx[];
  uint16                       ReplicationMode;
  CIM_ComputerSystem       REF TestReplicaSystem;
  uint16                       ApplicationHealth;
  uint16                       IntegrationServicesVersionState;
  boolean                      MemorySpansPhysicalNumaNodes;
  string                       ReplicationProviderId[];
  uint16                       EnhancedSessionModeState;
  string                       VirtualSwitchNames[];
  string                       VirtualSystemSubType;
  string                       HostComputerSystemName;
};

Members

The Msvm_SummaryInformation class has these types of members:

Properties

Properties

The Msvm_SummaryInformation class has these properties.

AllocatedGPU

Data type: string
Access type: Read-only

The identifier of the physical graphics processing unit (GPU) allocated to this virtual machine. This property only applies to virtual machines that use RemoteFX.

ApplicationHealth

Data type: uint16
Access type: Read-only

The current application health status for the virtual machine. This property is not valid for instances of Msvm_SummaryInformation that represent a virtual machine snapshot.

OK (2)

Application Critical (32782)

Disabled (32896)

AsynchronousTasks

Data type: CIM_ConcreteJob array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

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

AvailableMemoryBuffer

Data type: sint32
Access type: Read-only

The percentage of available memory buffer for the virtual machine. When dynamic memory is enabled for a virtual machine, this property represents the ratio of available memory buffer to the ideal memory buffer for the virtual machine. The ideal memory buffer size is configured by using the TargetMemoryBuffer property of the Msvm_MemorySettingData class.

This property is not valid for instances of the Msvm_SummaryInformation class that represent virtual machines for which dynamic memory is not enabled.

This property is not valid for instances of the Msvm_SummaryInformation class that represent a virtual machine snapshot.

CreationTime

Data type: DateTime
Access type: Read-only

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

ElementName

Data type: string
Access type: Read-only

The display name for the virtual machine or snapshot.

EnabledState

Data type: uint16
Access type: Read-only

The current state of the virtual machine or snapshot. See the EnabledState property of the Msvm_ComputerSystem class for possible values.

EnhancedSessionModeState

Data type: uint16
Access type: Read-only

Indicates whether enhanced mode connections are allowed by the host, and if allowed, whether they are available to the virtual machine.

Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.

Allowed and available (2)

Not allowed (3)

Allowed but not available (6 )

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 that represent a virtual machine snapshot.

HealthState

Data type: uint16
Access type: Read-only

The current health state for the virtual machine. This property is not valid for instances of Msvm_SummaryInformation that represent a virtual machine snapshot.

Heartbeat

Data type: uint16
Access type: Read-only

The current heartbeat status for the virtual machine. 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 that represent a virtual machine snapshot.

OK (2)
Error (6)
No Contact (12)
Lost Communication (13)

HostComputerSystemName

Data type: string
Access type: Read-only

The name of the computer hosting this virtual machine.

Note

Added in Windows 10.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Override ("CIM_ManagedElement.InstanceID"), Key

InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.

To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:

Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name><Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.

<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.

If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.

Note

Added in Windows 10.

IntegrationServicesVersionState

Data type: uint16
Access type: Read-only

Indicates whether the integration services installed in the virtual machine are up to date.

Unknown (0)

UpToDate (1)

Mismatch (2)

MemoryAvailable

Data type: sint32
Access type: Read-only

The percentage of the current memory available to the virtual machine. When dynamic memory is enabled for a virtual machine, this property represents the ratio of available memory of the virtual machine to the total physical memory assigned to the virtual machine. When a virtual machine has no available memory, this property will be negative, and it will contain the ratio of memory needed for the virtual machine to the total physical memory assigned to the virtual machine.

This property is not valid for instances of the Msvm_SummaryInformation class that represent virtual machines for which dynamic memory is not enabled.

This property is not valid for instances of the Msvm_SummaryInformation class that represent a virtual machine snapshot.

MemorySpansPhysicalNumaNodes

Data type: boolean
Access type: Read-only

Indicates whether the memory of the one or more of the virtual nonuniform memory access (NUMA) nodes of the virtual machine spans multiple physical NUMA nodes of the hosting computer system. Contains True if the memory spans multiple physical NUMA nodes or False otherwise.

MemoryUsage

Data type: uint64
Access type: Read-only

The current memory usage, in megabytes, of the virtual machine. This property is not valid for instances of Msvm_SummaryInformation that represent a virtual machine snapshot.

Name

Data type: string
Access type: Read-only

The unique name for the virtual machine or snapshot.

Notes

Data type: string
Access type: Read-only

The notes associated with the virtual machine or snapshot.

NumberOfProcessors

Data type: uint16
Access type: Read-only

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

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

The current operational statuses of the virtual machine. See the OperationalStatus property of the Msvm_ComputerSystem class for possible values.

OtherEnabledState

Data type: string
Access type: Read-only

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1. This property will be set to Null when EnabledState is any value other than 1.

ProcessorLoad

Data type: uint16
Access type: Read-only

The current processor usage of the virtual machine, in percentage. This property is not valid for instances of Msvm_SummaryInformation that represent a virtual machine snapshot.

ProcessorLoadHistory

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

An array of the previous 100 samples of the processor usage, in percentage, for the virtual machine. This property is not valid for instances of Msvm_SummaryInformation that represent a virtual machine snapshot.

ReplicationHealth

Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("Msvm_SummaryInformation.ReplicationHealthEx")

The replication health for the virtual machine. See the ReplicationHealth property of the Msvm_ComputerSystem class for possible values.

Note

This property is deprecated starting with Windows 8.1; instead, use the ReplicationHealthEx.

Not applicable (0)

Ok (1)

Warning (2)

Critical (3)

ReplicationHealthEx

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

The array of replication health values for the various replication relationships of the virtual machine. See the ReplicationHealth property of the Msvm_ReplicationRelationship class for possible values.

Not applicable (0)

Ok (1)

Warning (2)

Critical (3)

ReplicationMode

Data type: uint16
Access type: Read-only

The replication type for the virtual machine. See the ReplicationMode property of the Msvm_ComputerSystem class for possible values.

None (0)

Primary (1)

Replica (2)

Test Replica (3)

Extended Replica (4)

ReplicationProviderId

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

For the primary or extended replica virtual machine, this is the primary replication provider ID. For a replica virtual machine and if extended replication is enabled, this is the provider ID for extended relationship.

Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.

ReplicationState

Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("Msvm_SummaryInformation.ReplicationStateEx")

The replication state for the virtual machine. See the ReplicationState property of the Msvm_ComputerSystem class for possible values.

Note

This property is deprecated starting with Windows 8.1; instead, use the ReplicationStateEx.

Disabled (0)

Ready for replication (1)

Waiting to complete initial replication (2)

Replicating (3)

Synced replication complete (4)

Recovered (5)

Committed (6)

Suspended (7)

Critical (8)

Waiting to start resynchronization (9)

Resynchronizing (10)

Resynchronization suspended (11)

Failover in progress (12)

ReplicationStateEx

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

The array of replication state values for the various replication relationships of the virtual machine. See the ReplicationState property of the Msvm_ReplicationRelationship class for possible values.

Disabled (0)

Ready for replication (1)

Waiting to complete initial replication (2)

Replicating (3)

Synced replication complete (4)

Recovered (5)

Committed (6)

Suspended (7)

Critical (8)

Waiting to start resynchronization (9)

Resynchronizing (10)

Resynchronization suspended (11)

Failover in progress (12)

Failback in progress (13)

Failback complete (14)

Disk update in progress (15)

Note