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 string | Описание пользователя. | |
| fullname string | Полное имя пользователя. | |
| groups list / elements=string | Добавляет или удаляет пользователя из этого списка групп, разделенных запятыми, в зависимости от значения groups_action. Когда groups_action равно replace, а groups установлено на пустую строку ('groups='), пользователь удаляется из всех групп. | |
| groups_action string |
| Если add, пользователь добавляется в каждую группу в groups, где он еще не является участником.Если replace, пользователь добавляется как член каждой группы в groups и удаляется из любых других групп.Если remove, пользователь удаляется из каждой группы в groups. |
| home_directory string добавлено в 1.0.0 ansible.windows | Указанный домашний каталог пользователя. | |
| login_script string добавлено в 1.0.0 ansible.windows | Сценарий входа пользователя. | |
| name string / обязательно | Имя пользователя для создания, удаления или изменения. | |
| password string | Необязательно задайте пароль пользователя этому (текстовому) значению. | |
| password_expired boolean |
| yes потребует от пользователя смены пароля при следующем входе.no очистит флаг истечения срока действия пароля. |
| password_never_expires boolean |
| yes установит пароль так, чтобы он никогда не истекал.no позволит паролю истечь. |
| profile string добавлено в 1.0.0 ansible.windows | Путь профиля пользователя. | |
| state string |
| При значении absent, удаляет учетную запись пользователя, если она существует.При значении present, создает или обновляет учетную запись пользователя.При значении query, извлекает данные учетной записи пользователя без внесения изменений. |
| update_password string |
| 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 | user exists | Отключена ли учетная запись пользователя. |
| account_locked boolean | user exists | Заблокирована ли учетная запись пользователя. |
| description string | user exists | Описание, заданное для пользователя. Пример: Имя пользователя для теста |
| fullname string | user exists | Полное имя, заданное для пользователя. Пример: Имя пользователя для теста |
| groups list / elements=string | user exists | Список групп и их пути ADSI, членом которых является пользователь. Пример: [{'name': 'Administrators', 'path': 'WinNT://WORKGROUP/USER-PC/Administrators'}] |
| name string | always | Имя пользователя Пример: имя_пользователя |
| password_expired boolean | user exists | Истек ли срок действия пароля. |
| password_never_expires boolean | user exists | Установлено ли, что пароль никогда не истекает. Пример: True |
| path string | user exists | Путь ADSI для пользователя. Пример: WinNT://WORKGROUP/USER-PC/имя_пользователя |
| sid string | user exists | SID для пользователя. Пример: S-1-5-21-3322259488-2828151810-3939402796-1001 |
| user_cannot_change_password boolean | user exists | Может ли пользователь изменить свой пароль. |
Авторы
- Paul Durivage (@angstwad)
- Chris Church (@cchurch)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/windows/win_user_module.html
