Share via

Msvm_Memory class

Represents the memory currently allocated to a virtual system.

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   Caption = "Memory";
  string   Description = "Memory";
  string   ElementName = "Memory";
  datetime InstallDate;
  uint16   OperationalStatus[] = 2;
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 5;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName = "GUID";
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[];
  uint64   MaxQuiesceTime;
  uint16   LocationIndicator;
  uint16   DataOrganization = 2;
  string   Purpose = "System Memory";
  uint16   Access = 3;
  uint64   NumberOfBlocks;
  boolean  IsBasedOnUnderlyingRedundancy = False;
  boolean  SequentialAccess = False;
  uint16   ExtentStatus[] = 2;
  boolean  NoSinglePointOfFailure = False;
  uint16   DataRedundancy = 1;
  uint16   PackageRedundancy = 0;
  uint8    DeltaReservation = 0;
  boolean  Primordial = FALSE;
  string   Name = "GUID";
  uint16   NameFormat = 0;
  uint16   NameNamespace = 0;
  boolean  Volatile = TRUE;
  string   ErrorMethodology;
  uint64   StartingAddress = 0;
  uint16   ErrorInfo;
  string   OtherErrorDescription;
  boolean  CorrectableError;
  datetime ErrorTime;
  uint16   ErrorAccess;
  uint32   ErrorTransferSize;
  uint8    ErrorData[];
  uint16   ErrorDataOrder;
  uint64   ErrorAddress;
  boolean  SystemLevelAddress;
  uint64   ErrorResolution;
  uint8    AdditionalErrorData[];
  string   StatusDescriptions[] = "OK";
  uint16   EnabledDefault = 2;
  string   CreationClassName = "Msvm_Memory";
  string   DeviceID = "Microsoft:GUID";
  string   OtherIdentifyingInfo[];
  uint64   BlockSize = 1048576;
  uint64   ConsumableBlocks;
  string   OtherNameNamespace;
  string   OtherNameFormat;
  uint64   EndingAddress;
};

Members

The Msvm_Memory class has these types of members:

Methods

The Msvm_Memory class has these methods.

Method Description
EnableDevice This method is inherited from CIM_LogicalDevice and it is not used.
OnlineDevice This method is inherited from CIM_LogicalDevice and it is not used.
QuiesceDevice This method is inherited from CIM_LogicalDevice and it is not used.
RequestStateChange Requests that the state of the element be changed to the value specified in the RequestedState parameter. This method is inherited from CIM_EnabledLogicalElement and it is not used.
Reset Requests a reset of the logical device. This method is inherited from CIM_LogicalDevice and it is not used.
RestoreProperties This method is inherited from CIM_LogicalDevice and it is not used.
SaveProperties This method is inherited from CIM_LogicalDevice and it is not used.
SetPowerState This method is inherited from CIM_LogicalDevice and it is not used.

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.

The possible values are:

Unknown (0)

Readable (1)

Writeable (2)

Read/Write Supported (3)

Write Once (4)

AdditionalAvailability

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

Any additional availability and status of the device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the device. This property is inherited from CIM_LogicalDevice and it is always set to {6} (Not Applicable).

AdditionalErrorData

Data type: uint8 array

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.AdditionalErrorData"), OctetString, MappingStrings ("MIF.DMTF|Memory Device|005.18", "MIF.DMTF|Physical Memory Array|001.13"), MAX (64)

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

Availability

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_AssociatedPowerManagementService.PowerState", "CIM_ManagedSystemElement.OperationalStatus", "CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")

The availability and status of the device. This property is inherited from CIM_LogicalDevice.

BlockSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("Bytes"), MappingStrings ("MIF.DMTF|Host Storage|001.4", "MIB.IETF|HOST-RESOURCES-MIB.hrStorageAllocationUnits", "MIF.DMTF|Storage Devices|001.5")

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

Qualifiers: MaxLen (64)

A short textual description (one-line string) of the object. This property is inherited from CIM_ManagedElement and it is always set to "Memory".

ConsumableBlocks

Data type: uint64

Access type: Read-only

The maximum number of blocks, of size BlockSize, which 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

Qualifiers: Deprecated ("CIM_MemoryError.CorrectableError"), MappingStrings ("MIF.DMTF|Physical Memory Array|001.8")

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

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

The name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice and it is always set to "Msvm_Memory".

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

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.DataRedundancyGoal", "CIM_StorageSetting.DataRedundancyMax", "CIM_StorageSetting.DataRedundancyMin")

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

Qualifiers: Units ("Percentage"), MinValue (1), MaxValue (100), ModelCorrespondence ("CIM_StorageSetting.DeltaReservationGoal", "CIM_StorageSetting.DeltaReservationMax", "CIM_StorageSetting.DeltaReservationMin")

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 textual description of the object. This property is inherited from CIM_ManagedElement and it is always set to "Memory".

DeviceID

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (64)

An address or other identifying information to uniquely name the logical device. This property is inherited from CIM_LogicalDevice and it is always set to "Microsoft:GUID".

ElementName

Data type: string

Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of the CIM_ManagedSystemElement class is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. This property is inherited from CIM_ManagedElement and it is set to "Memory".

EnabledDefault

Data type: uint16

Access type: Read/write

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 2 (Enabled).

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 5 (Not Applicable).

Not Applicable (5)

Indicates the element does not support to be enabled or disabled.

EndingAddress

Data type: uint64

Access type: Read-only

Qualifiers: Units ("KiloBytes"), MappingStrings ("MIF.DMTF|Memory Array Mapped Addresses|001.4", "MIF.DMTF|Memory Device Mapped Addresses|001.5")

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 system.

ErrorAccess

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.ErrorAccess"), MappingStrings ("MIF.DMTF|Physical Memory Array|001.10")

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

ErrorAddress

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.StartingAddress"), MappingStrings ("MIF.DMTF|Memory Device|005.19", "MIF.DMTF|Physical Memory Array|001.14")

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

ErrorCleared

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")

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

ErrorData

Data type: uint8 array

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.ErrorData"), OctetString, MappingStrings ("MIF.DMTF|Physical Memory Array|001.12"), ArrayType ("Indexed"), MAX (64)

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

ErrorDataOrder

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.ErrorDataOrder")

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

ErrorDescription

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")

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

ErrorInfo

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.ErrorInfo"), MappingStrings ("MIF.DMTF|Memory Device|005.12", "MIF.DMTF|Physical Memory Array|001.8"), ModelCorrespondence ("CIM_Memory.OtherErrorDescription")

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

ErrorMethodology

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Physical Memory Array|001.7")

A free-form 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

Qualifiers: Deprecated ("CIM_MemoryError.ErrorResolution"), Units ("Bytes"), MappingStrings ("MIF.DMTF|Memory Device|005.21", "MIF.DMTF|Physical Memory Array|001.15")

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

ErrorTime

Data type: datetime

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.ErrorTime")

This property is inherited from CIM_Memory but it not used.

ErrorTransferSize

Data type: uint32

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.ErrorTransferSize"), Units ("Bits"), MappingStrings ("MIF.DMTF|Physical Memory Array|001.11")

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 property is inherited from CIM_ManagedSystemElement and it is always set to 5 (OK).

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

IdentifyingDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

An array of free-form strings that provide explanations and details behind the entries in the OtherIdentifyingInfo array. This property is inherited from CIM_LogicalDevice and it is always set to NULL.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

The date and time at which the virtual system was created. This property is inherited from CIM_ManagedSystemElement.

IsBasedOnUnderlyingRedundancy

Data type: boolean

Access type: Read-only

If True, indicates whether the underlying storage extent(s) 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

Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

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

LocationIndicator

Data type: uint16

Access type: Read/write

Qualifiers: Experimental, ModelCorrespondence ("CIM_AlarmDevice.AlarmState", "CIM_AlarmDevice.AudioIndicatorIsDisabled", "CIM_AlarmDevice.VisualIndicatorIsDisabled", "CIM_AlarmDevice.MotionIndicatorIsDisabled")

The state of an indicator that is part of a device. This property is inherited from CIM_LogicalDevice but it is not used.

Unknown (0)

On (2)

Off (3)

Not Supported (4)

MaxQuiesceTime

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

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

Name

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("SPC.INCITS-T10| VPD 83, Association 0 | Identifier"), ModelCorrespondence ("CIM_StorageExtent.NameFormat", "CIM_StorageExtent.NameNamespace")

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

Qualifiers: ModelCorrespondence ("CIM_StorageExtent.Name", "CIM_StorageExtent.NameNamespace", "CIM_StorageExtent.OtherNameFormat")

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

NameNamespace

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("SPC.INCITS-T10| VPD 83, Association 0 | Identifier"), ModelCorrespondence ("CIM_StorageExtent.Name", "CIM_StorageExtent.OtherNameNamespace", "CIM_StorageExtent.NameFormat")

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

NoSinglePointOfFailure

Data type: boolean

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.NoSinglePointOfFailure")

Indicates whether 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

Qualifiers: MappingStrings ("MIF.DMTF|Host Storage|001.5", "MIB.IETF|HOST-RESOURCES-MIB.hrStorageSize")

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

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

The current status of the element. This property is inherited from CIM_ManagedSystemElement and it is always set to 2 (OK).

OK (2)

Indicates full functionality without errors.

OtherEnabledState

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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

OtherErrorDescription

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.OtherErrorDescription"), ModelCorrespondence ("CIM_Memory.ErrorInfo")

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

OtherIdentifyingInfo

Data type: string array

Access type: Read-only

Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

Any additional data, beyond device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice and it is always set to NULL.

OtherNameFormat

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StorageExtent.NameFormat")

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

Qualifiers: ModelCorrespondence ("CIM_StorageExtent.NameNamespace")

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

Qualifiers: ModelCorrespondence ("CIM_StorageSetting.PackageRedundancyGoal", "CIM_StorageSetting.PackageRedundancyMax", "CIM_StorageSetting.PackageRedundancyMin")

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

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

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

PowerManagementSupported

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")

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

PowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("CIM_PoweredStatisticalData.PowerOnHours"), Units ("Hours"), Counter

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

Primordial

Data type: boolean

Access type: Read-only

If True, indicates whether 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

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrStorageDescr")

A free-form 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

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

The last requested or desired state for the element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 5 (No Change).

No Change (5)

No state change has been requested.

SequentialAccess

Data type: boolean

Access type: Read-only

If True, indicates whether 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

Qualifiers: Units ("KiloBytes"), MappingStrings ("MIF.DMTF|Memory Array Mapped Addresses|001.3", "MIF.DMTF|Memory Device Mapped Addresses|001.4")

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

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

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

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings that describes the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and it is always set to "OK".

StatusInfo

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")

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

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The scoping system's creation class name. This property is inherited from CIM_LogicalDevice and it is set to "Msvm_ComputerSystem".

SystemLevelAddress

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_MemoryError.SystemLevelAddress")

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

SystemName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The scoping system's name. This value corresponds to the value of the Name property of the Msvm_ComputerSystem class for the scoping virtual system. This property is inherited from CIM_LogicalDevice and it is always set to "GUID".

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

The time when the virtual machine's state was last modified. This property is inherited from CIM_EnabledLogicalElement.

TotalPowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter

This property is inherited from CIM_LogicalDevicebut it is not used.

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
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2008
End of client support
 None supported
End of server support
 Windows Server 2012 R2
Namespace
 Root\Virtualization
MOF
WindowsVirtualization.mof

See also

CIM_Memory

CIM_Memory

Memory Classes