user.py (ansible-2.14.0) | : | user.py (ansible-2.14.1rc1) | ||
---|---|---|---|---|
skipping to change at line 34 | skipping to change at line 34 | |||
description: | description: | |||
- Optionally sets the I(UID) of the user. | - Optionally sets the I(UID) of the user. | |||
type: int | type: int | |||
comment: | comment: | |||
description: | description: | |||
- Optionally sets the description (aka I(GECOS)) of user account. | - Optionally sets the description (aka I(GECOS)) of user account. | |||
type: str | type: str | |||
hidden: | hidden: | |||
description: | description: | |||
- macOS only, optionally hide the user from the login window and sys tem preferences. | - macOS only, optionally hide the user from the login window and sys tem preferences. | |||
- The default will be C(yes) if the I(system) option is used. | - The default will be C(true) if the I(system) option is used. | |||
type: bool | type: bool | |||
version_added: "2.6" | version_added: "2.6" | |||
non_unique: | non_unique: | |||
description: | description: | |||
- Optionally when used with the -u option, this option allows to cha nge the user ID to a non-unique value. | - Optionally when used with the -u option, this option allows to cha nge the user ID to a non-unique value. | |||
type: bool | type: bool | |||
default: no | default: no | |||
version_added: "1.1" | version_added: "1.1" | |||
seuser: | seuser: | |||
description: | description: | |||
skipping to change at line 63 | skipping to change at line 63 | |||
description: | description: | |||
- List of groups user will be added to. | - List of groups user will be added to. | |||
- By default, the user is removed from all other groups. Configure C (append) to modify this. | - By default, the user is removed from all other groups. Configure C (append) to modify this. | |||
- When set to an empty string C(''), | - When set to an empty string C(''), | |||
the user is removed from all groups except the primary group. | the user is removed from all groups except the primary group. | |||
- Before Ansible 2.3, the only input format allowed was a comma sepa rated string. | - Before Ansible 2.3, the only input format allowed was a comma sepa rated string. | |||
type: list | type: list | |||
elements: str | elements: str | |||
append: | append: | |||
description: | description: | |||
- If C(yes), add the user to the groups specified in C(groups). | - If C(true), add the user to the groups specified in C(groups). | |||
- If C(no), user will only be added to the groups specified in C(gro | - If C(false), user will only be added to the groups specified in C( | |||
ups), | groups), | |||
removing them from all other groups. | removing them from all other groups. | |||
type: bool | type: bool | |||
default: no | default: no | |||
shell: | shell: | |||
description: | description: | |||
- Optionally set the user's shell. | - Optionally set the user's shell. | |||
- On macOS, before Ansible 2.5, the default shell for non-system use rs was C(/usr/bin/false). | - On macOS, before Ansible 2.5, the default shell for non-system use rs was C(/usr/bin/false). | |||
Since Ansible 2.5, the default shell for non-system users on macOS is C(/bin/bash). | Since Ansible 2.5, the default shell for non-system users on macOS is C(/bin/bash). | |||
- See notes for details on how other operating systems determine the default shell by | - See notes for details on how other operating systems determine the default shell by | |||
the underlying tool. | the underlying tool. | |||
skipping to change at line 103 | skipping to change at line 103 | |||
for details on various ways to generate these password values. | for details on various ways to generate these password values. | |||
type: str | type: str | |||
state: | state: | |||
description: | description: | |||
- Whether the account should exist or not, taking action if the stat e is different from what is stated. | - Whether the account should exist or not, taking action if the stat e is different from what is stated. | |||
type: str | type: str | |||
choices: [ absent, present ] | choices: [ absent, present ] | |||
default: present | default: present | |||
create_home: | create_home: | |||
description: | description: | |||
- Unless set to C(no), a home directory will be made for the user | - Unless set to C(false), a home directory will be made for the user | |||
when the account is created or if the home directory does not exis t. | when the account is created or if the home directory does not exis t. | |||
- Changed from C(createhome) to C(create_home) in Ansible 2.5. | - Changed from C(createhome) to C(create_home) in Ansible 2.5. | |||
type: bool | type: bool | |||
default: yes | default: yes | |||
aliases: [ createhome ] | aliases: [ createhome ] | |||
move_home: | move_home: | |||
description: | description: | |||
- "If set to C(yes) when used with C(home: ), attempt to move the us er's old home | - "If set to C(true) when used with C(home: ), attempt to move the u ser's old home | |||
directory to the specified directory if it isn't there already and the old home exists." | directory to the specified directory if it isn't there already and the old home exists." | |||
type: bool | type: bool | |||
default: no | default: no | |||
system: | system: | |||
description: | description: | |||
- When creating an account C(state=present), setting this to C(yes) makes the user a system account. | - When creating an account C(state=present), setting this to C(true) makes the user a system account. | |||
- This setting cannot be changed on existing users. | - This setting cannot be changed on existing users. | |||
type: bool | type: bool | |||
default: no | default: no | |||
force: | force: | |||
description: | description: | |||
- This only affects C(state=absent), it forces removal of the user a nd associated directories on supported platforms. | - This only affects C(state=absent), it forces removal of the user a nd associated directories on supported platforms. | |||
- The behavior is the same as C(userdel --force), check the man page for C(userdel) on your system for details and support. | - The behavior is the same as C(userdel --force), check the man page for C(userdel) on your system for details and support. | |||
- When used with C(generate_ssh_key=yes) this forces an existing key to be overwritten. | - When used with C(generate_ssh_key=yes) this forces an existing key to be overwritten. | |||
type: bool | type: bool | |||
default: no | default: no | |||
End of changes. 5 change blocks. | ||||
7 lines changed or deleted | 7 lines changed or added |