ansible.windows.win_user – Управление локальными учетными записями пользователей Windows
Примечание
Этот плагин входит в состав коллекции ansible.windows (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install ansible.windows.
Для использования в плейбуке укажите: ansible.windows.win_user.
Описание
- Управляет локальными учетными записями пользователей Windows.
- Для целей, не являющихся Windows, используйте модуль ansible.builtin.user вместо этого.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account_disabled boolean |
| yes отключит учетную запись пользователя.no сбросит флаг отключения. |
| account_locked boolean |
| Только no может быть установлено, и оно разблокирует учетную запись пользователя, если она заблокирована. |
| description строка | Описание пользователя. | |
| fullname строка | Полное имя пользователя. | |
| groups список / элементы=строка | Добавляет или удаляет пользователя из этого списка групп, разделённых запятыми, в зависимости от значения groups_action. Когда groups_action — replace, а groups — пустая строка ('groups='), пользователь удаляется из всех групп. | |
| groups_action строка |
| Если add, пользователь добавляется в каждую группу в groups, если он в ней ещё не состоит.Если replace, пользователь добавляется как член каждой группы в groups и удаляется из всех других групп.Если remove, пользователь удаляется из каждой группы в groups. |
| home_directory строка добавлен в 1.0.0 ansible.windows | Указанный домашний каталог пользователя. | |
| login_script строка добавлен в 1.0.0 ansible.windows | Скрипт входа пользователя. | |
| name строка / обязательно | Имя пользователя для создания, удаления или изменения. | |
| password строка | Необязательно установить пароль пользователя на это (символьное) значение. | |
| password_expired boolean |
| yes потребует от пользователя сменить пароль при следующей попытке входа.no сбросит флаг истечения срока действия пароля. |
| password_never_expires boolean |
| yes установит пароль, который никогда не будет истекать.no позволит паролю истечь. |
| profile строка добавлен в 1.0.0 ansible.windows | Путь к профилю пользователя. | |
| state строка |
| При absent, удаляет учетную запись пользователя, если она существует.При present, создаёт или обновляет учетную запись пользователя.При query, извлекает данные учетной записи пользователя без внесения изменений. |
| update_password строка |
| always обновит пароли, если они отличаются.on_create установит пароль только для вновь созданных пользователей. |
| user_cannot_change_password boolean |
| yes запретит пользователю менять свой пароль.no позволит пользователю менять свой пароль. |
Примечания
Примечание
- Возвращаемые значения основаны на объекте пользователя после установки параметров модуля. При выполнении в режиме проверки значения всё равно будут отражать существующие настройки пользователя, а не то, на что они были изменены.
См. также
См. также
- ansible.builtin.user
-
Официальная документация модуля ansible.builtin.user.
- ansible.windows.win_domain_membership
-
Официальная документация модуля ansible.windows.win_domain_membership.
- community.windows.win_domain_user
-
Официальная документация модуля community.windows.win_domain_user.
- ansible.windows.win_group
-
Официальная документация модуля ansible.windows.win_group.
- ansible.windows.win_group_membership
-
Официальная документация модуля ansible.windows.win_group_membership.
- community.windows.win_user_profile
-
Официальная документация модуля community.windows.win_user_profile.
Примеры
- name: Ensure user bob is present
ansible.windows.win_user:
name: bob
password: B0bP4ssw0rd
state: present
groups:
- Users
- name: Ensure user bob is absent
ansible.windows.win_user:
name: bob
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account_disabled boolean | пользователь существует | Отключена ли учетная запись пользователя. |
| account_locked boolean | пользователь существует | Заблокирована ли учетная запись пользователя. |
| description строка | пользователь существует | Описание, заданное для пользователя. Пример: Имя пользователя для теста |
| fullname строка | пользователь существует | Полное имя, заданное для пользователя. Пример: Тестовый имя пользователя |
| groups список / элементы=строка | пользователь существует | Список групп и их путей ADSI, членами которых является пользователь. Пример: [{'name': 'Администраторы', 'path': 'WinNT://WORKGROUP/USER-PC/Администраторы'}] |
| name строка | всегда | Имя пользователя. Пример: имя_пользователя |
| password_expired boolean | пользователь существует | Истек срок действия пароля. |
| password_never_expires boolean | пользователь существует | Пароль настроен на постоянное действие. Пример: True |
| path строка | пользователь существует | Путь ADSI для пользователя. Пример: WinNT://WORKGROUP/USER-PC/имя_пользователя |
| sid строка | пользователь существует | SID для пользователя. Пример: S-1-5-21-3322259488-2828151810-3939402796-1001 |
| user_cannot_change_password boolean | пользователь существует | Может ли пользователь изменить свой пароль. |
Авторы
- Paul Durivage (@angstwad)
- Chris Church (@cchurch)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/windows/win_user_module.html
