Skip to content

User

The builtin.user resource allow to manage everything related to a user, from the shell that it should have, to the creation and deletion of the user, and groups membership.

Parameters

NameDescriptionRequiredDefault
usernameName of the user to managetrue
groupsList of groups the user should be a member of. None of those group will get created, make sure to create them using the builtin.group.false
manage_homeWhether or not to manage the home directory of the user. The home of the user will never gets deleted using this value, only created if it doesn't existfalsetrue
shellShell that the user should get assignedfalse/bin/bash

Examples

Create a user named jeff

yaml
- title: "Create user jeff"
  type: "builtin.user"
  parameters:
    username: "jeff"

Delete user named jeff

yaml
- title: "Delete user jeff"
  type: "builtin.user"
  present: false
  parameters:
    username: "jeff"