Skip to content

user

A local user account.

step "example" {
user {
name = "..."
}
}
Name Type Required Description
group string No Primary group.
groups set of string No Supplementary groups: the complete list.
home string No Home directory. Created with the user.
name string Yes Login name.
on_remove string No “forget” (default) leaves the account, “delete” removes it and keeps its home directory.
shell string No Login shell.
system bool No Create as a system account.
uid number No User ID.

A step lowers to the conn3x_user resource, one instance per host, and connects with its circuit’s ssh block.