Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

user_create

Create a user.

⚙️ Compatible targets: Linux

⚠️ Deprecated: This method is deprecated and should not be used.

Parameters

NameDocumentation
loginUser login.

This parameter is required.
descriptionUser description.

This parameter is required.
homeUser's home directory.

This parameter is required.
groupUser's primary group.

This parameter is required.
shellUser's shell.

This parameter is required.
lockedIs the user locked ? true or false.

This parameter is required.

Outcome conditions

You need to replace ${login} with its actual canonified value.

  • ✅ Ok: user_create_${login}_ok
    • ☑️ Already compliant: user_create_${login}_kept
    • 🟨 Repaired: user_create_${login}_repaired
  • ❌ Error: user_create_${login}_error

Example

method: user_create
params:
  shell: VALUE
  locked: VALUE
  login: VALUE
  description: VALUE
  home: VALUE
  group: VALUE

Documentation

This method does not create the user's home directory.