luks_format


Description:

[ Version ( since = "1.5.2" ) ]
public bool luks_format (string device, string key, int32 keyslot) throws Error

format a block device as a LUKS encrypted device

This command erases existing data on device and formats the device as a LUKS encrypted device. key is the initial key, which is added to key slot slot. (LUKS supports 8 key slots, numbered 0-7).

This function depends on the feature "luks". See also feature_available.

Parameters:

this

A GuestfsSession object

Returns:

true on success, false on error