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

NameData TypeValue
DescriptionstringStorageHardwareIDManagementService provides methods for manipulating instances of StorageHardwareIDs and manipulating the trust of these IDs in the underlying storage system.
UMLPackagePathstringCIM::User::StorageHardwareID
Versionstring2.35.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateStorageHardwareID (uint32)

Method Qualifiers (CreateStorageHardwareID)

NameData TypeValue
DescriptionstringThis method creates a CIM_StorageHardwareID, it creates the association CIM_ConcreteDependency between this service and the new CIM_StorageHardwareID.
ValueMapstring0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001, 0x1003..0x7FFF, 0x8000..
ValuesstringSuccess, 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)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringThe ElementName of the new StorageHardwareID instance.
INbooleantrue
IDTypeuint16
DescriptionstringThe 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.
INbooleantrue
ModelCorrespondencestringCIM_StorageHardwareID.IDType
ValueMapstring1, 2, 3, 4, 5, 7
ValuesstringOther, PortWWN, NodeWWN, Hostname, iSCSI Name, SAS Address
OtherIDTypestring
DescriptionstringThe type of the storage ID, when IDType is "Other".
INbooleantrue
StorageIDstring
DescriptionstringStorageID is the value used by the SecurityService to represent Identity - in this case, a hardware worldwide unique name.
INbooleantrue
HardwareID REF CIM_StorageHardwareID
DescriptionstringREF to the new StorageHardwareID instance.
INbooleanfalse
OUTbooleantrue
Setting REF CIM_StorageClientSettingData
DescriptionstringREF 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.
INbooleantrue

DeleteStorageHardwareID (uint32)

Method Qualifiers (DeleteStorageHardwareID)

NameData TypeValue
DescriptionstringThis method deletes a named CIM_StorageHardwareID, and also tears down the associations that are no longer needed, including CIM_ConcreteDependency and CIM_AuthorizedSubject.
ValueMapstring0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001..0x7FFF, 0x8000..
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Specified instance not found, Method Reserved, Vendor Specific

Method Parameters (DeleteStorageHardwareID)

NameTypeQualifiers
NameData TypeValue
HardwareID REF CIM_StorageHardwareID
DescriptionstringThe storage hardware ID to be deleted.
INbooleantrue

CreateGatewayPathID (uint32)

Method Qualifiers (CreateGatewayPathID)

NameData TypeValue
DescriptionstringThis method creates a CIM_GatewayPathID and the association CIM_ConcreteDependency between this service and the new GatewayPathID.
ValueMapstring0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001, 0x1003, 0x1004, 0x1005..0x7FFF, 0x8000..
ValuesstringSuccess, 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)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringThe ElementName of the new StorageHardwareID instance.
INbooleantrue
GatewayIDstring
DescriptionstringGatewayID is the value used by the SecurityService to represent identity of a Gateway element.
INbooleantrue
GatewayIDTypeuint16
DescriptionstringThe 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.
INbooleantrue
ValueMapstring1, 2, 3, 4, 5
ValuesstringOther, PortWWN, NodeWWN, Hostname, iSCSI Name
IDTypeuint16
DescriptionstringThe 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.
INbooleantrue
ModelCorrespondencestringCIM_StorageHardwareID.IDType
ValueMapstring1, 2, 3, 4, 5, 7
ValuesstringOther, PortWWN, NodeWWN, Hostname, iSCSI Name, SAS Address
OtherGatewayIDTypestring
DescriptionstringThe type of the storage ID, when GatewayIDType is "Other".
INbooleantrue
OtherIDTypestring
DescriptionstringThe type of the storage ID, when IDType is "Other".
INbooleantrue
StorageIDstring
DescriptionstringStorageID is the value used by the SecurityService to represent Identity - in this case, a hardware worldwide unique name.
INbooleantrue
NewGatewayPathID REF CIM_GatewayPathID
DescriptionstringREF to the new GatewayPathID instance.
INbooleanfalse
OUTbooleantrue

CreateHardwareIDCollection (uint32)

Method Qualifiers (CreateHardwareIDCollection)

NameData TypeValue
DescriptionstringCreate 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001, 0x1002, 0x1003..0x7FFF, 0x8000..
ValuesstringSuccess, 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)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringThe ElementName to be assigned to the created collection.
INbooleantrue
HardwareIDsstring[]
DescriptionstringArray of strings containing representations of references to StorageHardwareID instances that will become members of the new collection.
INbooleantrue
Collection REF CIM_SystemSpecificCollection
DescriptionstringThe new instance of SystemSpecificCollection that is created.
INbooleanfalse
OUTbooleantrue

AddHardwareIDsToCollection (uint32)

Method Qualifiers (AddHardwareIDsToCollection)

NameData TypeValue
DescriptionstringCreate 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6..0xFFF, 0x1000, 0x1001, 0x1002, 0x1003..0x7FFF, 0x8000..
ValuesstringSuccess, 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)

NameTypeQualifiers
NameData TypeValue
HardwareIDsstring[]
DescriptionstringArray of strings containing representations of references to StorageHardwareID instances that will become members of the collection.
INbooleantrue
Collection REF CIM_SystemSpecificCollection
DescriptionstringThe Collection which groups the StorageHardwareIDs.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service