1 marek 1.1 // Copyright (c) 2009 DMTF.  All rights reserved.
  2              [Version ( "2.22.0" ), 
  3               UMLPackagePath ( "CIM::Core::Resource" ), 
  4               Description ( 
  5                  "A ResourcePool is a logical entity (with associated "
  6                  "controls)provided by the host system for the purpose of "
  7                  "allocation and assignment of resources. A given ResourcePool "
  8                  "may be used to allocate resources of a specific type. "
  9                  "Hierarchies of ResourcePools may be created to provide "
 10                  "administrative control over allocations. In the cases where "
 11                  "resources are subdivided, multiple resource pools may exist "
 12                  "(e.g. nodal boundaries in NUMA-like systems). In systems that "
 13                  "support over commitment, pools represent the reservable "
 14                  "capacity, not an upper bound or limit on the maximum amount "
 15                  "that can be allocated. Admission control during power on may "
 16                  "detect and prevent systems from powering due to resource "
 17                  "exhaustion. For example, over commitment on a ResourcePool "
 18                  "with ResourceType=Memory would require that sufficient space "
 19                  "be available in some backing-store, that may be managed "
 20                  "through a storage ResourcePool." )]
 21           class CIM_ResourcePool : CIM_LogicalElement {
 22 marek 1.1 
 23                 [Key, Override ( "InstanceID" ), 
 24                  Description ( 
 25                     "Within the scope of the instantiating Namespace, "
 26                     "InstanceID opaquely and uniquely identifies an instance "
 27                     "of this class. To ensure uniqueness within the "
 28                     "NameSpace, the value of InstanceID should be constructed "
 29                     "using the following \"preferred\" algorithm: \n"
 30                     "<OrgID>:<LocalID> \n"
 31                     "Where <OrgID> and <LocalID> are separated by a colon "
 32                     "(:), and where <OrgID> must include a copyrighted, "
 33                     "trademarked, or otherwise unique name that is owned by "
 34                     "the business entity that is creating or defining the "
 35                     "InstanceID or that is a registered ID assigned to the "
 36                     "business entity by a recognized global authority. (This "
 37                     "requirement is similar to the <Schema Name>_<Class Name> "
 38                     "structure of Schema class names.) In addition, to ensure "
 39                     "uniqueness, <OrgID> must not contain a colon (:). When "
 40                     "using this algorithm, the first colon to appear in "
 41                     "InstanceID must appear between <OrgID> and <LocalID>. \n"
 42                     "<LocalID> is chosen by the business entity and should "
 43 marek 1.1           "not be reused to identify different underlying "
 44                     "(real-world) elements. If the above \"preferred\" "
 45                     "algorithm is not used, the defining entity must ensure "
 46                     "that the resulting InstanceID is not reused across any "
 47                     "InstanceIDs produced by this or other providers for the "
 48                     "NameSpace of this instance. \n"
 49                     "For DMTF-defined instances, the \"preferred\" algorithm "
 50                     "must be used with the <OrgID> set to CIM." )]
 51              string InstanceID;
 52           
 53                 [Description ( 
 54                     "An opaque identifier for the pool. This property is used "
 55                     "to provide correlation across save and restore of "
 56                     "configuration data to underlying persistent storage." ), 
 57                  ModelCorrespondence { 
 58                     "CIM_ResourceAllocationSettingData.PoolId" }]
 59              string PoolID;
 60           
 61                 [Description ( 
 62                     "If true, \"Primordial\" indicates that this ResourcePool "
 63                     "is a base from which resources are drawn and returned in "
 64 marek 1.1           "the activity of resource management. Being primordial "
 65                     "means that this ResourcePool shall not be created or "
 66                     "deleted by consumers of this model. However, other "
 67                     "actions, modeled or not, may affect the characteristics "
 68                     "or size of primordial ResourcePools. If false, "
 69                     "\"Primordial\" indicates that the ResourcePool, a "
 70                     "concrete Resource Pool, is subject to resource "
 71                     "allocation services functions. This distinction is "
 72                     "important because higher-level ResourcePools may be "
 73                     "assembled using the Component or "
 74                     "ElementAllocatedFromPool associations. Although the "
 75                     "higher-level abstractions can be created and deleted, "
 76                     "the most basic, (i.e. primordial), hardware-based "
 77                     "ResourcePools cannot. They are physically realized as "
 78                     "part of the System, or are actually managed by some "
 79                     "other System and imported as if they were physically "
 80                     "realized." )]
 81              boolean Primordial = false;
 82           
 83                 [Description ( 
 84                     "This property represents the maximum amount (in units of "
 85 marek 1.1           "AllocationUnits) of reservations that the ResourcePool "
 86                     "can support." )]
 87              uint64 Capacity;
 88           
 89                 [Description ( 
 90                     "This property represents the current reservations (in "
 91                     "units of AllocationUnits) spread across all active "
 92                     "allocations from this pool. In a hierarchical "
 93                     "configuration, this represents the sum of all descendant "
 94                     "ResourcePool current reservations." )]
 95              uint64 Reserved;
 96           
 97                 [Description ( 
 98                     "The type of resource this ResourcePool may allocate." ), 
 99                  ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", 
100                     "11", "12", "13", "14", "15", "16", "17", "18", "19", 
101                     "20", "21", "22", "23", "24", "25", "26", "27", "28", 
102                     "29", "30", "31", "32", "33", "..", "0x8000..0xFFFF" }, 
103                  Values { "Other", "Computer System", "Processor", "Memory", 
104                     "IDE Controller", "Parallel SCSI HBA", "FC HBA", 
105                     "iSCSI HBA", "IB HCA", "Ethernet Adapter", 
106 marek 1.1           "Other Network Adapter", "I/O Slot", "I/O Device", 
107                     "Floppy Drive", "CD Drive", "DVD drive", "Disk Drive", 
108                     "Tape Drive", "Storage Extent", "Other storage device", 
109                     "Serial port", "Parallel port", "USB Controller", 
110                     "Graphics controller", "IEEE 1394 Controller", 
111                     "Partitionable Unit", "Base Partitionable Unit", "Power", 
112                     "Cooling Capacity", "Ethernet Switch Port", 
113                     "Logical Disk", "Storage Volume", "Ethernet Connection", 
114                     "DMTF reserved", "Vendor Reserved" }, 
115                  ModelCorrespondence { "CIM_ResourcePool.OtherResourceType", 
116                     "CIM_ResourcePool.ResourceSubType" }]
117              uint16 ResourceType;
118           
119                 [Description ( 
120                     "A string that describes the resource type when a well "
121                     "defined value is not available and ResourceType is set "
122                     "to 0 for Other." ), 
123                  ModelCorrespondence { "CIM_ResourcePool.ResourceType" }]
124              string OtherResourceType;
125           
126                 [Description ( 
127 marek 1.1           "A string describing an implementation specific sub-type "
128                     "for this pool. For example, this may be used to "
129                     "distinguish different models of the same resource type." ), 
130                  ModelCorrespondence { "CIM_ResourcePool.ResourceType" }]
131              string ResourceSubType;
132           
133                 [Description ( 
134                     "This property specifies the units of allocation used by "
135                     "the Reservation and Limit properties. For example, when "
136                     "ResourceType=Processor, AllocationUnits may be set to "
137                     "hertz*10^6 or percent. When ResourceType=Memory, "
138                     "AllocationUnits may be set to bytes*10^3. The value of "
139                     "this property shall be a legal value of the Programmatic "
140                     "Units qualifier as defined in Appendix C.1 of DSP0004 "
141                     "V2.4 or later." ), 
142                  IsPUnit]
143              string AllocationUnits;
144           
145                 [Description ( 
146                     "This property specifies the units for the MaxConsumable "
147                     "and the Consumed properties." ), 
148 marek 1.1        ModelCorrespondence { 
149                     "CIM_ResourcePool.MaxConsumableResource", 
150                     "CIM_ResourcePool.CurrentlyConsumedResource" }, 
151                  IsPUnit]
152              string ConsumedResourceUnits = "count";
153           
154                 [Description ( 
155                     "This property specifies the amount of resource that the "
156                     "resource pool currently presents to consumers.\n"
157                     "This property is different from the Reserved property in "
158                     "that it describes the consumers view of the resource "
159                     "while the Reserved property describes the producers view "
160                     "of the resource." ), 
161                  ModelCorrespondence { "CIM_ResourcePool.ConsumedResourceUnits" }]
162              uint64 CurrentlyConsumedResource;
163           
164                 [Description ( 
165                     "This property specifies the maximum of amount of "
166                     "consumable resource that the resource pool can present "
167                     "to consumers.\n"
168                     "This property is different from the Capacity property in "
169 marek 1.1           "that it describes the consumers view of the resource "
170                     "while the Capacity property describes the producers view "
171                     "of the resource." ), 
172                  ModelCorrespondence { "CIM_ResourcePool.ConsumedResourceUnits" }]
173              uint64 MaxConsumableResource;
174           
175           
176           };