Export (0) Print
Expand All

Msvm_Memory class

Hyper-V

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

class Msvm_Memory : CIM_Memory
{
  string   Caption = "Memory";
  string   Description = "Memory";
  string   ElementName = "Memory";
  datetime InstallDate;
  uint16   OperationalStatus[] = 2;
  string   StatusDescriptions[] = "OK";
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 5;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName = "GUID";
  string   CreationClassName = "Msvm_Memory";
  string   DeviceID = "Microsoft:GUID";
  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   LocationIndicator;
  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.

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

AdditionalAvailability
Data type: uint16 array
Access type: Read-only

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

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

Availability
Data type: uint16
Access type: Read-only

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

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

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

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: 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

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

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

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

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

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

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

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

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

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

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

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

LocationIndicator
Data type: uint16
Access type: Read-only

The state of an indicator that is part of a device. 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)

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

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

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

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

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

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

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.

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

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

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

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

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

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

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: 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

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

SystemName
Data type: string
Access type: Read-only
Qualifiers: 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

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

Namespace

\\.\Root\Virtualization

MOF

WindowsVirtualization.mof

See also

CIM_Memory
Memory Classes

 

 

Community Additions

ADD
Show:
© 2014 Microsoft