Msvm_Memory class

  • Article

Represents the memory currently allocated to a virtual machine.

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_Memory : CIM_Memory
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState;
  uint16   EnabledDefault;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName;
  string   SystemName;
  uint16   CreationClassName;
  string   DeviceID;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = { 6 };
  uint64   MaxQuiesceTime;
  uint16   DataOrganization = 2;
  string   Purpose = "System Memory";
  uint16   Access = 3;
  uint64   BlockSize = 1048576;
  uint64   NumberOfBlocks;
  uint64   ConsumableBlocks;
  boolean  IsBasedOnUnderlyingRedundancy = False;
  boolean  SequentialAccess = False;
  uint16   ExtentStatus[] = 2;
  boolean  NoSinglePointOfFailure = False;
  uint16   DataRedundancy = 1;
  uint16   PackageRedundancy = 0;
  uint8    DeltaReservation = 0;
  boolean  Primordial;
  string   Name = "GUID";
  uint16   NameFormat = 0;
  uint16   NameNamespace = 0;
  string   OtherNameNamespace;
  string   OtherNameFormat;
  boolean  Volatile = True;
  string   ErrorMethodology;
  uint64   StartingAddress = 0;
  uint64   EndingAddress;
  uint16   ErrorInfo;
  string   OtherErrorDescription;
  boolean  CorrectableError;
  datetime ErrorTime;
  uint16   ErrorAccess;
  uint32   ErrorTransferSize;
  uint8    ErrorData[];
  uint16   ErrorDataOrder;
  uint64   ErrorAddress;
  boolean  SystemLevelAddress;
  uint64   ErrorResolution;
  uint8    AdditionalErrorData[];
};

Members

The Msvm_Memory class has these types of members:

Methods

The Msvm_Memory class has these methods.

Method Description
EnableDevice This method is not supported.
OnlineDevice This method is not supported.
QuiesceDevice This method is not supported.
RequestStateChange Requests a state change.
Reset Resets the virtual memory.
RestoreProperties This method is not supported.
SaveProperties This method is not supported.
SetPowerState This method is not supported.

Properties

The Msvm_Memory class has these properties.

Access

Data type: uint16

Access type: Read-only

Describes the read/write properties of the media. This property is inherited from CIM_StorageExtent, and it is set to 3 (Read/Write Supported) by default.

AdditionalAvailability

Data type: uint16 array

Access type: Read-only

This property is inherited from CIM_LogicalDevice, and it is set to 6 (Not Applicable).

AdditionalErrorData

Data type: uint8 array

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

Availability

Data type: uint16

Access type: Read-only

This property is inherited from CIM_LogicalDevice.

AvailableRequestedStates

Data type: uint16 array

Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method. This property is inherited from CIM_EnabledLogicalElement.

BlockSize

Data type: uint64

Access type: Read-only

The size, in bytes, of the blocks that form the storage extent. If variable block size, then the maximum block size, in bytes, should be specified. If the block size is unknown, or if a block concept is not valid (for example, for aggregate extents, memory, or logical disks), enter a 1 (one). This property is inherited from CIM_StorageExtent, and it is always set to 1048576.

Caption

Data type: string

Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement.

CommunicationStatus

Data type: uint16

Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Not Available (1)

Communication OK (2)

Lost Communication (3)

No Contact (4)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

ConsumableBlocks

Data type: uint64

Access type: Read-only

The maximum number of blocks, of size BlockSize, that are available for consumption when layering storage extents using the BasedOn association. This property is inherited from CIM_StorageExtent, and it is always set to Null.

CorrectableError

Data type: boolean

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

CreationClassName

Data type: uint16

Access type: Read-only

The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_LogicalDevice.

DataOrganization

Data type: uint16

Access type: Read-only

The type of data organization used. This property is inherited from CIM_StorageExtent, and it is always set to 2.

DataRedundancy

Data type: uint16

Access type: Read-only

The number of complete copies of data that is currently maintained. This property is inherited from CIM_StorageExtent, and it is always set to 1.

DeltaReservation

Data type: uint8

Access type: Read-only

The current value for delta reservation. This property is inherited from CIM_StorageExtent, and it is always set to 0.

Description

Data type: string

Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

DetailedStatus

Data type: uint16

Access type: Read-only

Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Not Available (0)

No Additional Information (1)

Stressed (2)

Predictive Failure (3)

Non-Recoverable Error (4)

Supporting Entity in Error (5)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

DeviceID

Data type: string

Access type: Read-only

An address or other identifying information to uniquely name the logical device. This property is inherited from CIM_LogicalDevice.

ElementName

Data type: string

Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16

Access type: Read-only

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement.

EnabledState

Data type: uint16

Access type: Read-only

The enabled and disabled states of an element. It can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement.

Value Meaning
Unknown
0
 The state of the element could not be determined.
Other
1
Enabled
2
 The element is running.
Disabled
3
 The element is turned off.
Shutting Down
4
 The element is in the process of going to a Disabled state.
Not Applicable
5
 The element does not support being enabled or disabled.
Enabled but Offline
6
 The element might be completing commands, and it will drop any new requests.
In Test
7
 The element is in a test state.
Deferred
8
 The element might be completing commands, but it will queue any new requests.
Quiesce
9
 The element is enabled, but it is in a restricted mode. The behavior of the element is similar to the Enabled state (2), but it processes only a restricted set of commands. All other requests are queued.
Starting
10
 The element is in the process of going to an Enabled state (2). New requests are queued.

EndingAddress

Data type: uint64

Access type: Read-only

The ending address of the contiguous memory block. Since the StartingAddress property is always 0, this value always reflects the total amount of memory in the virtual machine.

ErrorAccess

Data type: uint16

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

ErrorAddress

Data type: uint64

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

ErrorCleared

Data type: boolean

Access type: Read-only

This property is inherited from CIM_LogicalDevice, but it is not used.

ErrorData

Data type: uint8 array

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

ErrorDataOrder

Data type: uint16

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

ErrorDescription

Data type: string

Access type: Read-only

This property is inherited from CIM_LogicalDevice, but it is not used.

ErrorInfo

Data type: uint16

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

ErrorMethodology

Data type: string

Access type: Read-only

A string that describes the type of error detection and correction supported by this storage extent. This property is inherited from CIM_Memory, and it is always set to Null.

ErrorResolution

Data type: uint64

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

ErrorTime

Data type: datetime

Access type: Read-only

This property is inherited from CIM_Memory but it not used.

ErrorTransferSize

Data type: uint32

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

ExtentStatus

Data type: uint16 array

Access type: Read-only

Storage extents have additional status information beyond that captured in the OperationalStatus and other properties inherited from CIM_ManagedSystemElement. This additional information (for example, "Protection Disabled", value=9) is captured in the VolumeStatus property. This property is inherited from CIM_StorageExtent, and it is always set to 2 (None/Not Applicable).

HealthState

Data type: uint16

Access type: Read-only

The current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely nonfunctional. This property is inherited from CIM_ManagedSystemElement, and it is always set to 5.

IdentifyingDescriptions

Data type: string array

Access type: Read-only

This property is inherited from CIM_LogicalDevice, and it is set to Null.

InstallDate

Data type: datetime

Access type: Read-only

The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

IsBasedOnUnderlyingRedundancy

Data type: boolean

Access type: Read-only

True if the underlying storage extents participate in a Storage Redundancy Group. This property is inherited from CIM_StorageExtent, and it is always set to False.

LastErrorCode

Data type: uint32

Access type: Read-only

This property is inherited from CIM_LogicalDevice, but it is not used.

MaxQuiesceTime

Data type: uint64

Access type: Read-only

This property is inherited from CIM_LogicalDevice, but it is not used.

Name

Data type: string

Access type: Read-only

Qualifiers: MaxLen (1024), Override ("Name")

The label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_StorageExtent, and it is always set to "GUID".

NameFormat

Data type: uint16

Access type: Read-only

This property is inherited from CIM_StorageExtent, and it is always set to 0.

NameNamespace

Data type: uint16

Access type: Read-only

This property is inherited from CIM_StorageExtent, and it is always set to 0.

NoSinglePointOfFailure

Data type: boolean

Access type: Read-only

True if there exists no single point of failure. This property is inherited from CIM_StorageExtent, and it is always set to False.

NumberOfBlocks

Data type: uint64

Access type: Read-only

A calculated value that represents the total amount of memory divided by the BlockSize. This property is inherited from CIM_StorageExtent.

OperatingStatus

Data type: uint16

Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Not Available (1)

Servicing (2)

Starting (3)

Stopping (4)

Stopped (5)

Aborted (6)

Dormant (7)

Completed (8)

Migrating (9)

Emigrating (10)

Immigrating (11)

Snapshotting (12)

Shutting Down (13)

In Test (14)

Transitioning (15)

In Service (16)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

OperationalStatus

Data type: uint16 array

Access type: Read-only

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement.

OtherEnabledState

Data type: string

Access type: Read-only

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 CIM_EnabledLogicalElement, and it is always set to Null.

OtherErrorDescription

Data type: string

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

OtherIdentifyingInfo

Data type: string array

Access type: Read-only

This property is inherited from CIM_LogicalDevice, and it is set to Null.

OtherNameFormat

Data type: string

Access type: Read-only

The namespace of the Name property when the NameFormat property includes the value 1 (Other"). This property is inherited from CIM_StorageExtent, and it is always set to Null.

OtherNameNamespace

Data type: string

Access type: Read-only

The namespace of the Name property when the NameNamespace property includes the value 1 (Other). This property is inherited from CIM_StorageExtent, and it is always set to Null.

PackageRedundancy

Data type: uint16

Access type: Read-only

The number of physical packages that can currently fail without data loss. This property is inherited from CIM_StorageExtent, and it is always set to 0.

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

This property is inherited from CIM_LogicalDevice, but it is not used.

PowerManagementSupported

Data type: boolean

Access type: Read-only

This property is inherited from CIM_LogicalDevice, but it is not used.

PowerOnHours

Data type: uint64

Access type: Read-only

This property is inherited from CIM_LogicalDevice, but it is not used.

PrimaryStatus

Data type: uint16

Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

OK (1)

Degraded (2)

Error (3)

DMTF Reserved (..)

Vendor Reserved (0x8000.. )

Primordial

Data type: boolean

Access type: Read-only

True if the containing system does not have the ability to create or delete this operational element. This property is inherited from CIM_StorageExtent.

Purpose

Data type: string

Access type: Read-only

A string that describes the media and its use. This property is inherited from CIM_StorageExtent, and it is always set to "System Memory".

RequestedState

Data type: uint16

Access type: Read-only

The last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. A particular instance of CIM_EnabledLogicalElement might not support the RequestStateChange method. If this occurs, the value 12 (Not Applicable) is used. This property is inherited from CIM_EnabledLogicalElement.

SequentialAccess

Data type: boolean

Access type: Read-only

True if the storage is sequentially accessed by a media access device. A tape partition is an example of a sequentially accessed storage extent. Storage volumes, disk partitions, and logical disks represent randomly accessed extents. This property is inherited from CIM_StorageExtent, and it is always set to False.

StartingAddress

Data type: uint64

Access type: Read-only

The beginning address referenced by an application or operating system and mapped by a memory controller for this memory object. This property is inherited from CIM_Memory, and it is always set to 0.

Status

Data type: string

Access type: Read-only

This property is inherited from CIM_ManagedSystemElement, but it is not used.

StatusDescriptions

Data type: string array

Access type: Read-only

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.

StatusInfo

Data type: uint16

Access type: Read-only

This property is inherited from CIM_LogicalDevice, but it is not used.

SystemCreationClassName

Data type: string

Access type: Read-only

The scoping system's creation class name. This property is inherited from CIM_LogicalDevice.

SystemLevelAddress

Data type: boolean

Access type: Read-only

This property is inherited from CIM_Memory, but it is not used.

SystemName

Data type: string

Access type: Read-only

The unique identifier for the scoping virtual machine. This property is inherited from CIM_LogicalDevice.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement, and it is always set to "NULL".

TotalPowerOnHours

Data type: uint64

Access type: Read-only

This property is inherited from CIM_LogicalDevice, but it is not used.

TransitioningToState

Data type: uint16

Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement.

Volatile

Data type: boolean

Access type: Read-only

Indicates whether memory is volatile. This property is inherited from CIM_Memory, and it is always set to True.

Remarks

Access to the Msvm_Memory class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

Requirement Value
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
DLL
Vmms.exe

See also

CIM_Memory

CIM_Memory

Memory Classes