Export (0) Print
Expand All

Msvm_SummaryInformation class

Hyper-V

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")]class Msvm_SummaryInformation
{
  string                       AllocatedGPU;
  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;
  uint16                       NumberOfProcessors;
  uint16                       OperationalStatus[];
  uint16                       ProcessorLoad;
  uint16                       ProcessorLoadHistory[];
  CIM_VirtualSystemSettingData Snapshots[];
  string                       StatusDescriptions[];
  uint8                        ThumbnailImage[];
  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;
};

Members

The Msvm_SummaryInformation class has these types of members:

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

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.

Allowed and available (2)
Not allowed (3)
Allowed but not available (6 )

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

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)
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

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

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

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.
ReplicationHealthEx
Data type: uint16 array
Access type: Read-only

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.

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.

ReplicationProviderId
Data type: string
Access type: Read-only

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

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.
ReplicationStateEx
Data type: uint16 array
Access type: Read-only

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.

Snapshots
Data type: CIM_VirtualSystemSettingData array
Access type: Read-only

An array of Msvm_VirtualSystemSettingData instances that represent the snapshots for the virtual machine. This property is not valid for instances of Msvm_SummaryInformation that represent a virtual machine 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.

SwapFilesInUse
Data type: boolean
Access type: Read-only

Indicates whether second level paging is active. Contains True if second level paging is active or False otherwise.

TestReplicaSystem
Data type: CIM_ComputerSystem
Access type: Read-only

Reference to a CIM_ComputerSystem instance that represents the test replica virtual machine for the virtual machine. This property is not valid for instances of Msvm_SummaryInformation that represent a virtual machine snapshot.

ThumbnailImage
Data type: uint8 array
Access type: Read-only

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

UpTime
Data type: uint64
Access type: Read-only

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

VirtualSwitchNames
Data type: string array
Access type: Read-only

Strings that specify the friendly names of the virtual switches the virtual machine is connected to.

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

VirtualSystemSubType
Data type: string
Access type: Read-only

The subtype of the virtual system.

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

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

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Namespace

Root\Virtualization\V2

MOF

WindowsVirtualization.V2.mof

See also

Virtual System Classes

 

 

Community Additions

ADD
Show:
© 2015 Microsoft