cephx_key – Generate a random CephX authentication key

Synopsis

Generate a random CephX authentication key and return it.

Supports AES-128 (default, type=1, 16-byte key) and AES-256k (type=2, 32-byte key) ciphers.

Parameters

cipher (optional, str, aes)

The cipher to use when generating the CephX key.

Use aes for AES-128 (16-byte key, 40-char base64, type=1). This is the default.

Use aes256k for AES-256k (32-byte key, 60-char base64, type=2).

Examples

- name: Generate a cephx key (AES-128, backward compatible default)
  cifmw.general.cephx_key:
  register: cephx

- name: Generate a cephx key with explicit AES-128 cipher
  cifmw.general.cephx_key:
    cipher: aes
  register: cephx

- name: Generate a cephx key with AES-256k cipher
  cifmw.general.cephx_key:
    cipher: aes256k
  register: cephx

- name: Show cephx key
  debug:
    msg: "{{ cephx.key }}"

Return Values

key (success, str, [‘AQC+vYNXgDAgAhAAc8UoYt+OTz5uhV7ItLdwUw==’])

A random CephX authentication key encoded as base64.

AES-128 keys are 40 characters long (ending with ==).

AES-256k keys are 60 characters long (ending with =).

Status

Authors

  • John Fulton (@fultonj)