HideDefaultLUs method of the CIM_ControllerConfigurationService class
Hide a list of SCSI logical units (such as RAID volumes or tape drives) through a list of target ports on a default view SCSIProtocolController (SPC).
The parameters for this method are: Job - null if no job created, otherwise this is a reference to the job. LUNames - the list of names of the logical units to use. TargetPortIDs - the names of the target ports to use. ProtocolControllers - SPCs involved in this operation.
When hiding logical units, there are two specific use cases identified. The instrumentation MUST support the Remove LUs case and MUST support the remove target port IDs if PortsPerView is set to 'Multiple Ports per View'. Other permutations are allowed, but are vendor-specific. The use cases are: Remove LUs from a default view and Remove target port IDs from a default view. Remove LUs from a default view requires that the LUNames parameter not be null and that the TargetPortIDs parameter be null. Remove target port IDs from a default view is required if PortsPerView is Multiple Ports per view. It requires that the LUNames parameter be null.
If both LUNames and TargetIDs parameters are non-null and CIM_ProtocolControllerMaskingCapabilities.MaximumMapCount is 0, then the instrumentation MUST create new SPCs and change associations as necessary to meet the client request and maintain the relevant rules of SCSI in the ExposeDefaultLUs description. If both LUNames and TargetIDs parameters are non-null and CIM_ProtocolControllerMaskingCapabilities.MaximumMapCount is greater than 0, then any client request that cannot be honored by changing associations to the specified SPC will receive a 'Maximum Map Count Error' response.
The disposition of the SPC when the last logical unit or target port ID is removed depends upon the CIM_ProtocolControllerMaskingCapabilites SPCAllowsNo* properties. If SPCAllowsNoLUs is false, then the SPC is automatically deleted when the last logical unit is removed. If SPCAllowsNoTargets is false, then the SPC is automatically deleted when the last target port ID is removed. In all other cases, the SPC MUST be explicitly deleted via the DeleteInstance intrinsic function.
Syntax
uint32 HideDefaultLUs(
[out] CIM_ConcreteJob REF Job,
[in] string LUNames[],
[in] string TargetPortIDs[],
[in, out] CIM_SCSIProtocolController REF ProtocolControllers[]
);
Parameters
-
Job [out]
-
Reference to the job if 'Method Parameters Checked - Job Started' is returned (MAY be null if job completed).
-
LUNames [in]
-
A list of IDs of logical units. Each LU instance MUST already exist. See the method description for conditions where this MAY be null.
-
TargetPortIDs [in]
-
IDs of target ports. See the method description for conditions where this MAY be null.
-
ProtocolControllers [in, out]
-
An array of references to SCSIProtocolControllers (SPCs). On input, this MUST contain exactly one element; there MAY be multiple references on output. The instrumentation will attempt to remove associations (LUNames or TargetPortIDs) from this SPC. Depending upon the specific implementation, the instrumentation MAY need to create new SPCs with a subset of the remaining associations. On output, this is an array of references to SPCs created or modified as the result of processing the request.
Return value
-
Success (0)
-
Not Supported (1)
-
Unspecified Error (2)
-
Timeout (3)
-
Failed (4)
-
Invalid Parameter (5)
-
DMTF Reserved (6 4095)
-
Method Parameters Checked - Job Started (4096)
-
Invalid logical unit ID (4097)
-
Invalid target port ID (4098)
-
Maximum Map Count Error (4099)
-
Method Reserved (4100 32767)
-
Vendor Specific (32768 65535)
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\CIMv2\Storage\iScsiTarget |
| MOF |
|
| DLL |
|