Msvm_SummaryInformation class

Article
05/31/2018

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 from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

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

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 (VM). This property only applies to VMs that use RemoteFX.

ApplicationHealth

Data type: uint16
Access type: Read-only

The current application health 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.

The possible values are.

OK (2)

Application Critical (32782)

Disabled (32896)

AsynchronousTasks

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

An array of CIM_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.

AvailableMemoryBuffer

Data type: sint32
Access type: Read-only

The available memory buffer percentage in the virtual system.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

CreationTime

Data type: DateTime
Access type: Read-only

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

This property is inherited from Msvm_SummaryInformationBase.

Description

Data type: string
Access type: Read-only

A textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string
Access type: Read-only

The friendly name for the virtual system or snapshot.

This property is inherited from Msvm_SummaryInformationBase.

EnabledState

Data type: uint16
Access type: Read-only

The current state of the virtual system or snapshot.

This property is inherited from Msvm_SummaryInformationBase.

EnhancedSessionModeState

Data type: uint16
Access type: Read-only

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

This property is inherited from Msvm_SummaryInformationBase.

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 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_SummaryInformationBase representing a virtual system snapshot.

This property is inherited from Msvm_SummaryInformationBase.

Heartbeat

Data type: uint16
Access type: Read-only

The current heartbeat status for the virtual system. This property may be one of the following values: "OK"; "Error"; "No Contact"; or "Lost Communication". 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.

HostComputerSystemName

Data type: string
Access type: Read-only

The name of the computer hosting this virtual machine.

This property is inherited from Msvm_SummaryInformationBase.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

An optional property that uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.

[!Important]

In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

This property is inherited from Msvm_SummaryInformationBase.

IntegrationServicesVersionState

Data type: uint16
Access type: Read-only

Whether or not the integration services installed in the virtual machine are up to date

The possible values are.

Unknown (0)

UpToDate (1)

Mismatch (2)

MemoryAvailable

Data type: sint32
Access type: Read-only

The memory available percentage in the virtual system.

MemorySpansPhysicalNumaNodes

Data type: boolean
Access type: Read-only

Indicates whether or not the memory of the one or more of the virtual non-uniform memory access (NUMA) nodes of the virtual machine spans multiple physical NUMA nodes of the hosting computer system.

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.

This property is inherited from Msvm_SummaryInformationBase.

Notes

Data type: string
Access type: Read-only

The notes associated with the virtual system or snapshot.

This property is inherited from Msvm_SummaryInformationBase.

NumberOfProcessors

Data type: uint16
Access type: Read-only

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

This property is inherited from Msvm_SummaryInformationBase.

OperationalStatus

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

The current status of the element.

This property is inherited from Msvm_SummaryInformationBase.

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" ("Other"). This property must be set to null when EnabledState is any value other than 1.

This property is inherited from Msvm_SummaryInformationBase.

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
Qualifiers: ArrayType ("Indexed")

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.

ReplicationHealth

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

Replication health for the virtual machine.

The possible values are.

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.

The possible values are.

Not applicable (0)

Ok (1)

Warning (2)

Critical (3)

ReplicationMode

Data type: uint16
Access type: Read-only

Identifies replication type for the virtual machine.

The possible values are.

None (0)

Primary (1)

Replica (2)

Test Replica (3)

Extended Replica (4)

ReplicationProviderId

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

Globally unique identifier of provider that identifies the endpoint provider. For Hyper-V host to another Hyper-V host, provider id is fixed as "22391CDC-272C-4DDF-BA88-9BEFB1A0975C".

In case of external provider this is CLSID of provider COM class object.

ReplicationState

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

Replication state for the virtual machine.

The possible values are.

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.

The possible values are.

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)

Disk update critical (16)

Unknown (17)

Repurpose replication in progress (18)

Prepared for sync replication (19)

Prepared for group reverse replication (20)

Firedrill in progress (21)

Shielded

Data type: boolean
Access type: Read-only

Indicates whether or not shielding is configured for the virtual machine.

Snapshots

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

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
Qualifiers: ArrayType ("Indexed")

Strings that describe the various OperationalStatus array values.

This property is inherited from Msvm_SummaryInformationBase.

SwapFilesInUse

Data type: boolean
Access type: Read-only

Indicates if Smart Paging is active.

TestReplicaSystem

Data type: CIM_ComputerSystem
Access type: Read-only

Reference to the CIM_ComputerSystem instance representing the test replica virtual system for the virtual machine.

This property is not valid for instances of Msvm_SummaryInformation representing a virtual system snapshot.

ThumbnailImage

Data type: uint8 array
Access type: Read-only
Qualifiers: OctetString, ArrayType ("Indexed"), ModelCorrespondence ("Msvm_SummaryInformation.ThumbnailImageWidth", "Msvm_SummaryInformation.ThumbnailImageHeight")

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

ThumbnailImageHeight

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("Msvm_SummaryInformation.ThumbnailImage")

The height in pixels of the image in the ThumbnailImage property.

ThumbnailImageWidth

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("Msvm_SummaryInformation.ThumbnailImage")

The width in pixels of the image in the ThumbnailImage property.

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_SummaryInformationBase representing a virtual system snapshot.

This property is inherited from Msvm_SummaryInformationBase.

Version

Data type: string
Access type: Read-only

The version of the virtual system in a format of "major.minor", for example "2.0".

This property is inherited from Msvm_SummaryInformationBase.

VirtualSwitchNames

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

Strings that list the friendly names of the virtual switches the VM is connected to.

This property is inherited from Msvm_SummaryInformationBase.

VirtualSystemSubType

Data type: string
Access type: Read-only

The subtype of the virtual system.

This property is inherited from Msvm_SummaryInformationBase.

Microsoft:Hyper-V:SubType:1 ("Microsoft:Hyper-V:SubType:1")

Microsoft:Hyper-V:SubType:2 ("Microsoft:Hyper-V:SubType:2")

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\HyperVCluster\v2
MOF	WindowsHyperVCluster.V2.Mof
DLL	VMMS.exe

Msvm_SummaryInformation class

Syntax

Members

Properties

Requirements

See also

Additional resources