community.windows.win_user_profile – Управляет профилями пользователей Windows.
Примечание
Этот плагин входит в состав коллекции community.windows (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install community.windows
Для использования в книге задач укажите: community.windows.win_user_profile
Описание
- Используется для создания или удаления профилей пользователей на хосте Windows.
- Это можно использовать для создания профиля перед входом пользователя в систему или удаления профиля при удалении учетной записи пользователя.
- Профиль может быть создан как для локальной, так и для доменной учетной записи.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| name строка | Указывает базовое имя для пути к профилю. Когда state имеет значение present, это используется для создания профиля для username по определенному пути внутри каталога профиля.Это нельзя использовать для указания пути вне каталога профиля, но оно указывает папки (или подпапки) внутри этого каталога. Если профиль для другого пользователя уже существует по этому же пути, Windows автоматически добавляет к имени 3-значный инкрементный номер. Если state имеет значение absent, а username не задано, модуль удалит все профили, которые указывают на путь к профилю, определённый этим значением.Это полезно, если учетная запись больше не существует, но профиль все еще остается. | |
| remove_multiple логическое |
| Когда state имеет значение absent, а значение name соответствует нескольким профилям, модуль завершится ошибкой.Установите это значение в yes, чтобы принудительно заставить модуль удалить все найденные профили. |
| state строка |
| Обеспечит существование профиля, если установлено значение present.При создании профиля параметр username должен быть установлен на действительную учетную запись. Удалить профиль(и), если установлено значение absent.При удалении профиля необходимо установить либо username на действительную учетную запись, либо name на базовое имя профиля. |
| username sid | Имя учетной записи с идентификатором безопасности (SID) для профиля. Это значение должно быть установлено, когда state имеет значение present, и должно быть действительной учетной записью или SID действительной учетной записи.Когда state имеет значение absent, это по-прежнему должно быть действительным номером учетной записи, но SID может быть SID удаленного пользователя. |
См. также
См. также
- ansible.windows.win_user
-
Официальная документация по модулю ansible.windows.win_user.
- community.windows.win_domain_user
-
Официальная документация по модулю community.windows.win_domain_user.
Примеры
- name: Create a profile for an account
community.windows.win_user_profile:
username: ansible-account
state: present
- name: Create a profile for an account at C:\Users\ansible
community.windows.win_user_profile:
username: ansible-account
name: ansible
state: present
- name: Remove a profile for a still valid account
community.windows.win_user_profile:
username: ansible-account
state: absent
- name: Remove a profile for a deleted account
community.windows.win_user_profile:
name: ansible
state: absent
- name: Remove a profile for a deleted account based on the SID
community.windows.win_user_profile:
username: S-1-5-21-3233007181-2234767541-1895602582-1305
state: absent
- name: Remove multiple profiles that exist at the basename path
community.windows.win_user_profile:
name: ansible
state: absent
remove_multiple: yes
Значения возврата
Общие значения возврата описаны в этом разделе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| path строка | всегда | Полный путь к профилю для учетной записи. Будет пусто, если state=absent и профиль не был удален.Пример: C:\Users\ansible |
Авторы
- Jordan Borean (@jborean93)
© 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/community/windows/win_user_profile_module.html
