Модуль community.windows.win_domain_user — Управление учетными записями пользователей Windows Active Directory

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.windows.

Для использования в книге задач укажите: community.windows.win_domain_user.

УСТАРЕВШИЙ
Обзор
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

УСТАРЕВШИЙ

Удалено в:: версия 3.0.0
Почему:: Этот модуль перенесен в коллекцию microsoft.ad.
Альтернатива:: Используйте модуль microsoft.ad.user вместо этого.

Обзор

Управление учетными записями пользователей Windows Active Directory.

Параметры

Параметр	Комментарии
account_locked boolean	`no` разблокирует учетную запись пользователя, если она заблокирована. Обратите внимание, что нет способа заблокировать учетную запись в качестве администратора. Учетные записи блокируются из-за действий пользователя; как администратор, вы можете только разблокировать заблокированную учетную запись. Если вы хотите административно отключить учетную запись, установите enabled в `no`. Варианты: `false` `true`
attributes словарь	Словарь пользовательских атрибутов LDAP для установки для пользователя. Это можно использовать для установки пользовательских атрибутов, которые не представлены как параметры модуля, например `telephoneNumber`. См. примеры по форматированию этого параметра.
city строка	Настраивает город пользователя.
company строка	Настраивает название компании пользователя.
country строка	Настраивает код страны пользователя. Обратите внимание, что это код ISO 3166 длиной в два символа.
delegates псевдонимы: principals_allowed_to_delegate список / элементы=строка добавлено в community.windows 1.10.0	Определяет массив объектов принципала. Этот параметр устанавливает атрибут msDS-AllowedToActOnBehalfOfOtherIdentity объекта учетной записи компьютера. Должен быть указан в виде `CN=shenetworks,CN=Users,DC=ansible,DC=test`.
description строка	Описание пользователя
display_name строка добавлено в community.windows 1.12.0	Настраивает отображаемое имя пользователя.
domain_password строка	Пароль для username.
domain_server строка	Указывает экземпляр Active Directory Domain Services для подключения. Может быть в формате FQDN или NetBIOS имени. Если не указано, значение основано на домене компьютера, на котором выполняется PowerShell.
domain_username строка	Имя пользователя для взаимодействия с AD. Если это не установлено, вместо этого будет использоваться пользователь Ansible, с помощью которого был выполнен вход, при использовании CredSSP или Kerberos с делегированием учетных данных.
email строка	Настраивает адрес электронной почты пользователя. Это запись в AD и ничего не делает для настройки серверов или систем электронной почты.
enabled boolean	`yes` включит учетную запись пользователя. `no` отключит учетную запись. Варианты: `false` `true` ← (по умолчанию)
firstname строка	Настраивает имя пользователя (имя).
groups список / элементы=строка	Добавляет или удаляет пользователя из этого списка групп в зависимости от значения groups_action. Чтобы удалить все, кроме основной группы, установите `groups=<principal group name>` и groups_action=replace. Обратите внимание, что пользователей нельзя удалить из их основной группы (например, «Пользователи домена»).
groups_action строка	Если `add`, пользователь добавляется в каждую группу в groups, если он в неё ещё не входит. Если `remove`, пользователь удаляется из каждой группы в groups. Если `replace`, пользователь добавляется как член каждой группы в groups и удаляется из любых других групп. Варианты: `"add"` `"remove"` `"replace"` ← (по умолчанию)
groups_missing_behaviour строка добавлено в community.windows 1.10.0	Управляет тем, что происходит, когда группа, указанная в `groups`, является недопустимым именем группы. `fail` является значением по умолчанию и вернёт ошибку, если группы не существуют. `ignore` проигнорирует все отсутствующие группы. `warn` отобразит предупреждение об отсутствующих группах, но продолжит работу без сбоя. Варианты: `"fail"` ← (по умолчанию) `"ignore"` `"warn"`
identity строка	Параметр идентификатора, используемый для поиска пользователя в Active Directory. Это значение может быть в форматах `Distinguished Name`, `objectGUID`, `objectSid` или `sAMAccountName`. По умолчанию `name` если не установлено.
name строка / обязательно	Имя пользователя для создания, удаления или изменения.

END_OF_DOCUMENT_MARKER

пароль строка	Необязательно задайте пароль пользователя к этому (в текстовом) значению. Для включения учетной записи — enabled — пароль должен быть уже настроен в учетной записи, или вы должны указать пароль здесь.
password_expired булево	`yes` потребует от пользователя смены пароля при следующей авторизации. `no` очистит флаг истечения срока действия пароля. Это взаимоисключающие параметры с password_never_expires. Варианты: `false` `true`
password_never_expires булево	`yes` установит пароль, который никогда не истекает. `no` позволит паролю истечь. Это взаимоисключающие параметры с password_expired. Варианты: `false` `true`
путь строка	Контейнер или организационная единица для нового пользователя; если вы этого не укажете, пользователь будет помещен в стандартный контейнер для пользователей в домене. Настройка пути доступна только при создании нового пользователя; если вы укажете путь для существующего пользователя, путь пользователя не будет обновлен — необходимо удалить (например, `state=absent`) пользователя и затем добавить его заново с соответствующим путем.
почтовый_индекс строка	Настраивает почтовый индекс/почтовый код пользователя.
sam_account_name строка добавлено в community.windows 1.7.0	Настраивает имя учетной записи SAM (`sAMAccountName`) для учетной записи. Допускается максимум 20 символов из-за ограничений до Windows 2000. По умолчанию используется `<username>`, указанный в `upn` или `name`, если не задан.
spn псевдонимы: spns список / элементы=строка добавлено в community.windows 1.10.0	Указывает имя(а) принципала службы для учетной записи. Этот параметр устанавливает свойство ServicePrincipalNames учетной записи. Имя отображения LDAP (ldapDisplayName) для этого свойства — servicePrincipalName.
spn_action строка добавлено в community.windows 1.10.0	Если `add`, SPNs добавляются к пользователю. Если `remove`, SPNs удаляются из пользователя. Если `replace`, заданный набор SPN'ов перезаписывает текущий набор SPN'ов. Варианты: `"add"` `"remove"` `"replace"` ← (по умолчанию)
состояние строка	При значении `present`, создает или обновляет учетную запись пользователя. При значении `absent`, удаляет учетную запись пользователя, если она существует. При значении `query`, получает данные учетной записи пользователя без внесения каких-либо изменений. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
state_province строка	Настраивает регион или провинцию пользователя.
улица строка	Настраивает адрес улицы пользователя.
фамилия псевдонимы: lastname строка	Настраивает фамилию пользователя.
update_password строка	`always` всегда будет обновлять пароли. `on_create` будет устанавливать пароль только для вновь созданных пользователей. `when_changed` будет устанавливать пароль только при изменении. Варианты: `"always"` ← (по умолчанию) `"on_create"` `"when_changed"`
upn строка	Настраивает имя принципала пользователя (UPN) для учетной записи. Это необязательно, но рекомендуется для современных версий Active Directory. Формат: `<username>@<domain>`.
user_cannot_change_password булево	`yes` запретит пользователю менять пароль. `no` позволит пользователю менять пароль. Варианты: `false` `true`

Примечания

Примечание

Работает с Windows 2012R2 и новее.
Если выполняется на сервере, который не является контроллером домена, требуется делегирование учетных данных через CredSSP или Kerberos с делегированием, или нужно указать domain_username, domain_password.
Заметка, что некоторые пользователи подтвердили успешную работу на серверах Windows 2008R2 с включенными AD и AD Web Services, но это не получило такого же уровня тестирования, как Windows 2012R2.

См. также

ansible.windows.win_domain: Обеспечивает существование домена Windows.
ansible.windows.win_domain_controller: Управление состоянием контроллера домена/сервера-члена для хоста Windows.
community.windows.win_domain_computer: Управление компьютерами в Active Directory.
community.windows.win_domain_group: Создание, изменение или удаление групп домена.
ansible.windows.win_domain_membership: Управление членством в домене/рабочей группе для хоста Windows.
ansible.windows.win_user: Управление локальными учетными записями пользователей Windows.
community.windows.win_user_profile: Управление профилями пользователей Windows.

Примеры

- name: Ensure user bob is present with address information
  community.windows.win_domain_user:
    name: bob
    firstname: Bob
    surname: Smith
    display_name: Mr. Bob Smith
    company: BobCo
    password: B0bP4ssw0rd
    state: present
    groups:
      - Domain Admins
    street: 123 4th St.
    city: Sometown
    state_province: IN
    postal_code: 12345
    country: US
    attributes:
      telephoneNumber: 555-123456

- name: Ensure user bob is created and use custom credentials to create the user
  community.windows.win_domain_user:
    name: bob
    firstname: Bob
    surname: Smith
    password: B0bP4ssw0rd
    state: present
    domain_username: DOMAIN\admin-account
    domain_password: SomePas2w0rd
    domain_server: domain@DOMAIN.COM

- name: Ensure user bob is present in OU ou=test,dc=domain,dc=local
  community.windows.win_domain_user:
    name: bob
    password: B0bP4ssw0rd
    state: present
    path: ou=test,dc=domain,dc=local
    groups:
      - Domain Admins

- name: Ensure user bob is absent
  community.windows.win_domain_user:
    name: bob
    state: absent

- name: Ensure user has spn's defined
  community.windows.win_domain_user:
    name: liz.kenyon
    spn:
      - MSSQLSvc/us99db-svr95:1433
      - MSSQLSvc/us99db-svr95.vmware.com:1433

- name: Ensure user has spn added
  community.windows.win_domain_user:
    name: liz.kenyon
    spn_action: add
    spn:
      - MSSQLSvc/us99db-svr95:2433

- name: Ensure user is created with delegates and spn's defined
  community.windows.win_domain_user:
    name: shmemmmy
    password: The3rubberducki33!
    state: present
    groups:
      - Domain Admins
      - Enterprise Admins
    delegates:
      - CN=shenetworks,CN=Users,DC=ansible,DC=test
      - CN=mk.ai,CN=Users,DC=ansible,DC=test
      - CN=jessiedotjs,CN=Users,DC=ansible,DC=test
    spn:
      - MSSQLSvc/us99db-svr95:2433

Значения возврата

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

Ключ	Описание
account_locked boolean	true, если учетная запись заблокирована Возвращается: всегда Пример: `false`
changed boolean	true, если учетная запись изменилась во время выполнения Возвращается: всегда Пример: `false`
city string	Город пользователя Возвращается: всегда Пример: `"Indianapolis"`
company string	Компания пользователя Возвращается: всегда Пример: `"RedHat"`
country string	Страна пользователя Возвращается: всегда Пример: `"US"`
created boolean	Был ли создан пользователь Возвращается: всегда Пример: `true`
delegates list / elements=string добавлено в community.windows 1.10.0	Уполномоченные субъекты Возвращается: всегда Пример: `["CN=svc.tech.unicorn,CN=Users,DC=ansible,DC=test", "CN=geoff,CN=Users,DC=ansible,DC=test"]`
description string	Описание учетной записи Возвращается: всегда Пример: `"Server Administrator"`
display_name string	Отображаемое имя пользователя Возвращается: всегда Пример: `"Nick Doe"`
distinguished_name string	DN учетной записи пользователя Возвращается: всегда Пример: `"CN=nick,OU=test,DC=domain,DC=local"`
email string	Адрес электронной почты пользователя Возвращается: всегда Пример: `"nick@domain.local"`
enabled string	true, если учетная запись включена, и false, если отключена Возвращается: всегда Пример: `"True"`
firstname string	Имя пользователя Возвращается: всегда Пример: `"Nick"`
groups list / elements=string	AD-группы, к которым принадлежит учетная запись Возвращается: всегда Пример: `["Domain Admins", "Domain Users"]`
msg string	Краткое сообщение о наличии или отсутствии пользователя Возвращается: всегда Пример: `"User nick is present"`
name string	Имя пользователя в учетной записи Возвращается: всегда Пример: `"nick"`
password_expired boolean	true, если пароль учетной записи истек Возвращается: всегда Пример: `false`
password_updated boolean	true, если пароль изменился во время этого выполнения Возвращается: всегда Пример: `true`

индекс_почтовый строка	Почтовый индекс пользователя Возвращается: всегда Пример: `"46033"`
имя_учета_SAM строка добавлен в community.windows 1.7.0	Имя учетной записи SAM Возвращается: всегда Пример: `"nick"`
SID строка	SID учетной записи Возвращается: всегда Пример: `"S-1-5-21-2752426336-228313920-2202711348-1175"`
spn список / элементы=строка добавлен в community.windows 1.10.0	Имена основных служб Возвращается: всегда Пример: `["HTTPSvc/ws1intel-svc1", "HTTPSvc/ws1intel-svc1.vmware.com"]`
состояние строка	Состояние учетной записи пользователя Возвращается: всегда Пример: `"present"`
регион_штат строка	Регион или штат пользователя Возвращается: всегда Пример: `"IN"`
улица строка	Улица пользователя Возвращается: всегда Пример: `"123 4th St."`
фамилия строка	Фамилия пользователя Возвращается: всегда Пример: `"Doe"`
UPN строка	Основное имя пользователя Возвращается: всегда Пример: `"nick@domain.local"`
пользователь_не_может_изменить_пароль строка	true, если пользователь не может изменить пароль Возвращается: всегда Пример: `"False"`

Статус

Этот модуль будет удален в версии 3.0.0. [устарел]
Дополнительная информация см. в разделе УСТАРЕВШЕ.

Авторы

Nick Chandler (@nwchandler)
Joe Zollo (@zollo)

Ссылки на сборки

© 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_domain_user_module.html