mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-08 14:22:46 +00:00
DOCUMENTATION strings
This commit is contained in:
16
library/user
16
library/user
@@ -52,7 +52,7 @@ options:
|
||||
append:
|
||||
required: false
|
||||
description:
|
||||
- If I(yes), will only add groups, not set them to just the list
|
||||
- If C(yes), will only add groups, not set them to just the list
|
||||
in I(groups).
|
||||
shell:
|
||||
required: false
|
||||
@@ -73,36 +73,36 @@ options:
|
||||
default: "present"
|
||||
choices: [ present, absent ]
|
||||
description:
|
||||
- Whether the account should exist. When I(absent), removes
|
||||
- Whether the account should exist. When C(absent), removes
|
||||
the user account.
|
||||
createhome:
|
||||
required: false
|
||||
default: "yes"
|
||||
choices: [ yes, no ]
|
||||
description:
|
||||
- Unless set to I(no), a home directory will be made for the user
|
||||
- Unless set to C(no), a home directory will be made for the user
|
||||
when the account is created.
|
||||
system:
|
||||
required: false
|
||||
default: "no"
|
||||
choices: [ yes, no ]
|
||||
description:
|
||||
- When creating an account, setting this to I(yes) makes the user a
|
||||
- When creating an account, setting this to C(yes) makes the user a
|
||||
system account. This setting cannot be changed on existing users.
|
||||
force:
|
||||
required: false
|
||||
default: "no"
|
||||
choices: [ yes, no ]
|
||||
description:
|
||||
- When used with I(state=absent), behavior is as with
|
||||
I(userdel --force).
|
||||
- When used with C(state=absent), behavior is as with
|
||||
C(userdel --force).
|
||||
remove:
|
||||
required: false
|
||||
default: "no"
|
||||
choices: [ yes, no ]
|
||||
description:
|
||||
- When used with I(state=absent), behavior is as with
|
||||
I(userdel --remove).
|
||||
- When used with C(state=absent), behavior is as with
|
||||
C(userdel --remove).
|
||||
generate_ssh_key:
|
||||
required: false
|
||||
default: "no"
|
||||
|
||||
Reference in New Issue
Block a user