EncryptedVolume
A LUKS2-encrypted volume configuration.
| Characteristic | Value |
|---|---|
| Type | object |
Properties
deviceId (required)
The ID of the disk partition or software RAID array to encrypt.
This parameter is required. It must be unique among the list of encrypted volumes.
If it refers to a disk partition, it must be of a supported type. Supported types are all but the following blocked partition types:
-
esp -
root -
root-verity -
usr-verity -
home
If it refers to a software RAID array, the first disk partition of the software RAID array must be of a supported type.
| Characteristic | Value |
|---|---|
| Type | string |
| Format | Block Device ID |
deviceName (required)
The name of the device to create under /dev/mapper when opening the volume.
This parameter is required. It must be a valid file name and unique among all encrypted volumes, as well as among the Device Mapper devices.
| Characteristic | Value |
|---|---|
| Type | string |
id (required)
The ID of the LUKS-encrypted volume to create.
This parameter is required. It must be non-empty and unique among the IDs of all block devices in the Host Configuration. This includes the IDs of all disk partitions, encrypted volumes, software RAID arrays, and A/B volume pairs.
| Characteristic | Value |
|---|---|
| Type | string |
| Format | Block Device ID |