Msvm_SummaryInformationBase class

Retrieves summary information about a virtual machine or snapshot for the GetSummaryInformation method of the Msvm_VirtualSystemManagementService class.

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   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;
};

Members

The Msvm_SummaryInformationBase class has these types of members:

• Properties

Properties

The Msvm_SummaryInformationBase class has these properties.

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.

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

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

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.

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_SummaryInformationBase 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:2"

Requirements

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

See also

CIM_View