LMI_ExtentEncryptionConfigurationService¶
Class reference¶
Subclass of CIM_Service
Service which configures LUKS formats on block devices.
Key properties¶
Local properties¶
None
Local methods¶
uint32 CloseEncryptionFormat (CIM_ConcreteJob Job, LMI_EncryptionFormat Format)
Closes a LUKS device. Appropriate device mapper device with clear-text data is destroyed and appropriate LMI_LUKSStorageExtent is removed.
ValueMap Values 0 Job Completed with No Error 1 Not Supported 2 Unknown 3 Timeout 4 Failed 5 Invalid Parameter 6 In Use DMTF Reserved 4096 Method Parameters Checked - Job Started 4098..32767 Method Reserved 32768..65535 Vendor Specific Parameters
- OUT CIM_ConcreteJob Job
- Reference to the created job.
- IN LMI_EncryptionFormat Format
- LUKS format to close.
uint32 DeletePassphrase (LMI_EncryptionFormat Format, string Passphrase)
Remove a passphrase from LUKS format.
Parameters
- IN LMI_EncryptionFormat Format
- The format to remove the passphrase from.
- IN string Passphrase
- The passphrase to remove.
uint32 AddPassphrase (LMI_EncryptionFormat Format, string Passphrase, string NewPassphrase)
Add new passphrase to LUKS format. LUKS supports up to 8 independent passphrases, adding any additional one will result in error. Application cannot specify which key slot will be used by which passphrase.
Parameters
- IN LMI_EncryptionFormat Format
- The format to add the passphrase to.
- IN string Passphrase
- Any of the existing passphrase to unlock the format.
- IN string NewPassphrase
- New passphrase to add.
uint32 CreateEncryptionFormat (CIM_StorageExtent InExtent, LMI_EncryptionFormatSetting Goal, string Passphrase, CIM_ConcreteJob Job, LMI_EncryptionFormat Format)
Formats a device to become a LUKS device. All previous data on the device is destroyed.
ValueMap Values 0 Job Completed with No Error 1 Not Supported 2 Unknown 3 Timeout 4 Failed 5 Invalid Parameter 6 In Use DMTF Reserved 4096 Method Parameters Checked - Job Started 4098..32767 Method Reserved 32768..65535 Vendor Specific Parameters
- IN CIM_StorageExtent InExtent
- The block device to format.
- IN LMI_EncryptionFormatSetting Goal
- Parameteres of the LUKS format. This parameter is unused currently and must be NULL.
- IN string Passphrase
- Passphrase to use to encrypt the device. This is not the encryption key!
- OUT CIM_ConcreteJob Job
- Reference to the created job.
- OUT LMI_EncryptionFormat Format
- Created format.
uint32 OpenEncryptionFormat (LMI_EncryptionFormat Format, string ElementName, string Passphrase, CIM_ConcreteJob Job, CIM_StorageExtent Extent)
Opens a LUKS device. This means new block device with clear-text data is created. This new device is represented by LMI_LUKSStorageDevice and is returned as ‘Extent’ output parameter.
ValueMap Values 0 Job Completed with No Error 1 Not Supported 2 Unknown 3 Timeout 4 Failed 5 Invalid Parameter 6 In Use DMTF Reserved 4096 Method Parameters Checked - Job Started 4098..32767 Method Reserved 32768..65535 Vendor Specific Parameters
- IN LMI_EncryptionFormat Format
- Format to open.
- IN string ElementName
- Desired ElementName of the newly created LMI_LUKSStorageDevice. This name is also used as device mapper name, i.e. device with path /dev/mapper/<ElementName> will be created.
- IN string Passphrase
- Passphrase to unencrypt the device.
- OUT CIM_ConcreteJob Job
- Reference to the created job.
- OUT CIM_StorageExtent Extent
- Created CIM_StorageExtent which represents the clear-text block device.