Documentation

PLEASE NOTE: This document applies to latest version and not to the latest stable release v2.21

Documentation for other releases can be found by using the version selector in the top right of any doc page.

luks

Manage LUKS (Linux Unified Key Setup) encrypted volumes.

Attributes

check_mode:
  support: full

Parameters

Parameter	Required	Type	Values	Description
device	true	string		Device path to manage (e.g., /dev/sdb1).
passphrase		string		Encryption passphrase. Required when state=present without keyfile, or state=opened without keyfile.
keyfile		string		Path to keyfile for authentication. Alternative to passphrase.
state		string	present absent opened closed	Desired state of the LUKS container. [default: `"present"`]
cipher		string		Encryption cipher algorithm. [default: `"aes-xts-plain64"`]
key_size		integer		Key size in bits. [default: `512`]
name		string		Mapper name for opened LUKS container. Required when state=opened or state=closed.
luks_type		string		LUKS type (luks1 or luks2). [default: `"luks2"`]

Examples

- name: Create LUKS container on device
  luks:
    device: /dev/sdb1
    passphrase: supersecret
    state: present

- name: Create LUKS container with keyfile
  luks:
    device: /dev/sdb1
    keyfile: /root/luks-key
    state: present

- name: Create LUKS container with custom cipher and key size
  luks:
    device: /dev/sdb1
    passphrase: supersecret
    cipher: aes-xts-plain64
    key_size: 512
    state: present

- name: Open LUKS container
  luks:
    device: /dev/sdb1
    passphrase: supersecret
    name: cryptdata
    state: opened

- name: Close LUKS container
  luks:
    device: /dev/sdb1
    name: cryptdata
    state: closed

- name: Remove LUKS header (destroy container)
  luks:
    device: /dev/sdb1
    state: absent