class CIM_ResourceAllocationSettingData : CIM_SettingData


Description:

The ResourceAllocationSettingData class represents settings specifically related to 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 itself. For example, a virtual processor may look like a 2 ghz processor to the consumer (virtual computer system), however the virtualization system may use time-slicing to schedule the the virtual processor to only allow it to use 1 ghz.

Definition:

Feature Type Class Origin Qualifiers
Caption string CIM_ManagedElement
Description The Caption property is a short textual description (one- line string) of the object.
MaxLen 64
Description string CIM_ManagedElement
Description The Description property provides a textual description of the object.
ElementName string CIM_ManagedElement
Required TRUE
Override ElementName
Description The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)
InstanceID string CIM_SettingData
Key TRUE
Description Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.
ConfigurationName string CIM_SettingData
Experimental TRUE
Description An instance of CIM_SettingData may correspond to a well-known configuration that exists for an associated CIM_ManagedElement. If the ConfigurationName property is non-NULL, the instance of CIM_SettingData shall correspond to a well-known configuration for a Managed Element, the value of the ConfigurationName property shall be the name of the configuration, and the ChangeableType property shall have the value 0 or 2. A value of NULL for the ConfigurationName property shall mean that the instance of CIM_SettingData does not correspond to a well-known configuration for a Managed Element or that this information is unknown.
ChangeableType uint16 CIM_SettingData
Experimental TRUE
Description Enumeration indicating the type of setting. 0 "Not Changeable - Persistent" indicates the instance of SettingData represents primordial settings and shall not be modifiable. 1 "Changeable - Transient" indicates the SettingData represents modifiable settings that are not persisted. Establishing persistent settings from transient settings may be supported. 2 "Changeable - Persistent" indicates the SettingData represents a persistent configuration that may be modified. 3 "Not Changeable - Transient" indicates the SettingData represents a snapshot of the settings of the associated ManagedElement and is not persistent.
ValueMap 0, 1, 2, 3
Values "Not Changeable - Persistent" [0]
"Changeable - Transient" [1]
"Changeable - Persistent" [2]
"Not Changeable - Transient" [3]
ResourceType uint16 CIM_ResourceAllocationSettingData
Description The type of resource this allocation setting represents.
ValueMap 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, .., 0x8000..0xFFFF
Values "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 Slot" [12]
"I/O Device" [13]
"Floppy Drive" [14]
"CD Drive" [15]
"DVD drive" [16]
"Disk Drive" [17]
"Tape Drive" [18]
"Storage Extent" [19]
"Other storage device" [20]
"Serial port" [21]
"Parallel port" [22]
"USB Controller" [23]
"Graphics controller" [24]
"IEEE 1394 Controller" [25]
"Partitionable Unit" [26]
"Base Partitionable Unit" [27]
"Power" [28]
"Cooling Capacity" [29]
"Ethernet Switch Port" [30]
"DMTF reserved" [..]
"Vendor Reserved" [0x8000..0xFFFF]
ModelCorrespondence CIM_ResourceAllocationSettingData.OtherResourceType, CIM_ResourceAllocationSettingData.ResourceSubType
OtherResourceType string CIM_ResourceAllocationSettingData
Description A string that describes the resource type when a well defined value is not available and ResourceType has the value "Other".
ModelCorrespondence CIM_ResourceAllocationSettingData.ResourceType
ResourceSubType string CIM_ResourceAllocationSettingData
Description A string describing an implementation specific sub-type for this resource. For example, this may be used to distinguish different models of the same resource type.
ModelCorrespondence CIM_ResourceAllocationSettingData.ResourceType
PoolID string CIM_ResourceAllocationSettingData
Description This property specifies which ResourcePool the resource is currently allocated from, or which ResourcePool the resource will be allocated from when the allocation occurs.
ModelCorrespondence CIM_ResourcePool.PoolId
ConsumerVisibility uint16 CIM_ResourceAllocationSettingData
Description Describes the consumers visibility to the allocated resource. A value of "Passed-Through" indicates the underlying or host resource is utilized and passed through to the consumer, possibly using partitioning. At least one item shall be present in the HostResource property. A value of "Virtualized" indicates 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 HostResource property. A value of "Not represented" indicates a representation of the resource does not exist within the context of the resource consumer.
ValueMap 0, 2, 3, 4, .., 32767..65535
Values "Unknown" [0]
"Passed-Through" [2]
"Virtualized" [3]
"Not represented" [4]
"DMTF reserved" [..]
"Vendor Reserved" [32767..65535]
HostResource string[] CIM_ResourceAllocationSettingData
Description This property exposes specific assignment to host or underlying resources. The embedded instances shall contain only key properties and be treated as Object Paths. If the virtual resource may be scheduled on a number of underlying resources, this property shall be left NULL. In that case, the DeviceAllocatedFromPool or ResourceAllocationFromPool associations may be used to determine the pool of host resources this virtual resource may be scheduled on. If specific assignment is utilized, all underlying resources used by this virtual resource shall be listed in this array. Typically the array will contain one item, however for aggregate allocations, such as multiple processors, multiple host resources may be specified.
EmbeddedInstance CIM_LogicalDevice
AllocationUnits string CIM_ResourceAllocationSettingData
Description This property specifies the units of allocation used by the Reservation and Limit properties. For example, when ResourceType=Processor, AllocationUnits may be set to hertz*10^6 or percent. When ResourceType=Memory, AllocationUnits may be set to bytes*10^3. The value of this property shall be a legal value of the Programmatic Units qualifier as defined in Appendix C.1 of DSP0004 V2.4 or later.
IsPUnit TRUE
VirtualQuantity uint64 CIM_ResourceAllocationSettingData
Description This property specifies the quantity of resources presented to the consumer. For example, when ResourceType=Processor, this property would reflect the number of discrete Processors presented to the virtual computer system. When ResourceType=Memory, this property could reflect the number of MB reported to the virtual computer system.
Reservation uint64 CIM_ResourceAllocationSettingData
Description This property specifies the amount of resource guaranteed to be available for this allocation. On system which support over-commitment of resources, this value is typically used for admission control to prevent an an allocation from being accepted thus preventing starvation.
Limit uint64 CIM_ResourceAllocationSettingData
Description This property specifies the upper bound, or maximum amount of resource that will be granted for this allocation. For example, a system which supports memory paging may support setting the Limit of a Memory allocation below that of the VirtualQuantity, thus forcing paging to occur for this allocation.
Weight uint32 CIM_ResourceAllocationSettingData
Description This property specifies a relative priority for this allocation in relation to other allocations from the same ResourcePool. This property has no unit of measure, and is only relevant when compared to other allocations vying for the same host resources.
AutomaticAllocation boolean CIM_ResourceAllocationSettingData
Description This property specifies if 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 (cdrom, floppy, etc.) where at power on time, the media is not present. An explicit operation is required to allocate the resource.
AutomaticDeallocation boolean CIM_ResourceAllocationSettingData
Description This property specifies if the resource will be automatically de-allocated. For example, when set to true, when the consuming virtual computer system is powered off, this resource would be de-allocated. When set to false, the resource will remain allocated and must be explicitly de-allocated.
Parent string CIM_ResourceAllocationSettingData
Description The Parent of the resource. For example, a controller for the current allocation
Connection string[] CIM_ResourceAllocationSettingData
Description The thing to which this resource is connected. For example, a named network or switch port.
Address string CIM_ResourceAllocationSettingData
Description The address of the resource. For example, the MAC address of a Ethernet port.
MappingBehavior uint16 CIM_ResourceAllocationSettingData
Description Specifies how this resource maps to underlying resourcesIf the HostResource array contains any entries, this property reflects how the resource maps to those specific resources.
ValueMap 0, 2, 3, 4, 5, .., 32767..65535
Values "Unknown" [0]
"Not Supported" [2]
"Dedicated" [3]
"Soft Affinity" [4]
"Hard Affinity" [5]
"DMTF Reserved" [..]
"Vendor Reserved" [32767..65535]

Typographical Conventions:

  1. Inherited properties are italicized.
  2. Local properties are bolded.
  3. Key properties are highlighted in gold