DeviceConfiguration
Class IBMTSSVC_DeviceConfigurationService


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Service


Description

This service allows the active management of the devices that a CIM Agent is configured to.

Subclasses


Referenced By

IBMTSSVC_ConcreteDependencyDeviceConfiguration IBMTSSVC_DeviceConfigurationServiceAvailableToProfile IBMTSSVC_HostedDeviceConfigurationService

Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
The scoping System's CreationClassName. Each StorageManagementSystem has one DeviceConfigurationService. Set to IBMTSSVC_StorageManagementService.
Name string
The Name property is used to uniquely identify a CIM Server. The CIM Server must ensure that this value is globally unique. In order to ensure uniqueness, this value will be of the form"IBMTSSVC:<IP Address of CIMOM>".
SystemCreationClassName string
Max Length256
The CreationClassName of the scoping System.
SystemName string
Max Length256
The Name of the scoping System.
Read Only
ElementName string
Will be of the form"DeviceConfigurationService for StorageManagementSystem at<StorageManagementSystem.Name>".
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
AddDeviceAdds a storage device to the CIM Agent device configuration.
RefreshConnectionAttempts to connect to the device described by the DeviceConfiguration.
RemoveDeviceRemoves a storage device from the CIM Agent device configuration.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Service
StartService, StopService
 

Method Detail


AddDevice

Description

Adds a storage device to the CIM Agent device configuration. When errors occur with the connection to the device, the device is still added to the configuration of the CIM Agent. If the configuration needs to be changed for any reason, it should be removed and then re-added. This method attempts to prevent adding a Storage Device that has already been configured.ADDING DUPLICATE STORAGE DEVICES IS NOT SUPPORTED AND CAN CAUSE MANAGEMENT ERRORS.

Parameters

IdTypeRangeDescription
In
DeviceConfig IBMTSSVC_DeviceConfiguration
If the method is successul, this parameter will contain a reference to the newly created DeviceConfiguration. If the requested Storage Device appears to already be in the CIM Agent's device configuration, then the method will return Duplicate Device Not Added and this parameterwill contain a reference to the existing Storage Device that is already configured.
DeviceType uint16
DeviceType specifies the type of Device being added. Currently only 2145 is supported.
IPAddress2 string
The secondary IP (service) address of the Storage Device to be added. This is optional.
Password string
The Password of the Storage Device to be added.
UserName string
The User Name of the Storage Device to be added.
Force boolean
If this flag is true, this method will attempt to add the Storage Device even if appears to be already configured in the CIM Agent. USE EXTREME CAUTION WITH THIS FLAG. ADDING A STORAGE DEVICE MORE THAN ONCE IS NOT SUPPORTED AND CAN CAUSE MANAGEMENT ERRORS. ONLY FORCE ADDITION IF YOU ARE ABSOLUTELY POSITIVE THAT THIS DEVICE IS NOT ALREADY CONFIGURED.
IPAddress string
The IP address of the Storage Device to be added.
out
DeviceConfig IBMTSSVC_DeviceConfiguration
If the method is successul, this parameter will contain a reference to the newly created DeviceConfiguration. If the requested Storage Device appears to already be in the CIM Agent's device configuration, then the method will return Duplicate Device Not Added and this parameterwill contain a reference to the existing Storage Device that is already configured.
Return Codes
none

RefreshConnection

Description

Attempts to connect to the device described by the DeviceConfiguration. If a connection already exists, it will be tested to make sure it is still active.

Parameters

IdTypeRangeDescription
In
DeviceConfig IBMTSSVC_DeviceConfiguration
out
none
Return Codes
none

RemoveDevice

Description

Removes a storage device from the CIM Agent device configuration.

Parameters

IdTypeRangeDescription
In
DeviceConfig IBMTSSVC_DeviceConfiguration
Device to be removed.
out
none
Return Codes
none