Модуль community.windows.win_user_profile — Управление профилями пользователей Windows.

Примечание

Этот модуль входит в коллекцию community.windows (версия 2.3.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: 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`, чтобы принудительно заставить модуль удалить все найденные профили. Варианты: `false` ← (по умолчанию) `true`
state строка	Обеспечит существование профиля, если установлено значение `present`. При создании профиля необходимо задать параметр username, значением которого должна быть корректная учетная запись. Удалите профиль(и), если установлено значение `absent`. При удалении профиля необходимо либо задать username для корректной учетной записи, либо name для базового имени профиля. Варианты: `"absent"` `"present"` ← (по умолчанию)
username sid	Имя учетной записи идентификатора безопасности (SID) для профиля. Этот параметр должен быть задан, когда state равно `present`, и должен быть корректной учетной записью или SID корректной учетной записи. Когда state равно `absent`, это должно быть корректное имя учетной записи, но SID может быть SID удаленного пользователя.

См. также

ansible.windows.win_user: Управление локальными учетными записями пользователей Windows.
community.windows.win_domain_user: Управление учетными записями пользователей Windows Active Directory.

Примеры

- 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: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
path строка	Полный путь к профилю для учетной записи. Будет равен null, если `state=absent` и профиль не был удален. Возвращаемое значение: всегда Пример: `"C:\\Users\\ansible"`

Авторы

Jordan Borean (@jborean93)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_user_profile_module.html