MaskingMapping
Class IBMTSDS_ControllerConfigurationService


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Service
        \_CIM_ControllerConfigurationService


Description

The ControllerConfigurationService provides methods that allow a client to manipulate LUN Masking in a storage system.

Subclasses


Referenced By

IBMTSDS_ConcreteDependencyController IBMTSDS_HostedControllerConfigurationService

Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
CreationClassName indicates the name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
Name string
Max Length256
The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object.
SystemCreationClassName string
Max Length256
The CreationClassName of the scoping System.
SystemName string
Max Length256
The Name of the scoping System.
Read Only
Read Write
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 
Inherited from class CIM_EnabledLogicalElement
EnabledState, OtherEnabledState, RequestedState, TimeOfLastStateChange, EnabledDefault
 
Inherited from class CIM_Service
Started, StartMode, PrimaryOwnerContact, PrimaryOwnerName
 

Method Summary

NameDescription
ExposePathsExposePaths performs the mapping and makingoperation in a single method call.
HidePathsHidePaths is the inverse of ExposePaths.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Service
StartService, StopService
 
Inherited from class CIM_ControllerConfigurationService
AttachDevice, CreateProtocolControllerWithPorts, DeleteProtocolController, DetachDevice, ExposeDefaultLUs, ExposePaths, HideDefaultLUs, HidePaths
 

Method Detail


ExposePaths

Description

ExposePaths performs the mapping and makingoperation in a single method call. It exposes a list ofSCSI logical units to a list of initiators through a listof target ports, through one or more SCSIProtocolControllers(SPCs). If you use exposepaths to expose both volumes andFCPorts in a single operation, the volumes and the FCportsare mapped in separate operations. The Volume mapping is donefirst and the FCPort mapping is done second. If the FCPortmapping fails the volume mapping operation is not rolled back.When this happens a new SCSIProtocolController with volumesand no FCPorts will be created.

Parameters

IdTypeRangeDescription
In
Job CIM_ConcreteJob
Reference to the job. This may be null ifno job is started. This property is not supported.
LUNames string
an array of IDs of logical unit instances. The LU instancesneed to already exist. The members of this array shall matchthe Name property of LogicalDevice instances that representSCSI logical units.
InitiatorPortIDs string
IDs of initiator ports. If existing StorageHardwareID instancesexist, they shall be used. If no StorageHardwareID instance matches, then one is implicitly created. If a StorageHardwareID is created as a side effect, the default operating system is AIX. If you need to define a different operating system for the StorageHardwareID, you must use CreateStorageHardwareID.For DS, you can specify this parameter with the form'<IBMTSDS_StorageHardwareID.StorageID>-<id>'because DS supports two logical host ports with the same WWPN. If you use form'IBMTSDS_StorageHardwareID.StorageID'and there exist more than one StorageHardwareID with this StorageID, the first StorageHardwareID will be chosen.
TargetPortIDs string
IDs of target ports.
DeviceNumbers string
A list of logical unit numbers to assign to the correspondinglogical unit in the LUNames parameter. IF the LUNames parameteris null, then this parameter shall be null. Otherwise, if thisparameter is null, all LU members are assigned by the hardware.This shall be formatted as unseparated uppercase hexadecimal digits,with no leading"Ox". This is not supported
DeviceAccesses uint16
A list of permissions to assign to the corresponding logical unitin the LUNames parameter. This specifies the permission to assignwithin the context of the elements specified in the other parameters.Setting this to"No Access"assigns the DeviceNumber for the associated initiators, but does not grant read or write access. If the LUNames parameter shall be specified. All access is given by default
ProtocolControllers CIM_SCSIProtocolController
An array of references to SCSIProtocolControllers (SPCs). On input,this can be null, or contain exactly one element; if null on input,the instrumentation will create one or more new SPC instances. On output, this will be either null (if a job was created) or the set of SPCs affected (those created or modified). If a job was started,references to the SPCs affected will be found by following the AffectedJobElement association from the job.
out
Job CIM_ConcreteJob
Reference to the job. This may be null ifno job is started. This property is not supported.
ProtocolControllers CIM_SCSIProtocolController
An array of references to SCSIProtocolControllers (SPCs). On input,this can be null, or contain exactly one element; if null on input,the instrumentation will create one or more new SPC instances. On output, this will be either null (if a job was created) or the set of SPCs affected (those created or modified). If a job was started,references to the SPCs affected will be found by following the AffectedJobElement association from the job.
Return Codes
none

HidePaths

Description

HidePaths is the inverse of ExposePaths. It hides a list ofSCSI logical units (such as RAID volumes) from a list ofinitiators through a list of target ports, through one ormore SCSIProtocolControllers (SPCs). The instrumentationshall support three use cases which are: Remove LUs from aview, Remove initiator IDs from a view, and Remove targetport IDs from a view. Remove LUs from a view requires thatthe LUNames parameter not be null and that the InitiatorIDsand TargetPortIDs parameters be null.

Parameters

IdTypeRangeDescription
In
Job CIM_ConcreteJob
Reference to the job (may be null if no job started) This is not supported
LUNames string
An array of IDs of logical unit instances to hide. The LU instances need toalready exist.
InitiatorPortIDs string
If this is non-null, it must match the DeviceID of the SCSIProtocolController. Since SCSIProtocolControllers cannot exist without a StorageHardwareID associated to it, specifying an InitiatorPortID will delete the ProtocolController and remove all all assocations with Volumes and SCSIProtocolEndpoints
TargetPortIDs string
IDs of target ports to hide.
ProtocolControllers CIM_SCSIProtocolController
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, InitiatorPortIDs, or TargetPortIDs) from this SPC. On output, this is an array of references to SPCs created or modified as the result of processing the request.
out
Job CIM_ConcreteJob
Reference to the job (may be null if no job started) This is not supported
ProtocolControllers CIM_SCSIProtocolController
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, InitiatorPortIDs, or TargetPortIDs) from this SPC. On output, this is an array of references to SPCs created or modified as the result of processing the request.
Return Codes
none