CIM2.17.1 Class Declaration
CIM_ResourceAllocationSettingData

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_ResourceAllocationSettingData --> CIM_SettingData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_SettingData
NAMECIM_ResourceAllocationSettingData

Class Qualifiers

Class CIM_ResourceAllocationSettingData Qualifiers
NameTypeValueFrom Class
ExperimentalbooleantrueCIM_ResourceAllocationSettingData
Versionstring2.17.0CIM_ResourceAllocationSettingData
UMLPackagePathstringCIM::Core::ResourceCIM_ResourceAllocationSettingData
DescriptionstringThe 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.CIM_ResourceAllocationSettingData
UMLPackagePathstringCIM::Core::SettingsCIM_SettingData
DescriptionstringCIM_SettingData is used to represent configuration and and operational parameters for CIM_ManagedElement instances. There are a number of different uses of CIM_SettingData supported in the model today. Additional uses may be defined in the future.Instances of CIM_SettingData may represent Aspects of a CIM_ManagedElement instance. This is modeled using the CIM_SettingsDefineState association. CIM_SettingData may be used to define capabilities when associated to an instance of CIM_Capabilities through the CIM_SettingsDefineCapabilities association. Instances of CIM_SettingData may represent different types of configurations for a CIM_ManagedElement, including persistent configurations, in progress configuration changes, or requested configurations. The CIM_ElementSettingData association is used to model the relationship between a CIM_SettingData instance and the CIM_ManagedElement for which it is a configuration. When an instance of CIM_SettingData represents a configuration, the current operational values for the parameters of the element are reflected by properties in the Element itself or by properties in its associations. These properties do not have to be the same values that are present in the SettingData object. For example, a modem might have a SettingData baud rate of 56Kb/sec but be operating at 19.2Kb/sec. Note: The CIM_SettingData class is very similar to CIM_Setting, yet both classes are present in the model because many implementations have successfully used CIM_Setting. However, issues have arisen that could not be resolved without defining a new class. Therefore, until a new major release occurs, both classes will exist in the model. Refer to the Core White Paper for additional information. SettingData instances can be aggregated together into higher- level SettingData objects using ConcreteComponent associations.CIM_SettingData
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema.CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
ResourceTypeuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_ResourceAllocationSettingData
OtherResourceTypestring Description
ModelCorrespondence
CIM_ResourceAllocationSettingData
ResourceSubTypestring Description
ModelCorrespondence
CIM_ResourceAllocationSettingData
PoolIDstring Description
ModelCorrespondence
CIM_ResourceAllocationSettingData
ConsumerVisibilityuint16 Description
ValueMap
Values
CIM_ResourceAllocationSettingData
HostResourcestring[] Description
EmbeddedInstance
CIM_ResourceAllocationSettingData
AllocationUnitsstring Description
IsPUnit
CIM_ResourceAllocationSettingData
VirtualQuantityuint64 Description CIM_ResourceAllocationSettingData
Reservationuint64 Description CIM_ResourceAllocationSettingData
Limituint64 Description CIM_ResourceAllocationSettingData
Weightuint32 Description CIM_ResourceAllocationSettingData
AutomaticAllocationboolean Description CIM_ResourceAllocationSettingData
AutomaticDeallocationboolean Description CIM_ResourceAllocationSettingData
Parentstring Description CIM_ResourceAllocationSettingData
Connectionstring[] Description CIM_ResourceAllocationSettingData
Addressstring Description CIM_ResourceAllocationSettingData
MappingBehavioruint16 Description
ValueMap
Values
CIM_ResourceAllocationSettingData
InstanceIDstring Key
Description
CIM_SettingData
ElementNamestring Required
Override
Description
CIM_SettingData
ConfigurationNamestring Experimental
Description
CIM_SettingData
ChangeableTypeuint16 Experimental
Description
ValueMap
Values
CIM_SettingData
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property ResourceType Qualifiers
NameTypeValueFrom Class
DescriptionstringThe type of resource this allocation setting represents.CIM_ResourceAllocationSettingData
ValueMapstring
[See below.]
CIM_ResourceAllocationSettingData
ValuesstringOther
Computer System
Processor
Memory
IDE Controller
Parallel SCSI HBA
FC HBA
iSCSI HBA
IB HCA
Ethernet Adapter
Other Network Adapter
I/O Slot
I/O Device
Floppy Drive
CD Drive
DVD drive
Disk Drive
Tape Drive
Storage Extent
Other storage device
Serial port
Parallel port
USB Controller
Graphics controller
IEEE 1394 Controller
Partitionable Unit
Base Partitionable Unit
Power
Cooling Capacity
Ethernet Switch Port
DMTF reserved
Vendor Reserved
CIM_ResourceAllocationSettingData
ModelCorrespondencestringCIM_ResourceAllocationSettingData.OtherResourceType
CIM_ResourceAllocationSettingData.ResourceSubType
CIM_ResourceAllocationSettingData

NameValue
1Other
2Computer System
3Processor
4Memory
5IDE Controller
6Parallel SCSI HBA
7FC HBA
8iSCSI HBA
9IB HCA
10Ethernet Adapter
11Other Network Adapter
12I/O Slot
13I/O Device
14Floppy Drive
15CD Drive
16DVD drive
17Disk Drive
18Tape Drive
19Storage Extent
20Other storage device
21Serial port
22Parallel port
23USB Controller
24Graphics controller
25IEEE 1394 Controller
26Partitionable Unit
27Base Partitionable Unit
28Power
29Cooling Capacity
30Ethernet Switch Port
..DMTF reserved
0x8000..0xFFFFVendor Reserved
Property OtherResourceType Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that describes the resource type when a well defined value is not available and ResourceType has the value "Other".CIM_ResourceAllocationSettingData
ModelCorrespondencestringCIM_ResourceAllocationSettingData.ResourceTypeCIM_ResourceAllocationSettingData

Property ResourceSubType Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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.CIM_ResourceAllocationSettingData
ModelCorrespondencestringCIM_ResourceAllocationSettingData.ResourceTypeCIM_ResourceAllocationSettingData

Property PoolID Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property specifies which ResourcePool the resource is currently allocated from, or which ResourcePool the resource will be allocated from when the allocation occurs.CIM_ResourceAllocationSettingData
ModelCorrespondencestringCIM_ResourcePool.PoolIdCIM_ResourceAllocationSettingData

Property ConsumerVisibility Qualifiers
NameTypeValueFrom Class
DescriptionstringDescribes 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.CIM_ResourceAllocationSettingData
ValueMapstring
[See below.]
CIM_ResourceAllocationSettingData
ValuesstringUnknown
Passed-Through
Virtualized
Not represented
DMTF reserved
Vendor Reserved
CIM_ResourceAllocationSettingData

NameValue
0Unknown
2Passed-Through
3Virtualized
4Not represented
..DMTF reserved
32767..65535Vendor Reserved
Property HostResource Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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.CIM_ResourceAllocationSettingData
EmbeddedInstancestringCIM_LogicalDeviceCIM_ResourceAllocationSettingData

Property AllocationUnits Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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.CIM_ResourceAllocationSettingData
IsPUnitbooleantrueCIM_ResourceAllocationSettingData

Property VirtualQuantity Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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.CIM_ResourceAllocationSettingData

Property Reservation Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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.CIM_ResourceAllocationSettingData

Property Limit Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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.CIM_ResourceAllocationSettingData

Property Weight Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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.CIM_ResourceAllocationSettingData

Property AutomaticAllocation Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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 isnot present. An explicit operation is required to allocate the resource.CIM_ResourceAllocationSettingData

Property AutomaticDeallocation Qualifiers
NameTypeValueFrom Class
DescriptionstringThis 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.CIM_ResourceAllocationSettingData

Property Parent Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Parent of the resource.For example, a controller for the current allocationCIM_ResourceAllocationSettingData

Property Connection Qualifiers
NameTypeValueFrom Class
DescriptionstringThe thing to which this resource is connected. For example, a named network or switch port.CIM_ResourceAllocationSettingData

Property Address Qualifiers
NameTypeValueFrom Class
DescriptionstringThe address of the resource.For example, the MAC address of a Ethernet port.CIM_ResourceAllocationSettingData

Property MappingBehavior Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies how this resource maps to underlying resourcesIf the HostResource array contains any entries, this property reflects how the resource maps to those specific resources.CIM_ResourceAllocationSettingData
ValueMapstring
[See below.]
CIM_ResourceAllocationSettingData
ValuesstringUnknown
Not Supported
Dedicated
Soft Affinity
Hard Affinity
DMTF Reserved
Vendor Reserved
CIM_ResourceAllocationSettingData

NameValue
0Unknown
2Not Supported
3Dedicated
4Soft Affinity
5Hard Affinity
..DMTF Reserved
32767..65535Vendor Reserved
NameValue
0Unknown
2Not Supported
3Dedicated
4Soft Affinity
5Hard Affinity
..DMTF Reserved
32767..65535Vendor Reserved
NameValue
0Unknown
2Not Supported
3Dedicated
4Soft Affinity
5Hard Affinity
..DMTF Reserved
32767..65535Vendor Reserved
NameValue
0Unknown
2Not Supported
3Dedicated
4Soft Affinity
5Hard Affinity
..DMTF Reserved
32767..65535Vendor Reserved
NameValue
0Unknown
2Not Supported
3Dedicated
4Soft Affinity
5Hard Affinity
..DMTF Reserved
32767..65535Vendor Reserved
NameValue
0Unknown
2Not Supported
3Dedicated
4Soft Affinity
5Hard Affinity
..DMTF Reserved
32767..65535Vendor Reserved
NameValue
0Unknown
2Not Supported
3Dedicated
4Soft Affinity
5Hard Affinity
..DMTF Reserved
32767..65535Vendor Reserved
Property InstanceID Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_SettingData
DescriptionstringWithin 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.CIM_SettingData

Property ElementName Qualifiers
NameTypeValueFrom Class
RequiredbooleantrueCIM_SettingData
DescriptionstringThe 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.)CIM_SettingData

Property ConfigurationName Qualifiers
NameTypeValueFrom Class
DescriptionstringAn 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.CIM_SettingData

Property ChangeableType Qualifiers
NameTypeValueFrom Class
DescriptionstringEnumeration 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.CIM_SettingData
ValueMapstring
[See below.]
CIM_SettingData
ValuesstringNot Changeable - Persistent
Changeable - Transient
Changeable - Persistent
Not Changeable - Transient
CIM_SettingData

NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.CIM_ManagedElement
MaxLenuint3264CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object.CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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 ManagedSystemElement 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.CIM_ManagedElement

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_VirtualSystemSettingDataComponentCIM_ResourceAllocationSettingDataPartComponent
CIM_ResourceAllocationFromPoolCIM_ResourceAllocationSettingDataDependent
CIM_SettingsDefineStateCIM_SettingDataSettingData
CIM_SettingsDefineCapabilitiesCIM_SettingDataPartComponent
CIM_SettingAssociatedToCapabilitiesCIM_SettingDataDependent
CIM_SettingsAffectSettingsCIM_SettingDataAntecedent
CIM_SettingsAffectSettingsCIM_SettingDataDependent
CIM_ElementSettingDataCIM_SettingDataSettingData
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_SettingsDefineStateCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_OrderedComponentCIM_ManagedElementGroupComponent
CIM_OrderedComponentCIM_ManagedElementPartComponent
CIM_ProductElementComponentCIM_ManagedElementPartComponent
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_OrderedMemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_MemberOfStatusCollectionCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_AbstractIndicationSubscriptionCIM_ManagedElementFilter
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_AvailableDiagnosticServiceCIM_ManagedElementUserOfService
CIM_AssociatedPowerManagementServiceCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement