Edit

Share via

Msvm_SummaryInformationBase class

  • Article

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

[Abstract, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_SummaryInformationBase : CIM_View
{
  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;
};

Members

The Msvm_SummaryInformationBase class has these types of members:

Properties

The Msvm_SummaryInformationBase class has these properties.

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

Qualifiers: Override ("CIM_ManagedElement.ElementName")

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.

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.

Allowed and available (2)

Not allowed (3)

Allowed but not available (6)

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.

HostComputerSystemName

Data type: string

Access type: Read-only

The name of the computer hosting this virtual machine.

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:

<OrgID>:<LocalID>

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.

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

Qualifiers: ArrayType ("Indexed")

The current status of the element.

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.

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed")

Strings that describe the various OperationalStatus array values.

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.

Version

Data type: string

Access type: Read-only

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

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.

VirtualSystemSubType

Data type: string

Access type: Read-only

The subtype of the virtual system.

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

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

Requirements

Requirement Value
Minimum supported client
 Windows 10, version 1703 [desktop apps only]
Minimum supported server
 Windows Server 2016
Namespace
 Root\virtualization\v2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe

See also

CIM_View