VolumeGroup
Class IBMTSDS_VolumeGroupService


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Service


Description

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

Subclasses


Referenced By

IBMTSDS_HostedVolumeGroupService

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
AddVolumesToVolumeGroupAdd volumes to a volume group.
CreateVolumeGroupCreate a VolumeGroup.
DeleteVolumeGroupDelete a VolumeGroup.
ExposePathsWithVolumeGroupsThis method has the same behaviour as ExposePaths, but the signature accepts an instance of IBMTSDS_VolumeGroup instead of an array of LUNames.
HidePathsWithVolumeGroupsThis method has the same behaviour as HidePaths, but the signature accepts an instance of IBMTSDS_VolumeGroup instead of an array of LUNames.
RemoveVolumesFromVolumeGroupRemove volumes from volume group.
RemoveVolumesFromVolumeGroupExclusivelyRemove volumes from volume group.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Service
StartService, StopService
 

Method Detail


AddVolumesToVolumeGroup

Description

Add volumes to a volume group

Parameters

IdTypeRangeDescription
In
VolumeIDs CIM_StorageVolume
Reference of Volumes to put in the VolumeGroup.On output, the full list of Volumes in the VolumeGroup.
VolumeGroup IBMTSDS_VolumeGroup
The instance of VolumeGroup to add the volumes to.
out
VolumeIDs CIM_StorageVolume
Reference of Volumes to put in the VolumeGroup.On output, the full list of Volumes in the VolumeGroup.
Return Codes
none

CreateVolumeGroup

Description

Create a VolumeGroup

Parameters

IdTypeRangeDescription
In
ElementName string
The ElementName to be assigned to the created collection.
VolumeIDs IBMTSDS_Volume
Reference of Volumes to put in the VolumeGroup.
VolumeGroupType uint16
Describes the IBM-defined VolumeGroup Type.
HostType IBMTSDS_StorageClientSettingData
REF to the StorageClientSettingData containing the Operation System of the host that this VolumeGroup will be mapped to. This parameter is not necessary if the user passes in a value for VolumeGroupType. If the user passes in both VolumeGroupType and HostType and they are not compatible, an error will be returned.
out
VolumeGroup IBMTSDS_VolumeGroup
The new instance of VolumeGroup that is created.
Return Codes
none

DeleteVolumeGroup

Description

Delete a VolumeGroup

Parameters

IdTypeRangeDescription
In
VolumeGroup IBMTSDS_VolumeGroup
The VolumeGroup to be deleted.
out
none
Return Codes
none

ExposePathsWithVolumeGroups

Description

This method has the same behaviour as ExposePaths, but the signature accepts an instance of IBMTSDS_VolumeGroup instead of an array of LUNames. Clients should use either Expose/HidePaths or Expose/HidePathsWithVolumeGroups and not both, as it may result in unwanted side-effects.

Parameters

IdTypeRangeDescription
In
VolumeGroup IBMTSDS_VolumeGroup
The VolumeGroup to map to the SCSIProtocolController. A SCSIProtocolController can only have one VolumeGroup mapped to it.
InitiatorPortIDs string
IDs of initiator ports. If existing StorageHardwareID instancesexist, they shall be used. User can create SPC without assigning itto a SHWID. If assigning to an existing SHWID, make sure that SHWIDis not already associated with a Privilege or SPCFor 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. See the method description for conditions where this MAY be null.
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
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

HidePathsWithVolumeGroups

Description

This method has the same behaviour as HidePaths, but the signature accepts an instance of IBMTSDS_VolumeGroup instead of an array of LUNames. Clients should use either Expose/HidePaths or Expose/HidePathsWithVolumeGroups and not both, as it may result in unwanted side-effects.

Parameters

IdTypeRangeDescription
In
VolumeGroup IBMTSDS_VolumeGroup
The VolumeGroup to unmap from the SCSIProtocolController. A SCSIProtocolController can only have one VolumeGroup mapped to it.
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. 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, 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, thisis an array of references to SPCs created or modified as the result of processing the request.
out
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. Depending upon the specific implementation, the instrumentation MAY need to create new SPCs with a subset of the remaining associations. On output, thisis an array of references to SPCs created or modified as the result of processing the request.
Return Codes
none

RemoveVolumesFromVolumeGroup

Description

Remove volumes from volume group. Like HidePaths, returns success if client tries to remove a volume that does not previously exist in the volume group.

Parameters

IdTypeRangeDescription
In
VolumeIDs CIM_StorageVolume
Reference of Volumes to remove from the VolumeGroup.On output, the full list of Volumes in the VolumeGroup.
VolumeGroup IBMTSDS_VolumeGroup
The instance of VolumeGroup to remove the volumes from.
out
VolumeIDs CIM_StorageVolume
Reference of Volumes to remove from the VolumeGroup.On output, the full list of Volumes in the VolumeGroup.
Return Codes
none

RemoveVolumesFromVolumeGroupExclusively

Description

Remove volumes from volume group. This method is synchronized such that only one client can perform this operation at a time, and an error is returned if the volume being removed is not previously in the specified volume group

Parameters

IdTypeRangeDescription
In
VolumeIDs CIM_StorageVolume
Reference of Volumesto remove from the VolumeGroup.On output, when successful, the full list of Volumes in the VolumeGroup. When the return code is 0x940a (volume does not exist in the Volume Group) this output param will be the volumes that are not in the Volume Group. On any other error case, this output param will not be guaranteed.
VolumeGroup IBMTSDS_VolumeGroup
The instance of VolumeGroup to remove the volumes from.
out
VolumeIDs CIM_StorageVolume
Reference of Volumesto remove from the VolumeGroup.On output, when successful, the full list of Volumes in the VolumeGroup. When the return code is 0x940a (volume does not exist in the Volume Group) this output param will be the volumes that are not in the Volume Group. On any other error case, this output param will not be guaranteed.
Return Codes
none