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 строка | всегда | Полный путь к профилю для учетной записи. Будет равен null, если state=absent и профиль не был удален.Пример: C:\Пользователи\ansible |
Авторы
- Jordan Borean (@jborean93)
© 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/community/windows/win_user_profile_module.html