MaskingMapping
Class IBMTSSVC_ControllerConfigurationService


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Service
        \_CIM_ControllerConfigurationService


Description

This service provides extrinsics create, delete and modify IBMTSSVC_Controllers.

Subclasses


Referenced By

IBMTSSVC_ConfigurationServiceForController IBMTSSVC_ControllerConfigurationServiceForSystem IBMTSSVC_ControllerConfigurationServiceMaskingCapabilities

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
The Name property uniquely identifies the Service and provides an indication of the function that is managed. This function 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
Description string
The Description property provides a textual description of the object.
EnabledDefault uint16
Enabled2
Disabled3
Not Applicable5
Enabled but Offline6
No Default7
DMTF Reserved8..32767
Vendor Reserved32768..65535
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is"Enabled"(value=2).
EnabledState uint16
Unknown0
Other1
Enabled2
Disabled3
Shutting Down4
Not Applicable5
Enabled but Offline6
In Test7
Deferred8
Quiesce9
Starting10
DMTF Reserved11..32767
Vendor Reserved32768..65535
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:Enabled (2) indicates that the element is or could be running commands, will process any queued commands, and queues new requests.Disabled (3) indicates that the element will not run commands and will drop any new requests.Shutting Down (4) indicates that the element is in the process of going to a Disabled state.Not Applicable (5) indicates the element does not support being enabled or disabled.Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.Test (7) indicates that the element is in a test state.Deferred (8) indicates that the element might be completing commands, but will queue any new requests.Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued.Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
OperationalStatus uint16
Unknown0
Other1
OK2
Degraded3
Stressed4
Predictive Failure5
Error6
Non-Recoverable Error7
Starting8
Stopping9
Stopped10
In Service11
No Contact12
Lost Communication13
Aborted14
Dormant15
Supporting Entity in Error16
Completed17
Power Mode18
DMTF Reserved..
Vendor Reserved0x8000..
Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail."Stressed"indicates that the element is functioning, but needs attention. Examples of"Stressed"states are overload, overheated, and so on."Predictive Failure"indicates that an element is functioning nominally but predicting a failure in the near future."In Service"describes an element being configured, maintained, cleaned, or otherwise administered."No Contact"indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it."Lost Communication"indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable."Stopped"and"Aborted"are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated."Dormant"indicates that the element is inactive or quiesced."Supporting Entity in Error"indicates that this element might be"OK"but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems."Completed"indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error)."Power Mode"indicates that the element has additional power model information contained in the Associated PowerManagementService association.OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.
OtherEnabledState string
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.
RequestedState uint16
Enabled2
Disabled3
Shut Down4
No Change5
Offline6
Test7
Deferred8
Quiesce9
Reboot10
Reset11
Not Applicable12
DMTF Reserved..
Vendor Reserved32768..65535
RequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. When EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are"Reboot"(10) and"Reset"(11). Reboot refers to doing a"Shut Down"and then moving to an"Enabled"state. Reset indicates that the element is first"Disabled"and then"Enabled". The distinction between requesting"Shut Down"and"Disabled"should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not run or accept any commands or processing requests.This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, becauseit allows an explicit invocation of the operation and the return of a result code.A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.
Started boolean
Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).
StatusDescriptions string
Strings describing the various OperationalStatus array values. For example, if"Stopping"is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Entries in this array are correlated with those at the same array index in OperationalStatus.
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
AttachDeviceThis methodassociates a LogicalDevice subclass (specifically a StorageVolume or MediaAccessDevice subclass) to the referenced ProtocolController.
CreateProtocolControllerWithPortsThis method creates an appropriate subclass of ProtocolController.
DeleteProtocolControllerThe method deletes an instance of ProtocolController and all associations in which this ProtocolController is referenced.
DetachDeviceThis method removes the ProtocolControllerForDevice association subclass between the ProtocolController and a LogicalDevice, such as a StorageVolume or a MediaAccessDevice.
ExposeDefaultLUsExpose a list of SCSI logical units (such as RAID volumes or tape drives) through a'default view'SCSIProtocolController (SPC) through a list of target ports.
ExposePathsExpose a list of SCSI logical units (such as RAID volumes or tape drives) to a list of initiators through a list of target ports, through one or more SCSIProtocolControllers (SPCs).
HideDefaultLUsHide 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).
HidePathsHide a list of SCSI logical units (such as a RAID volume or tape drive) from a list of initiators and/or target ports on a SCSIProtocolController (SPC).
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Service
StartService, StopService
 
Inherited from class CIM_ControllerConfigurationService
AttachDevice, CreateProtocolControllerWithPorts, DeleteProtocolController, DetachDevice, ExposePaths, HidePaths
 

Method Detail


AttachDevice

Description

This methodassociates a LogicalDevice subclass (specifically a StorageVolume or MediaAccessDevice subclass) to the referenced ProtocolController. The association is persisted as an instance of ProtocolControllerForUnit. The management instrumentation provider must verify that the logical unit numbers (defined using the DeviceNumber input parameter) are unique for the ProtocolController. When the Protocol Controller is actively masking a device (for example, is part of an AuthorizedTarget association), the provider should update the access configuration in the underlying hardware as appropriate.

Parameters

IdTypeRangeDescription
In
Force boolean
To set/unset Force flag. Default Force=True.
ProtocolController IBMTSSVC_ProtocolController
The ProtocolController instance.
Device CIM_LogicalDevice
The LogicalDevice instance to attach.
DeviceNumber string
The number assigned to ProtocolControllerForUnit.DeviceNumber (if supported by the hardware). Hardware support is indicated by ProtocolControllerMaskingCapabilities.ClientSelectableDeviceNumbers). If the hardware does not support setting the number, but the DeviceNumber has not been established in an existing ProtocolControllerForDevice subclass, then this parameter's value will be used. If the DeviceNumber has been established, then the current number will be reused.
out
DeviceNumber string
The number assigned to ProtocolControllerForUnit.DeviceNumber (if supported by the hardware). Hardware support is indicated by ProtocolControllerMaskingCapabilities.ClientSelectableDeviceNumbers). If the hardware does not support setting the number, but the DeviceNumber has not been established in an existing ProtocolControllerForDevice subclass, then this parameter's value will be used. If the DeviceNumber has been established, then the current number will be reused.
Return Codes
none

CreateProtocolControllerWithPorts

Description

This method creates an appropriate subclass of ProtocolController. In addition to its role of controlling downstream devices, a ProtocolControl is used to provide a central management point for access control with respect to those devices. Certain storage system implementations across multiple vendors require permissions to be established atomically with the creation of a ProtocolController. This method provides this capability via the Privilege and Identity properties. By supplying appropriate information in those properties, this method will assure that appropriate AuthorizedTarget and AuthorizedSubject associations, (as defined in the User and Security Model), are instantiated to restrict access to the logical devices'behind'it.If multiple target ports are specified in the Ports input parameter, all expose the same view (for example, have the same unit numbers and permissions). This method does not create the port instances, but does create ProtocolControllerForPort associations between the specified ports and the new ProtocolController. The new ProtocolController is defined to be weak to the same System as the ControllerConfigurationService.

Parameters

IdTypeRangeDescription
In
ElementName string
The string to be used in the ElementName of the new ProtocolController.
Ports string
Array of strings containing representations of references to instances of CIM_LogicalPort (or subclass) instances. This is the list of target ports that are associated to the ProtocolController. ProtocolControllerForPort associations are created by the instrumentation associating the new ProtocolController to these ports. If this parameter is null, then all ports in the storage system (this Service's'scoping'System and all its ComponentCS Systems) are attached to the new ProtocolController.
Protocol uint16
The protocol type for the new ProtocolController.
Privilege IBMTSSVC_AuthorizedPrivilege
Reference to a CIM_Privilege (or subclass) instance to be used as a template. If supplied, it has a 1:1 correspondence with the Identity parameter and this method will atomically create the new ProtocolController instance and related AuthorizedPrivilege, AuthorizedTarget and AuthorizedSubject instances.Note: if ProtocolControllerRequiresAuthorizedIdentity is true, then the Identity/Privilege pair must be specified. If false, then the Identity/Privilege pair must not be specified.
Identity CIM_ManagedElement
Reference to a CIM_ManagedElement (or subclass) instance. This ManagedElement must be either a CIM_Identity, or a CIM_Collection (or subclass, eg. SystemSpecificCollection, Role, or Group) that has CIM_Identities as MemberOfCollection. If ProtocolControllerMaskingCapabilities.ProtocolControllerSupportsCollection is false, the reference must be to a CIM_Identity (or subclass). If present, it has a 1:1 correspondence with the Privilege property. If present, this method will atomically create the new ProtocolController instance and instantiate a missing AuthorizedSubject association between the Privilege/Identity pair; and instantiate an AuthorizedTarget association between the AuthorizedPrivilege and the new ProtocolController.Note: if ProtocolControllerRequiresAuthorizedIdentity is true, then at least the Identity/Privilege pair must be specified.
ProtocolController IBMTSSVC_ProtocolController
A reference to the new ProtocolController that is created.
out
ProtocolController IBMTSSVC_ProtocolController
A reference to the new ProtocolController that is created.
Return Codes
none

DeleteProtocolController

Description

The method deletes an instance of ProtocolController and all associations in which this ProtocolController is referenced.

Parameters

IdTypeRangeDescription
In
ProtocolController IBMTSSVC_ProtocolController
The ProtocolController to be deleted.
DeleteChildrenProtocolControllers boolean
If true, the management instrumentation provider will also delete'child'ProtocolControllers (for example, those defined as Dependent references in instances of AssociatedProtocolController where this ProtocolController is the Antecedent reference). Also, all direct associations involving the'child'ProtocolControllers will be removed.
DeleteUnits boolean
If true, the management instrumentation provider will also delete LogicalDevice instances associated via ProtocolControllerForUnit, to this ProtocolController and its children. ('child'controllers will only be affected if the DeleteChildrenProtocolControllers input parameter is TRUE). LogicalDevice instances are only deleted if there are NO remaining ProtocolControllerForUnit associations, to other ProtocolControllers.
out
none
Return Codes
none

DetachDevice

Description

This method removes the ProtocolControllerForDevice association subclass between the ProtocolController and a LogicalDevice, such as a StorageVolume or a MediaAccessDevice. When the ProtocolController is actively masking a device (for example, is part of an AuthorizedTarget association, the management instrumentation provider should update the hardware access configuration when DetachDevice is called.

Parameters

IdTypeRangeDescription
In
ProtocolController IBMTSSVC_ProtocolController
The ProtocolController instance.
Device CIM_LogicalDevice
The LogicalDevice instance to detach.
out
none
Return Codes
none

ExposeDefaultLUs

Description

Expose a list of SCSI logical units (such as RAID volumes or tape drives) through a'default view'SCSIProtocolController (SPC) through a list of target ports. The'default view'SPC exposes logical units to all initiators. This SPC is identified by an association to a StorageHardwareID with Name property set to the empty string.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. DeviceNumbers - the device numbers (LUNs) to use. DeviceAccesses - permissions for the logical units. ProtocolControllers - SPCs involved in this operation.There are two modes of operation, create and modify. If a NULL value is passed in for the SPC, then the instrumentation will attempt to create a new default view. If PortsPerView is'All Ports share the same view', then there is at most one default view SPC. If PortsPerView is not'All Ports share the same view', then there MAY be multiple default view SPCs as long as different ports are associated with each. If an SPC is passed in, then the instrumentation adds the new paths to the existing SPC. The instrumentation MAY return an error if honoring this request would violate SCSI semantics.For creating a default view SPC, the parameters that must be specified are dependent upon the SPCAllows* properties in CIM_ProtocolControllerMaskingCapabilities. If SPCAllowsNoLUs is false, the caller must specify a list of LUNames. If it is true, the caller MAY specify a list of LUNames or MAY pass in null. If SPCAllowsNoTargets is false, the caller must specify a list of TargetPortIDs. If it is true, the caller MAY specify a list of TargetPortIDs or MAY pass in null. If LUNames is not null, the caller must specify DeviceAccesses for each logical unit. If the instrumentation's CIM_ProtocolControllerMaskingCapabilities ClientSelectableDeviceNumbers property is TRUE then the client MAY provide a list of device numbers (LUNs) to use for the paths to be created. If is false, the client must pass in NULL for this parameter.The LUNames, DeviceNumbers, and DeviceAccesses parameters are mutually indexed arrays - any element in DeviceNumbers or DeviceAccesses will set a property relative to the LogicalDevice instance named in the corresponding element of LUNames. LUNames and DeviceAccesses must have the same number of elements. DeviceNumbers must be null (asking the instrumentation to assign numbers) or have the same number of elements as LUNames. If these conditions are not met, the instrumentation must return a'Invalid Parameter'status or a CIM_Error.For modifying an SPC, there are two specific use cases identified. The instrumentation must support one and the other is required depending on a how a property is set. Other permutations are allowed, butare vendor-specific. The required use case is - Add LUs to a default view. Add LUs to a default view requires that the LUNames parameter not be null and that the TargetPortIDs parameters be null. DeviceNumbers MAY be null if ClientSelectableDeviceNumbers is false. DeviceAccess must be specified. Add target port IDs to a default view is only valid if PortsPerView is set to'Multiple Ports per View'. It requires that the LUNames, DeviceNumbers, and DeviceAccesses must also be nullThe relevant rules of SCSI semantics are:- an SPC MAY not be exposed through a particular host/target port pair that is in use by another SPC. (In other words, an SPC and its associated logical units and ports together correspond to the logical unit inventory provided by SCSI REPORT LUNS and INQUIRY commands)- each LogicalDevice associated to an SPC must have a unique ProtocolControllerForUnit DeviceNumber (logical unit number)The instrumentation must report an error if the client request would violate one of these rules.If the instrumentation provides PrivilegeManagementService, the results of setting DeviceAccesses must be synchronized with PrivilegeManagementService as described in the ProtocolControllerForUnit DeviceAccess description.

Parameters

IdTypeRangeDescription
In
Job CIM_ConcreteJob
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed).
LUNames string
An array of IDs of logical unit instances. The LU instances must already exist. The members of this array must match the Name property of LogicalDevice instances that represent SCSI logical units. See the method description for conditions where this MAY be null.
TargetPortIDs string
IDs of target ports. See the method description for conditions where this MAY be null.
DeviceNumbers string
A list of logical unit numbers to assign to the corresponding logical unit in the LUNames parameter. (within the context of the elements specified in the other parameters). If the LUNames parameter is null, then this parameter must be null. Otherwise, if this parameter is null, all LU numbers are assigned by the hardware or instrumentation.
DeviceAccesses uint16
A list of permissions to assign to the corresponding logical unit in the LUNames parameter. This specifies the permission to assign within the context of the elements specified in the other parameters. Setting this to'No Access'assigns the DeviceNumber for all initiators, but does not grant read or write access. If the LUNames parameter is not null then this parameter must be specified.
ProtocolControllers CIM_SCSIProtocolController
An array of references to SCSIProtocolControllers (SPCs). On input, this can be null, or contain exactly one element; there MAY be multiple references on output. If null on input, the instrumentation will create one or more new SPC instances. If an SPC is specified, the instrumentation will attempt to add associations to one or more existing SPCs. If the first array element is a valid SPC reference and SCSI semantics can be preserved, the instrumentation must attach associations to the specified SPC. If multiple elements are non-null on input, the instrumentation must report an invalid parameter. 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 if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed).
ProtocolControllers CIM_SCSIProtocolController
An array of references to SCSIProtocolControllers (SPCs). On input, this can be null, or contain exactly one element; there MAY be multiple references on output. If null on input, the instrumentation will create one or more new SPC instances. If an SPC is specified, the instrumentation will attempt to add associations to one or more existing SPCs. If the first array element is a valid SPC reference and SCSI semantics can be preserved, the instrumentation must attach associations to the specified SPC. If multiple elements are non-null on input, the instrumentation must report an invalid parameter. On output, this is an array of references to SPCs created or modified as the result of processing the request.
Return Codes
none

ExposePaths

Description

Expose a list of SCSI logical units (such as RAID volumes or tape drives) to a list of initiators through a list of target ports, through one or more SCSIProtocolControllers (SPCs). 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. InitiatorPortIDs - the names of the initiator ports to use. TargetPortIDs - the names of the target ports to use. DeviceNumbers - the device numbers (LUNs) to use. DeviceAccesses - permissions for the logical units. ProtocolControllers - SPCs involved in this operation. There are two modes of operation, create and modify. If a NULL value is passed in for the SPC, then the instrumentation will create at least one SPC that satisfies the request using the given WWPN's as Initiator Ports, or if the StorageID of existing StorageHardwareID's is passed in, the command is treated as an operation on the multiple SPC's associated with those StorageHardwareID's (see the vendor extended use cases). Depending upon the instrumentation capabilities, more than one SPC MAY be created. (For example if ProtocolControllerMaskingCapabilities.OneHardwareIDPerView is true and more than one initiatorID was passed in, then one SPC per initiatorID will be created). If an SPC is passed in, then the instrumentation attempts to add the new paths to the existing SPC. Depending upon the instrumentation capabilities, this MAY result in the creation of additional SPCs. The instrumentation MAY return an error if honoring this request would violate SCSI semantics. For creating an SPC, the parameters that must be specified are dependent upon the SPCAllows* properties in CIM_ProtocolControllerMaskingCapabilities. If SPCAllowsNoLUs is false, the caller must specify a list of LUNames or MAY pass in null. This device does not support modifying individual Target ports. Please use the StorageHardwareID.PortMask. If SPCAllowsNoInitiators is false, the caller must specify a list of InitiatorPortIDs. If it is true, the caller MAY specify a list of InitiatorPortIDs or MAY pass in null. If LUNames is not null, the caller must specify DeviceAccesses for each logical unit. If the instrumentation's CIM_ProtocolControllerMaskingCapabilities ClientSelectableDeviceNumbers property is TRUE then the client MAY provide a list of device numbers (LUNs) to use for the paths to be created. If is false, the client must pass in NULL for this parameter. The LUNames, DeviceNumbers, and DeviceAccesses parameters are mutually indexed arrays - any element in DeviceNumbers or DeviceAccesses will set a property relative to the LogicalDevice instance named in the corresponding element of LUNames. LUNames and DeviceAccesses must have the same number of elements. DeviceNumbers must be null (asking the instrumentation to assign numbers) or have the same number of elements as LUNames. If these conditions are not met, the instrumentation must return a'Invalid Parameter'status or a CIM_Error. For modifying an SPC, there are three specific use cases identified. The instrumentation must support these use cases. Other permutations are allowed, but are vendor-specific. The use cases are: Add LUs to a view, Add initiator IDs to a view, and Add target port IDs to a view (not supported). Add LUs to a view requires that the LUNames parameter not be null and that the InitiatorIDs be null. DeviceNumbers MAY be null if ClientSelectableDeviceNumbers is false. DeviceAccesses must be specified. Add initiator IDs to a view requires that the LUNames parameter be null, that the InitiatorIDs not be null. DeviceNumbers and DeviceAccesses must be null. The relevant rules of SCSI semantics are: an SPC MAY not be exposed through a particular host/target port pair that is in use by another SPC. (In other words, an SPC and its associated logical units and ports together correspond to the logical unit inventory provided by SCSI REPORT LUNS and INQUIRY commands); and each LogicalDevice associated to an SPC must have a unique ProtocolControllerForUnit DeviceNumber (logical unit number) The instrumentation must report an error if the client request would violate one of these rules. If the instrumentation provides PrivilegeManagementService, the results of setting DeviceAccesses must be synchronized with PrivilegeManagementService as described in the ProtocolControllerForUnit DeviceAccess description. The vendor extended use cases for expose paths are adding LUs to multiple views. LUNNames (and corresponding Device* values) are mandatory, as are the list of StorageHardwareID.StorageIDs that correspond to existing StorageHardwareIDs(ClusterID:HostID).

Parameters

IdTypeRangeDescription
In
Force boolean
To set/unset Force flag. Default Force=False.
Job CIM_ConcreteJob
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed).
LUNames string
An array of IDs of logical unit instances. The LU instances must already exist. The members of this array must match the Name property of LogicalDevice instances that represent SCSI logical units. See the method description for conditions where this MAY be null.
InitiatorPortIDs string
IDs of initiator ports. If existing StorageHardwareID instances exist, they must be used. If no StorageHardwareID instance matches, then one is implicitly created. See the method description for conditions where this MAY be null. If this is an array of WWPNs, then a new StorageHardwareID will be created, but the StorageHardwareID.StorageID will not map to the passed in value.
TargetPortIDs string
IDs of target ports. SVC does not support this method of modifying target ports. This parameter will be ignored.Use the StorageHardwareID.PortMask set property instead.
DeviceNumbers string
A list of logical unit numbers to assign to the corresponding logical unit in the LUNames parameter. (within the context of the elements specified in the other parameters). If the LUNames parameter is null, then this parameter must be null. Otherwise, if this parameter is null, all LU numbers are assigned by the hardware or instrumentation.
DeviceAccesses uint16
A list of permissions to assign to the corresponding logical unit in the LUNames parameter. This specifies the permission to assign within 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 is not null then this parameter must be specified. SVC does not support multiple levels of access. A HostMap has either full access or no access, therefore, the only valid value is
ProtocolControllers IBMTSSVC_ProtocolController
An array of references to SCSIProtocolControllers (SPCs). On input, this can be null, or contain exactly one element; there MAY be multiple references on output. If nullon input, the instrumentation will create one or more new SPC instances. If an SPC is specified, the instrumentation will attempt to add associations to one or more existing SPCs. If the first array element is a valid SPC reference and SCSI semantics can be preserved, the instrumentation must attach associations to the specified SPC. If multiple elements are non-null on input, the instrumentation must report an invalid parameter. 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 if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed).
ProtocolControllers IBMTSSVC_ProtocolController
An array of references to SCSIProtocolControllers (SPCs). On input, this can be null, or contain exactly one element; there MAY be multiple references on output. If nullon input, the instrumentation will create one or more new SPC instances. If an SPC is specified, the instrumentation will attempt to add associations to one or more existing SPCs. If the first array element is a valid SPC reference and SCSI semantics can be preserved, the instrumentation must attach associations to the specified SPC. If multiple elements are non-null on input, the instrumentation must report an invalid parameter. On output, this is an array of references to SPCs created or modified as the result of processing the request.
Return Codes
none

HideDefaultLUs

Description

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 M_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. Unsupported.

Parameters

IdTypeRangeDescription
In
Job CIM_ConcreteJob
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed).
LUNames string
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 string
IDs of target ports. See the method description for conditions where this MAY be null.
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 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.
out
Job CIM_ConcreteJob
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed).
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 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 Codes
none

HidePaths

Description

Hide a list of SCSI logical units (such as a RAID volume or tape drive) from a list of initiators and/or target ports on a 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. InitiatorPortIDs - the names of the initiator ports to use. TargetPortIDs - the names of the target ports to use. ProtocolControllers - SPCs involved in this operation. When hiding logical units, there are three specific use cases identified. The instrumentation must support these use cases. Other permutations are allowed, but are vendor-specific. The use cases are: Remove LUsfrom a view, Remove initiator IDs from a view, and Remove target port IDs from a view(unsupported). Remove LUs from a view requires that the LUNames paramter not be null and that the InitiatorIDs paramter be null. Remove the initiator IDs from a view requires that the LUNames parameter be null and that the InitiatorIDs not null. This device does not support removing target ports via this mehtod. Use the StorageHardwareID.PortMask. The disposition of the SPC when the last logical unit, initiator ID, 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 SPCAllowsNoInitiators is false, then the SPC is automatically deleted when the last initiator port ID is removed. In all other cases, the SPC must be explicitly deleted via the DeleteInstance intrinsic function. A Vendor Extended use case allows for the Removal of LUs from multiple views, the LUNames are mandatory as well as the list of StorageHardwareID.StorageID's (format ClusterID:HostID)associated to existing ProtocolControllers, the SPC must be NULL.

Parameters

IdTypeRangeDescription
In
Force boolean
To set/unset Force flag. Default Force=False.
Job CIM_ConcreteJob
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed).
LUNames string
A list of IDs of logical units. Each LU instance must already exist. See the method description for conditions where this MAY be null.
InitiatorPortIDs string
IDs of initiator ports. See the method description for conditions where this MAY be null.A list of WWPNs to remove from the view (they must be members of the host, see the StorageHardwareID.Description or the PortWWNs for values). If the Hide full paths from view parameter set are used, then a StorageHardwareID.StorageID shall be used and the result will delete the StorageHardwareID instance.
TargetPortIDs string
IDs of target ports. SVC does not support this method of modifying target ports. This parameter will be ignored.Use the StorageHardwareID.PortMask set property instead.
ProtocolControllers IBMTSSVC_ProtocolController
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. 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.
out
Job CIM_ConcreteJob
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed).
ProtocolControllers IBMTSSVC_ProtocolController
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. 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 Codes
none