CIM_ResourceAllocationSettingData class
Represents settings for an allocated resource that are outside the scope of the CIM class typically used to represent the resource itself. These settings include information specific to the allocation that may not be visible to the consumer of the resource.
For example, a virtual processor may look like a 2 GHz processor to a virtual computer system that is the consumer of the resource. However, the virtualization system may use time-slicing to schedule the virtual processor to only allow it to use 1 GHz.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, Experimental, Version("2.13.0"), AMENDMENT]
class CIM_ResourceAllocationSettingData : CIM_SettingData
{
string Caption;
string Description;
string InstanceID;
string ElementName;
uint16 ResourceType;
string OtherResourceType;
string ResourceSubType;
string PoolID;
uint16 ConsumerVisibility;
string HostResource[];
string AllocationUnits;
uint64 VirtualQuantity;
uint64 Reservation;
uint64 Limit;
uint32 Weight;
boolean AutomaticAllocation;
boolean AutomaticDeallocation;
string Parent;
string Connection[];
string Address;
uint16 MappingBehavior;
};
Members
The CIM_ResourceAllocationSettingData class has these types of members:
Properties
The CIM_ResourceAllocationSettingData class has these properties.
-
Address
-
-
Data type: string
-
Access type: Read-only
The address of the resource, for example, the MAC address of a Ethernet port.
-
-
AllocationUnits
-
-
Data type: string
-
Access type: Read-only
The allocation units used by the Reservation and Limit properties.
-
-
AutomaticAllocation
-
-
Data type: boolean
-
Access type: Read-only
true to automatically allocate the resource; otherwise, false.
-
-
AutomaticDeallocation
-
-
Data type: boolean
-
Access type: Read-only
true to automatically deallocate the resource; otherwise, false.
-
-
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.
-
-
Connection
-
-
Data type: string array
-
Access type: Read-only
An array that indicates the objects connected to the resource, such as a named network or switch port.
-
-
ConsumerVisibility
-
-
Data type: uint16
-
Access type: Read-only
The consumers visibility to the allocated resource.
-
-
Unknown (0)
-
Passed-Through (2)
-
Virtualized (3)
-
Not represented (4)
-
DMTF reserved
- 5 32766
-
Vendor Reserved
- 32767 65535
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: Required
The user-friendly name for an instance of this class. In addition, the user-friendly name can be used as an index for a search or query. The name does not have to be unique within a namespace.
This property is inherited from CIM_SettingData.
HostResource
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: HyperVEmbeddedInstance ("CIM_LogicalDevice")
An array that contains the assignment of the allocated resources. Each non-null value of this property must be formated as an RFC3986 based URI. If the resource is modeled, then the value should be a WBEM URI.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely 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 property, or be a registered ID that is assigned by a recognized global authority.
- OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.
- 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 DMTF defined instances, the pattern must be used with the OrgID set to "CIM".
This property is inherited from CIM_SettingData.
Limit
-
Data type: uint64
-
Access type: Read-only
The maximum amount of resource to grant to the allocation. The unit type of this property is specified by the AllocationUnits property.
MappingBehavior
-
Data type: uint16
-
Access type: Read-only
Indicates how the resource maps to underlying resources.
Unknown (0)
Not Supported (1)
Dedicated (2)
Soft Affinity (3)
Hard Affinity (4)
DMTF Reserved
Vendor Reserved
OtherResourceType
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ResourceType")
A description of the resource type when the ResourceType property is set to 1 (other).
Parent
-
Data type: string
-
Access type: Read-only
The parent of the resource, for example, a controller for the current allocation.
PoolID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.PoolId")
The ID of the resource pool that generated the resource.
Reservation
-
Data type: uint64
-
Access type: Read-only
The number of resource that are guaranteed to be available for this allocation. On systems that support over-commitment of resources, this value is typically used for admission control.
The unit type of this property is specified by the AllocationUnits property.
ResourceSubType
-
Data type: string
-
Access type: Read-only
An implementation specific sub-type for this resource. For example, this may be used to distinguish different models of the same resource type.
ResourceType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.OtherResourceType")
The type of resource that is represented by the allocation settings.
Other (1)
Computer System (2)
Processor (3)
Memory (4)
IDE Controller (5)
Parallel SCSI HBA (6)
FC HBA (7)
iSCSI HBA (8)
IB HCA (9)
Ethernet Adapter (10)
Other Network Adapter (11)
I/O Device (12)
Floppy Drive (13)
CD Drive (14)
DVD drive (15)
Serial port (16)
Parallel port (17)
USB Controller (18)
Graphics controller (19)
Storage Extent (20)
Disk (21)
Tape (22)
Other storage device (23)
Firewire Controller (24)
Partitionable Unit (25)
Base Partitionable Unit (26)
Power Supply (27)
Cooling Device (28)
DMTF reserved
Vendor Reserved
VirtualQuantity
-
Data type: uint64
-
Access type: Read-only
The number of resources presented to the consumer of the resource.
Weight
-
Data type: uint32
-
Access type: Read-only
The relative priority for this allocation in relation to other allocations from the same resource pool.
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 |
|