# Class CIM_StorageHardwareIDManagementService
extends CIM_IdentityManagementService

StorageHardwareIDManagementService provides methods for manipulating instances of StorageHardwareIDs and manipulating the trust of these IDs in the underlying storage system.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_Service
|
+--CIM_SecurityService
|
+--CIM_AuthenticationService
|
+--CIM_IdentityManagementService
|
+--CIM_StorageHardwareIDManagementService

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | StorageHardwareIDManagementService provides methods for manipulating instances of StorageHardwareIDs and manipulating the trust of these IDs in the underlying storage system.
UMLPackagePath | string | CIM::User::StorageHardwareID
Version | string | 2.35.0

## Class Properties

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### CreateStorageHardwareID (uint32)

#### Method Qualifiers (CreateStorageHardwareID)

Name | Data Type | Value
--- | --- | ---
Description | string | This method creates a CIM_StorageHardwareID, it creates the association CIM_ConcreteDependency between this service and the new CIM_StorageHardwareID.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001, 0x1003..0x7FFF, 0x8000..
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, ID already created, Hardware implementation does not support specified IDType, Method Reserved, Vendor Specific

#### Method Parameters (CreateStorageHardwareID)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ElementName | string
Description | string | The ElementName of the new StorageHardwareID instance.
IN | boolean | true
IDType | uint16
Description | string | The type of the StorageID property. iSCSI IDs may use one of three iSCSI formats - iqn, eui, or naa. This three letter format is the name prefix; so a single iSCSI type is provided here, the prefix can be used to further refine the format.
IN | boolean | true
ModelCorrespondence | string | CIM_StorageHardwareID.IDType
ValueMap | string | 1, 2, 3, 4, 5, 7
Values | string | Other, PortWWN, NodeWWN, Hostname, iSCSI Name, SAS Address
OtherIDType | string
Description | string | The type of the storage ID, when IDType is "Other".
IN | boolean | true
StorageID | string
Description | string | StorageID is the value used by the SecurityService to represent Identity - in this case, a hardware worldwide unique name.
IN | boolean | true
HardwareID | REF CIM_StorageHardwareID
Description | string | REF to the new StorageHardwareID instance.
IN | boolean | false
OUT | boolean | true
Setting | REF CIM_StorageClientSettingData
Description | string | REF to the StorageClientSettingData containing the OSType appropriate for this initiator. If left NULL, the instrumentation assumes a standard OSType - i.e., that no OS-specific behavior for this initiator is defined.
IN | boolean | true

#### DeleteStorageHardwareID (uint32)

#### Method Qualifiers (DeleteStorageHardwareID)

Name | Data Type | Value
--- | --- | ---
Description | string | This method deletes a named CIM_StorageHardwareID, and also tears down the associations that are no longer needed, including CIM_ConcreteDependency and CIM_AuthorizedSubject.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001..0x7FFF, 0x8000..
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Specified instance not found, Method Reserved, Vendor Specific

#### Method Parameters (DeleteStorageHardwareID)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
HardwareID | REF CIM_StorageHardwareID
Description | string | The storage hardware ID to be deleted.
IN | boolean | true

#### CreateGatewayPathID (uint32)

#### Method Qualifiers (CreateGatewayPathID)

Name | Data Type | Value
--- | --- | ---
Description | string | This method creates a CIM_GatewayPathID and the association CIM_ConcreteDependency between this service and the new GatewayPathID.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001, 0x1003, 0x1004, 0x1005..0x7FFF, 0x8000..
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, ID already created, Hardware implementation does not support specified IDType, GatewayPathID already created, Hardware implementation does not support specified GatewayIDType, Method Reserved, Vendor Specific

#### Method Parameters (CreateGatewayPathID)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ElementName | string
Description | string | The ElementName of the new StorageHardwareID instance.
IN | boolean | true
GatewayID | string
Description | string | GatewayID is the value used by the SecurityService to represent identity of a Gateway element.
IN | boolean | true
GatewayIDType | uint16
Description | string | The type of the GatewayID property. iSCSI IDs may use one of three iSCSI formats - iqn, eui, or naa. This three letter format is the name prefix; so a single iSCSI type is provided here, the prefix can be used to further refine the format.
IN | boolean | true
ValueMap | string | 1, 2, 3, 4, 5
Values | string | Other, PortWWN, NodeWWN, Hostname, iSCSI Name
IDType | uint16
Description | string | The type of the StorageID property. iSCSI IDs may use one of three iSCSI formats - iqn, eui, or naa. This three letter format is the name prefix; so a single iSCSI type is provided here, the prefix can be used to further refine the format.
IN | boolean | true
ModelCorrespondence | string | CIM_StorageHardwareID.IDType
ValueMap | string | 1, 2, 3, 4, 5, 7
Values | string | Other, PortWWN, NodeWWN, Hostname, iSCSI Name, SAS Address
OtherGatewayIDType | string
Description | string | The type of the storage ID, when GatewayIDType is "Other".
IN | boolean | true
OtherIDType | string
Description | string | The type of the storage ID, when IDType is "Other".
IN | boolean | true
StorageID | string
Description | string | StorageID is the value used by the SecurityService to represent Identity - in this case, a hardware worldwide unique name.
IN | boolean | true
NewGatewayPathID | REF CIM_GatewayPathID
Description | string | REF to the new GatewayPathID instance.
IN | boolean | false
OUT | boolean | true

#### CreateHardwareIDCollection (uint32)

#### Method Qualifiers (CreateHardwareIDCollection)

Name | Data Type | Value
--- | --- | ---
Description | string | Create a group of StorageHardwareIDs as a new instance of SystemSpecificCollection. This is useful to define a set of authorized subjects that can access volumes in a disk array. This method allows the client to make a request of a specific Service instance to create the collection and provide the appropriate class name. When these capabilities are standardized in CIM/WBEM, this method can be deprecated and intrinsic methods used. In addition to creating the collection, this method causes the creation of the HostedCollection association (to this service's scoping system) and MemberOfCollection association to members of the IDs parameter.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001, 0x1002, 0x1003..0x7FFF, 0x8000..
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Invalid HardwareID instance, Implementation does not support hardware ID collections, Input hardware IDs cannot be used in same collection, Method Reserved, Vendor Specific

#### Method Parameters (CreateHardwareIDCollection)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
ElementName | string
Description | string | The ElementName to be assigned to the created collection.
IN | boolean | true
HardwareIDs | string[]
Description | string | Array of strings containing representations of references to StorageHardwareID instances that will become members of the new collection.
IN | boolean | true
Collection | REF CIM_SystemSpecificCollection
Description | string | The new instance of SystemSpecificCollection that is created.
IN | boolean | false
OUT | boolean | true

#### AddHardwareIDsToCollection (uint32)

#### Method Qualifiers (AddHardwareIDsToCollection)

Name | Data Type | Value
--- | --- | ---
Description | string | Create MemberOfCollection instances between the specified Collection and the StorageHardwareIDs. This method allows the client to make a request of a specific Service instance to create the associations. When these capabilities are standardized in CIM/WBEM, this method can be deprecated and intrinsic methods used.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001, 0x1002, 0x1003..0x7FFF, 0x8000..
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Invalid LogicalDevice instance, Implementation does not support device collections, Input devices cannot be used in this collection, Method Reserved, Vendor Specific

#### Method Parameters (AddHardwareIDsToCollection)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
HardwareIDs | string[]
Description | string | Array of strings containing representations of references to StorageHardwareID instances that will become members of the collection.
IN | boolean | true
Collection | REF CIM_SystemSpecificCollection
Description | string | The Collection which groups the StorageHardwareIDs.
IN | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service