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

Примечание

Этот плагин входит в коллекцию community.windows (версия 1.2.0).

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

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

Обзор
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account_locked строка	Варианты: False	`no` разблокирует учетную запись пользователя, если она заблокирована. Обратите внимание, что нет возможности заблокировать учетную запись в качестве администратора. Учетные записи блокируются из-за действий пользователя; в качестве администратора вы можете только разблокировать заблокированную учетную запись. Если вы хотите административно отключить учетную запись, установите enabled в `no`.
attributes строка		Словарь пользовательских атрибутов LDAP для установки для пользователя. Это может быть использовано для установки пользовательских атрибутов, которые не представлены как параметры модуля, например `telephoneNumber`. См. примеры по форматированию этого параметра.
city строка		Настройка города пользователя.
company строка		Настройка названия компании пользователя.
country строка		Настройка кода страны пользователя. Обратите внимание, что это двухсимвольный код ISO 3166.
description строка		Описание пользователя
domain_password строка		Пароль для username.
domain_server строка		Указывает экземпляр Active Directory Domain Services, с которым нужно подключиться. Может быть в формате FQDN или NetBIOS имени. Если не указано, то значение основано на домене компьютера, на котором выполняется PowerShell.
domain_username строка		Имя пользователя для взаимодействия с AD. Если это не установлено, вместо него будет использоваться пользователь Ansible, с которым вошли, при использовании CredSSP или Kerberos с делегированием учетных данных.
email строка		Настройка адреса электронной почты пользователя. Это запись в AD и не выполняет никаких действий по настройке каких-либо почтовых серверов или систем.
enabled булево	Варианты: no да ←	`yes` включит учетную запись пользователя. `no` отключит учетную запись.
firstname строка		Настройка имени пользователя (имени).
groups список / элементы=строка		Добавляет или удаляет пользователя из этого списка групп в зависимости от значения groups_action. Для удаления всех, кроме основной группы, установите `groups=<principal group name>` и groups_action=replace. Обратите внимание, что пользователей нельзя удалить из их основной группы (например, "Пользователи домена").
groups_action строка	Варианты: add remove replace ←	Если `add`, пользователь добавляется в каждую группу в groups, где он еще не является членом. Если `remove`, пользователь удаляется из каждой группы в groups. Если `replace`, пользователь добавляется в качестве члена каждой группы в groups и удаляется из всех других групп.
identity строка		Параметр идентификации, используемый для поиска пользователя в Active Directory. Это значение может быть в форматах `Distinguished Name`, `objectGUID`, `objectSid` или `sAMAccountName`. По умолчанию `name` при отсутствии значения.
name строка / обязательно		Имя пользователя для создания, удаления или изменения.
password строка		Необязательно установить пароль пользователя в это значение (в виде простого текста). Для активации учетной записи - enabled - пароль должен быть уже настроен в учетной записи, или вы должны указать пароль здесь.
password_expired булево	Варианты: no yes	`yes` потребует от пользователя сменить пароль при следующей попытке входа. `no` очистит флаг истекшего пароля. Это взаимно исключает password_never_expires.
password_never_expires булево	Варианты: no yes	`yes` установит пароль, который никогда не истекает. `no` позволит паролю истечь. Это взаимно исключает password_expired.
path строка		Контейнер или OU для нового пользователя; если вы не укажете это, пользователь будет размещен в стандартном контейнере для пользователей в домене. Установка пути доступна только при создании нового пользователя; если вы укажете путь для существующего пользователя, путь пользователя не будет обновлён — вы должны удалить (например, `state=absent`) пользователя, а затем повторно добавить пользователя с соответствующим путём.
postal_code строка		Настройка почтового индекса пользователя.
state строка	Варианты: absent present ← query	При значении `present`, создает или обновляет учетную запись пользователя. При значении `absent`, удаляет учетную запись пользователя, если она существует. При значении `query`, извлекает данные учетной записи пользователя без внесения каких-либо изменений.
state_province строка		Настройка штата или провинции пользователя.
street строка		Настройка уличного адреса пользователя.
surname строка		Настройка фамилии пользователя.
update_password строка	Варианты: всегда ← при_создании при_изменении	`always` всегда будет обновлять пароли. `on_create` будет устанавливать пароль только для вновь созданных пользователей. `when_changed` будет устанавливать пароль только при изменении.
upn строка		Настройка имени принципала пользователя (UPN). Это необязательно, но рекомендуется для современных версий Active Directory. Формат: `<username>@<domain>`.
user_cannot_change_password булево	Варианты: no yes	`yes` запретит пользователю изменение пароля. `no` позволит пользователю изменить пароль.

Примечания

Примечание

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

См. также

ansible.windows.win_domain: Официальная документация по модулю ansible.windows.win_domain.
ansible.windows.win_domain_controller: Официальная документация по модулю ansible.windows.win_domain_controller.
community.windows.win_domain_computer: Официальная документация по модулю community.windows.win_domain_computer.
community.windows.win_domain_group: Официальная документация по модулю community.windows.win_domain_group.
ansible.windows.win_domain_membership: Официальная документация по модулю ansible.windows.win_domain_membership.
ansible.windows.win_user: Официальная документация по модулю ansible.windows.win_user.
community.windows.win_user_profile: Официальная документация по модулю community.windows.win_user_profile.

Примеры

- name: Ensure user bob is present with address information
  community.windows.win_domain_user:
    name: bob
    firstname: Bob
    surname: 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

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

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

Ключ	Возвращаемое значение	Описание
account_locked boolean	всегда	true, если учетная запись заблокирована
changed boolean	всегда	true, если учетная запись изменилась во время выполнения
city string	всегда	Город пользователя Пример: Индианаполис
company string	всегда	Компания пользователя Пример: RedHat
country string	всегда	Страна пользователя Пример: США
created boolean	всегда	Создана ли учетная запись пользователя Пример: True
description string	всегда	Описание учетной записи Пример: Администратор сервера
distinguished_name string	всегда	DN учетной записи пользователя Пример: CN=ник,OU=тест,DC=домен,DC=локальный
email string	всегда	Адрес электронной почты пользователя Пример: ник@домен.локальный
enabled string	всегда	true, если учетная запись включена, и false, если отключена Пример: True
firstname string	всегда	Имя пользователя Пример: Ник
groups list / elements=string	всегда	Группы Active Directory, к которым принадлежит учетная запись Пример: ['Администраторы домена', 'Пользователи домена']
msg string	всегда	Сообщение о том, есть ли пользователь или нет Пример: Пользователь ник есть
name string	всегда	Имя пользователя в учетной записи Пример: ник
password_expired boolean	всегда	true, если пароль учетной записи истек
password_updated boolean	всегда	true, если пароль был изменен во время выполнения Пример: True
postal_code string	всегда	Почтовый индекс пользователя Пример: 46033
sid string	всегда	SID учетной записи Пример: S-1-5-21-2752426336-228313920-2202711348-1175
state string	всегда	Состояние учетной записи пользователя Пример: present
state_province string	всегда	Штат или провинция пользователя Пример: IN
street string	всегда	Улица пользователя Пример: 123 4-я ул.
surname string	всегда	Фамилия пользователя Пример: Иванов
upn string	всегда	Имя основного принципа пользователя Пример: ник@домен.локальный
user_cannot_change_password string	всегда	true, если пользователь не может изменить пароль

Авторы

Nick Chandler (@nwchandler)

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