Msvm_MemorySettingData class
Represents the configured state of the memory for 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_MemorySettingData : CIM_ResourceAllocationSettingData
{
string Caption = "Memory";
string Description = "Settings for Microsoft Virtual Machine Memory";
string InstanceID;
string ElementName = "Memory";
uint16 ResourceType = 4;
string OtherResourceType;
string ResourceSubType = "Microsoft Virtual Machine Memory";
string PoolID;
uint16 ConsumerVisibility;
string HostResource[];
string AllocationUnits = "MB";
uint64 Reservation;
uint64 Limit;
uint32 Weight;
uint16 MappingBehavior;
uint64 VirtualQuantity;
boolean AutomaticAllocation = True;
boolean AutomaticDeallocation = True;
string Parent;
string Connection[];
string Address;
boolean IsVirtualized = True;
string DeviceID = "Microsoft:GUID";
string DeviceIDFormat;
boolean DynamicMemoryEnabled;
uint32 TargetMemoryBuffer;
};
Members
The Msvm_MemorySettingData class has these types of members:
Properties
The Msvm_MemorySettingData class has these properties.
-
Address
-
-
Data type: string
-
Access type: Read-only
The address of the resource. For example, the MAC address of an Ethernet port. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.
-
-
AllocationUnits
-
-
Data type: string
-
Access type: Read-only
The units of allocation used by the Reservation and Limit properties. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to "MB".
-
-
AutomaticAllocation
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the resource will be automatically allocated. For example when set to True, when the consuming virtual computer system is powered on, this resource would be allocated. A value of False indicates the resource must be explicitly allocated. For example, the setting may represent removable media (such as a CD-ROM or a floppy) where at power on time, the media is not present. An explicit operation is required to allocate the resource. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to True.
-
-
AutomaticDeallocation
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the resource will be automatically allocated. For example when this property is set to True, when the consuming virtual computer system is powered on, this resource would be allocated. When this property is False, the resource must be explicitly allocated. For example, the setting may represent removable media (such as a CD-ROM or a floppy) where at power on time, the media is not present. An explicit operation is required to allocate the resource. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to True.
-
-
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".
-
-
Connection
-
-
Data type: string array
-
Access type: Read-only
The device to which this resource is connected. For example, a named network or switch port. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.
-
-
ConsumerVisibility
-
-
Data type: uint16
-
Access type: Read-only
Describes the consumers visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.
-
-
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 "Settings for Microsoft Virtual Machine Memory".
-
-
DeviceID
-
-
Data type: string
-
Access type: Read-only
Address or other identifying information to uniquely name the logical device. This property is always set to "Microsoft:GUID".
-
-
DeviceIDFormat
-
-
Data type: string
-
Access type: Read-only
The format of the corresponding DeviceID property, or the supported device IDs when used to represent a capability. This property is not used.
-
-
DynamicMemoryEnabled
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether dynamic memory is enabled for the virtual machine.
This is a read-only property, but it can be changed by using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.
Windows Server 2008 R2: Reserved for future use. Note that this behavior has changed with Windows Server 2008 R2 with SP1.
Windows Server 2008: The DynamicMemoryEnabled property is not available.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Required
A user-friendly name for the object. This property is inherited from CIM_SettingData and it is set to "Memory". Changing this property will change the element name of the associated logical device derivative.
This is a read-only property, but it can be changed by using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.
-
-
HostResource
-
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: HyperVEmbeddedInstance ("CIM_LogicalDevice")
This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
For instances associated with a virtual system, this defaults to "Microsoft:GUID\device-specific data". For instances which define potential settings for a virtual system, this defaults to "Microsoft:Definition\GUID\Type", where Type is "Maximum", "Minimum", "Default", or "Increment". This property is inherited from CIM_SettingData.
-
-
IsVirtualized
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether this device is virtualized or passed through. When set to False, the underlying or host resource is utilized. At least one item shall be present in the DeviceID property. When set to True, the resource is virtualized and may not map directly to an underlying/host resource. Some implementations may support specific assignment for virtualized resources, in which case the host resource(s) are exposed using the DeviceID property. This property is always set to True.
-
-
Limit
-
-
Data type: uint64
-
Access type: Read-only
The maximum amount of memory that may be consumed by the virtual system. For a virtual system with dynamic memory enabled, this represents the maximum memory setting. This property is inherited from CIM_ResourceAllocationSettingData.
This is a read-only property, but it can be changed by using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.
-
-
MappingBehavior
-
-
Data type: uint16
-
Access type: Read-only
Specifies how this resource maps to underlying resources. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.
-
-
OtherResourceType
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ResourceType")
A string that describes the resource type when a well-defined value is not available and ResourceType has the value "Other". This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.
-
-
Parent
-
-
Data type: string
-
Access type: Read-only
The parent of the resource. For example, a controller for the current allocation. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.
-
-
PoolID
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.PoolId")
The identifier of the resource pool from which this resource was allocated. This property is inherited from CIM_ResourceAllocationSettingData.
-
-
Reservation
-
-
Data type: uint64
-
Access type: Read-only
Specifies the amount of memory guaranteed to be available for this VM. For a virtual system with dynamic memory enabled, this represents the minimum memory setting. This property is inherited from CIM_ResourceAllocationSettingData.
This is a read-only property, but it can be changed by using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.
-
-
ResourceSubType
-
-
Data type: string
-
Access type: Read-only
A string that describes an implementation specific sub-type for this resource. For example, this may be used to distinguish different models of the same resource type. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to "Microsoft Virtual Machine Memory".
-
-
ResourceType
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.OtherResourceType")
The type of resource that this allocation setting represents. This property is inherited from CIM_ResourceAllocationSettingData and it is always set to 4 (Memory).
-
-
TargetMemoryBuffer
-
-
Data type: uint32
-
Access type: Read-only
Defines the amount of extra memory that should be reserved for a virtual machine at runtime, as a percentage of the total memory that the virtual machine is thought to need. This only applies to virtual systems with dynamic memory enabled.
This property can be in the range of 5 to 2000.
This is a read-only property, but it can be changed by using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.
Windows Server 2008 R2 and Windows Server 2008: This property is not supported. Note that this behavior has changed with Windows Server 2008 R2 with SP1.
-
-
VirtualQuantity
-
-
Data type: uint64
-
Access type: Read-only
The total amount of RAM in the virtual system, as seen by the guest operating system. For a virtual system with dynamic memory enabled, this represents the initial memory available at startup. This property is inherited from CIM_ResourceAllocationSettingData.
This is a read-only property, but it can be changed by using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.
-
-
Weight
-
-
Data type: uint32
-
Access type: Read-only
Defines the memory allocation weighting value for each virtual machine. After all reserves have been met, the remaining memory of the hosting platform will be allocated to virtual systems based on their relative weights (not to exceed the value specified by the Limit property). This property is inherited from CIM_ResourceAllocationSettingData.
Windows Server 2008 R2 with SP1: This property can be in the range of 0 to 10000.
Windows Server 2008 R2 and Windows Server 2008: This property can be in the range of 0 to 1000.
This is a read-only property, but it can be changed by using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.
-
Remarks
Access to the Msvm_MemorySettingData 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 |
|