Class IBMTSDS_EncryptionGroupService


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Service


Description

The IBMTSDS_EncryptionGroupService provides methods that allow a client to configure Encryption Group in a storage system.

Subclasses


Referenced By

IBMTSDS_HostedEncryptionGroupService

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
CreateEncryptionGroupThis method will create Encryption Group on the storage system.
GetMaximumEncryptionGroupNumberThis method will return the maximum number of encryption group that the SFI can suppport.
RemoveEncryptionGroupThis method will remove Encryption Group on the storage system.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Service
StartService, StopService
 

Method Detail


CreateEncryptionGroup

Description

This method will create Encryption Group on the storage system

Parameters

IdTypeRangeDescription
In
KeyLabel string
The KeyLabel of the encryption group. The administrator should get this information from EKM server configuration.
EncryptionGroupID uint16
The ID used to create the encryption group. If not specifying this, the encryption group ID will be chosen automatically.The encryption group ID must be less or equal to the maximum number of encryption group that the SFI can support. User can get that maximum number by calling the method getMaximumEncryptionGroupNumber.
EncryptionGroup IBMTSDS_EncryptionGroup
The reference of the encryption group that has been created.
out
EncryptionGroup IBMTSDS_EncryptionGroup
The reference of the encryption group that has been created.
Return Codes
none

GetMaximumEncryptionGroupNumber

Description

This method will return the maximum number of encryption group that the SFI can suppport.

Parameters

IdTypeRangeDescription
In
maximumEncryptionGroupNumber uint16
The maximum number of encryption group supported.
out
maximumEncryptionGroupNumber uint16
The maximum number of encryption group supported.
Return Codes
none

RemoveEncryptionGroup

Description

This method will remove Encryption Group on the storage system. The input encryption group must exist in the storage system.

Parameters

IdTypeRangeDescription
In
EncryptionGroup IBMTSDS_EncryptionGroup
The reference of the Encryption Group that is to be removed.
out
none
Return Codes
none