CIM_StorageAllocationSettingData class
Represents settings for the allocation of virtual storage.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Core::Resource")]
class CIM_StorageAllocationSettingData : CIM_ResourceAllocationSettingData
{
string Caption;
string Description;
string InstanceID;
string ElementName;
uint16 ResourceType;
string OtherResourceType;
string ResourceSubType;
string PoolID;
uint16 ConsumerVisibility;
string HostResource[];
string AllocationUnits;
uint32 Weight;
boolean AutomaticAllocation;
boolean AutomaticDeallocation;
string Parent;
string Connection[];
string Address;
uint16 MappingBehavior;
string AddressOnParent;
uint64 VirtualResourceBlockSize;
uint64 VirtualQuantity;
string VirtualQuantityUnits = "count(fixed size block)";
uint16 Access;
uint64 HostResourceBlockSize;
uint64 Reservation;
uint64 Limit;
uint64 HostExtentStartingAddress;
string HostExtentName;
uint16 HostExtentNameFormat;
string OtherHostExtentNameFormat;
uint16 HostExtentNameNamespace;
string OtherHostExtentNameNamespace;
};
Members
The CIM_StorageAllocationSettingData class has these types of members:
Properties
The CIM_StorageAllocationSettingData class has these properties.
-
Access
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageExtent.Access")
The read/write support of the storage allocation.
The possible values are:
-
-
Unknown (0)
-
Readable (1)
-
Writeable (2)
-
Read/Write Supported (3)
-
DMTF Reserved
- 4 65535
Address
-
Data type: string
-
Access type: Read-only
The address of the resource, for example, the MAC address of a Ethernet port.
This property is inherited from CIM_ResourceAllocationSettingData.
AddressOnParent
-
Data type: string
-
Access type: Read-only
The address of this resource from the context of the parent. This property is used to describe a controller relationship and the ordering of devices on a controller. For example, if the parent is a PCI Controller, this property would specify the PCI slot of this child device.
This property is inherited from CIM_ResourceAllocationSettingData.
AllocationUnits
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.Reservation", "CIM_ResourceAllocationSettingData.Limit"), IsPUnit
The allocation units used by the Reservation and Limit properties.
This property is inherited from CIM_ResourceAllocationSettingData.
AutomaticAllocation
-
Data type: boolean
-
Access type: Read-only
true to automatically allocate the resource; otherwise, false.
This property is inherited from CIM_ResourceAllocationSettingData.
AutomaticDeallocation
-
Data type: boolean
-
Access type: Read-only
true to automatically deallocate the resource; otherwise, false.
This property is inherited from CIM_ResourceAllocationSettingData.
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.
This property is inherited from CIM_ResourceAllocationSettingData.
ConsumerVisibility
-
Data type: uint16
-
Access type: Read-only
The consumers visibility to the allocated resource.
This property is inherited from CIM_ResourceAllocationSettingData.
Unknown (0)
Passed-Through (2)
Virtualized (3)
Not represented (4)
DMTF reserved
Vendor Reserved
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.
HostExtentName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageAllocationSettingData.HostExtentNameFormat", "CIM_StorageAllocationSettingData.HostExtentNameNamespace", "CIM_StorageExtent.Name")
A unique identifier of the host storage extent.
HostExtentNameFormat
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageAllocationSettingData.HostExtentName", "CIM_StorageAllocationSettingData.OtherHostExtentNameFormat", "CIM_StorageExtent.NameFormat")
The format that of the HostExtentName property value.
The possible values are:
Unknown (0)
Other (1)
SNVM (7)
NAA (9)
EUI64 (10)
T10VID (11)
OS Device Name (12)
DMTF Reserved
HostExtentNameNamespace
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageAllocationSettingData.HostExtentName", "CIM_StorageAllocationSettingData.OtherHostExtentNameNamespace", "CIM_StorageAllocationSettingData.HostExtentNameFormat", "CIM_StorageExtent.Namespace")
The naming format for the Name property.
The possible values are:
Unknown (0)
Other (1)
VPD83Type3 (2)
VPD83Type2 (3)
VPD83Type1 (4)
VPD80 (5)
NodeWWN (6)
SNVM (7)
OS Device Namespace (8)
DMTF Reserved
HostExtentStartingAddress
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageAllocationSettingData.HostResourceBlockSize", "CIM_BasedOn.StartingAddress")
The starting address on the host storage extent. A NULL val;ue indicates that there is no direct mapping between the virtual storage extent and the host storage extent.
HostResource
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ConsumerVisibility", "CIM_ResourceAllocationSettingData.MappingBehavior")
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.
This property is inherited from CIM_ResourceAllocationSettingData.
HostResourceBlockSize
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageExtent.BlockSize"), PUnit ("byte")
The size, in bytes, of the blocks that are allocated on the host for the storage allocation. If the block size is variable, then the maximum block size in bytes should be specified. If the block size is unknown or if a block concept does not apply, then the value "1" (unknown) should be used.
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
-
Qualifiers: Override ("Limit"), ModelCorrespondence ("CIM_StorageAllocationSettingData.HostResourceBlockSize")
The maximum amount of blocks that will be granted for the storage resource allocation on the host. The block size is specified by the HostResourceBlockSize property.
MappingBehavior
-
Data type: uint16
-
Access type: Read-only
Indicates how the resource maps to underlying resources.
This property is inherited from CIM_ResourceAllocationSettingData.
Unknown (0)
Not Supported (2)
Dedicated (3)
Soft Affinity (4)
Hard Affinity (5)
DMTF Reserved
Vendor Reserved
OtherHostExtentNameFormat
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageAllocationSettingData.HostExtentNameFormat")
The format of the HostExtentName property if the property is set to "1" (other).
OtherHostExtentNameNamespace
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageAllocationSettingData.HostExtentNameNamespace")
A string that describes the namespace of the HostExtentName property if the value of the HostExtentNameNamespace property is "1" (other).
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).
This property is inherited from CIM_ResourceAllocationSettingData.
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.
PoolID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.PoolId")
The ID of the resource pool that generated the resource.
This property is inherited from CIM_ResourceAllocationSettingData.
Reservation
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Override ("Reservation"), ModelCorrespondence ("CIM_StorageAllocationSettingData.HostResourceBlockSize")
The amount of blocks that are guaranteed to be available for the storage resource allocation on the host. The block size is specified by the HostResourceBlockSize property.
ResourceSubType
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ResourceType")
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.
ResourceType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.OtherResourceType", "CIM_ResourceAllocationSettingData.ResourceSubType")
The type of resource that is represented by the allocation settings.
This property is inherited from CIM_ResourceAllocationSettingData.
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)
Logical Disk (31)
Storage Volume (32)
Ethernet Connection (33)
DMTF reserved
Vendor Reserved
VirtualQuantity
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Override ("VirtualQuantity"), ModelCorrespondence ("CIM_StorageExtent.NumberOfBlocks", "CIM_StorageAllocationSettingData.VirtualQuantityUnits")
The number of blocks that the storage allocation presents to the consumer.
Note
The VirtualQuantity property can specify a block size of "1", even if VirtualResourceBlockSize is unknown.
VirtualQuantityUnits
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Override ("VirtualQuantityUnits"), ModelCorrespondence ("CIM_StorageAllocationSettingData.VirtualQuantity"), IsPUnit
The units used by the VirtualQuantity property. This value shall should be set to "count(fixed size block)" or "byte". The default value, "count(fixed size block)" should be used for a fixed block size, and "byte" should be used for an unknown or variable block size.
VirtualResourceBlockSize
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageExtent.BlockSize"), PUnit ("byte")
The size, in bytes, of the blocks that form the storage allocation request. If the block size is variable, then the maximum block size should be specified. If the block size is unknown or if a block concept does not apply, then the block size should be "1" (unknown).
Weight
-
Data type: uint32
-
Access type: Read-only
The relative priority for this allocation in relation to other allocations from the same resource pool.
This property is inherited from CIM_ResourceAllocationSettingData.
Requirements
Minimum supported client |
None supported |
Minimum supported server |
Windows Server 2016 |
Namespace |
Root\HyperVCluster\v2 |
MOF |
|
DLL |
|