Class CIM_GroupMaskingMappingService
extends CIM_ControllerConfigurationService

Methods to work with masking groups.

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_ControllerConfigurationService
   |
   +--CIM_GroupMaskingMappingService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringMethods to work with masking groups.
Experimentalbooleantrue
UMLPackagePathstringCIM::Device::ComponentElement
Versionstring2.23.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
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

CreateGroup (uint32)

Method Qualifiers (CreateGroup)

NameData TypeValue
DescriptionstringThis method creates a masking group.
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (CreateGroup)

NameTypeQualifiers
NameData TypeValue
ConsistentLogicalUnitNumberboolean
DescriptionstringA volume may be visible to the same initiator through multiple paths. Depending on which path the volume is visible to an initiator, the volume may have a different logical unit number. To ensure a volume has the same logical unit number to a given initiator regardless of the path, the property InitiatorMaskingGroup.ConsistentLogicalUnitNumber shall be set to true. The value of this parameter, if not NULL, is used to set the property InitiatorMaskingGroup.ConsistentLogicalUnitNumber when the initiator masking group is created. Use the intrinsic method ModifyInstance to change the value of the property InitiatorMaskingGroup.ConsistentLogicalUnitNumber after the masking group is created.
INbooleantrue
DeleteOnEmptyboolean
DescriptionstringIf true and empty groups are allowed, the group will be deleted when the last element is removed from the group. If empty groups are not allowed, the group will be deleted automatically when the group becomes empty. If this parameter is not NULL, its value will be used to set the group's DeleteOnEmpty property. Use the intrinsic method ModifyInstance to change this property after the group is created.
INbooleantrue
DeleteWhenBecomesUnassociatedboolean
DescriptionstringIf true, the group will be deleted when the group is no longer associated with a masking view. This can happen when the masking view is deleted or the group is removed from the masking view. If this parameter is not NULL, its value will be used to set the group's DeleteWhenBecomesUnassociated property. Use the intrinsic method ModifyInstance to change this property after the group is created.
INbooleantrue
GroupNamestring
DescriptionstringIf nameable, an end user relevant name for the group being created. If NULL or not nameable, then system assigns a name.
INbooleantrue
Typeuint16
DescriptionstringThe type of masking group to create.
INbooleantrue
ValueMapstring0, 1, 2, 3, 4
ValuesstringUnknown, Other, InitiatorMaskingGroup, TargetMaskingGroup, DeviceMaskingGroup
MembersCIM_ManagedElement[]
DescriptionstringList of elements to add to the masking group. For device masking groups the order is maintained. If NULL, the group will be empty -- if empty groups are supported.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
MaskingGroup REF CIM_MaskingGroup
DescriptionstringReference to the created group.
INbooleanfalse
OUTbooleantrue

DeleteGroup (uint32)

Method Qualifiers (DeleteGroup)

NameData TypeValue
DescriptionstringDelete a masking group. Deleting a masking group does not delete its constituents.
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (DeleteGroup)

NameTypeQualifiers
NameData TypeValue
Forceboolean
DescriptionstringAttempt to delete the masking group even though it is associated to a masking view, or the group is not empty. The intent of the Force parameter is to reduce the chance of accidental deletion of a masking group.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
MaskingGroup REF CIM_MaskingGroup
DescriptionstringReference to a masking group.
INbooleantrue
Requiredbooleantrue

AddMembers (uint32)

Method Qualifiers (AddMembers)

NameData TypeValue
DescriptionstringAdd members to an existing masking group.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Vendor Specific

Method Parameters (AddMembers)

NameTypeQualifiers
NameData TypeValue
DeviceNumbersstring[]
DescriptionstringList of device numbers that correspond to Members. This property is applicable when the group consists of storage volumes.
INbooleantrue
ModelCorrespondencestringMembers
MembersCIM_ManagedElement[]
DescriptionstringList of elements to add to the group. New members are added, in the order supplied, to the end of the existing members of the group. It is not an error, if a new member is already in the group.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
MaskingGroup REF CIM_MaskingGroup
DescriptionstringReference to an existing masking group.
INbooleantrue
Requiredbooleantrue

RemoveMembers (uint32)

Method Qualifiers (RemoveMembers)

NameData TypeValue
DescriptionstringRemove members from a masking group.
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (RemoveMembers)

NameTypeQualifiers
NameData TypeValue
DeleteOnEmptyboolean
DescriptionstringIf true and removal of the members causes the group to become empty, the group will be deleted. Note, if empty groups are not allowed, the group will be deleted automatically when the group becomes empty. If this parameter is not NULL, it overrides the group's property DeleteOnEmpty.
INbooleantrue
MembersCIM_ManagedElement[]
DescriptionstringList of elements to remove from a group. Deleting all members of a group is equivalent to deleting the group if empty groups are not supported by the implementation.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
MaskingGroup REF CIM_MaskingGroup
DescriptionstringReference to an existing masking group.
INbooleantrue
Requiredbooleantrue

CreateMaskingView (uint32)

Method Qualifiers (CreateMaskingView)

NameData TypeValue
DescriptionstringExpose a group of SCSI logical units (such as RAID volumes or tape drives) to a group of initiators through a group of target ports, through one or more SCSIProtocolControllers (SPCs). If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateMaskingView)

NameTypeQualifiers
NameData TypeValue
ElementNamestring
DescriptionstringA user relevant name for the masking view. If NULL, the implementation assigns a name.
INbooleantrue
DeviceNumbersstring[]
DescriptionstringList of device numbers that correspond to the elements of DeviceMaskingGroup. If this parameter is NULL, device numbers are assigned by the instrumentation.
INbooleantrue
ModelCorrespondencestringDeviceMaskingGroup
DeviceMaskingGroup REF CIM_MaskingGroup
DescriptionstringReference to a group of devices.
INbooleantrue
InitiatorMaskingGroup REF CIM_MaskingGroup
DescriptionstringReference to a group of initiators.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
ProtocolController REF CIM_SCSIProtocolController
DescriptionstringA reference to the created SCSIProtocolController, which represents the masking view.
INbooleanfalse
OUTbooleantrue
TargetMaskingGroup REF CIM_MaskingGroup
DescriptionstringReference to a group of target ports.
INbooleantrue

DeleteMaskingView (uint32)

Method Qualifiers (DeleteMaskingView)

NameData TypeValue
DescriptionstringDelete a masking view, i.e. a SCSIProtocolControllers. Deleting a masking view may also delete the associated masking groups -- see the applicable capabilities and group properties. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (DeleteMaskingView)

NameTypeQualifiers
NameData TypeValue
DeleteWhenBecomesUnassociatedboolean
DescriptionstringOverride the setting of the groups' property DeleteWhenBecomesUnassociated with the value of this parameter.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
ProtocolController REF CIM_SCSIProtocolController
DescriptionstringA reference to the SCSIProtocolController to delete. The masking group associated with the view may also get deleted depending on the groups' applicable properties.
INbooleantrue
Requiredbooleantrue

ModifyMaskingView (uint32)

Method Qualifiers (ModifyMaskingView)

NameData TypeValue
DescriptionstringModify a masking view by adding a masking group or by removing a masking group from the masking view. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 0x1000 is returned, a ConcreteJob was started and a reference to this Job is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyMaskingView)

NameTypeQualifiers
NameData TypeValue
Forceboolean
DescriptionstringIf true, the client is not warned that the operation may render the masking view unusable.
INbooleantrue
Operationuint16
DescriptionstringOperation describes the type of modification to be made to the masking view.
INbooleantrue
Requiredbooleantrue
ValueMapstring2, 3, .., 32768..65535
ValuesstringAdd Group, Remove Group, DMTF Reserved, Vendor Specific
DeviceNumbersstring[]
DescriptionstringThis parameter applies to an "add group" operation. It is a list of device numbers that correspond to the elements of a MaskingGroup.
INbooleantrue
ModelCorrespondencestringMaskingGroup
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be NULL if job is completed).
INbooleanfalse
OUTbooleantrue
MaskingGroup REF CIM_MaskingGroup
DescriptionstringA reference to the masking group to add or to remove.
INbooleantrue
ProtocolController REF CIM_SCSIProtocolController
DescriptionstringThe reference to the masking view to modify.
INbooleantrue
Requiredbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
AttachDeviceuint32CIM_ControllerConfigurationService
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
CreateProtocolControllerWithPortsuint32CIM_ControllerConfigurationService
DeleteProtocolControlleruint32CIM_ControllerConfigurationService
DetachDeviceuint32CIM_ControllerConfigurationService
ExposeDefaultLUsuint32CIM_ControllerConfigurationService
ExposePathsuint32CIM_ControllerConfigurationService
ExposePathsWithNameAndHostTypeuint32CIM_ControllerConfigurationService
HideDefaultLUsuint32CIM_ControllerConfigurationService
HidePathsuint32CIM_ControllerConfigurationService
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service