win_domain_user – Управляет учетными записями пользователей Windows Active Directory
Новая в версии 2.4.
Обзор
- Управляет учетными записями пользователей Windows Active Directory.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account_locked - |
| no разблокирует учетную запись пользователя, если она заблокирована. Обратите внимание, что нет способа заблокировать учетную запись администратором. Учетные записи блокируются в результате действий пользователя; как администратор, вы можете только разблокировать заблокированную учетную запись. Если вы хотите административно отключить учетную запись, установите enabled в no. |
| attributes - добавлено в 2.5 | Словарь пользовательских атрибутов LDAP для установки на пользователя. Это можно использовать для установки пользовательских атрибутов, которые не представлены как параметры модуля, например telephoneNumber. См. примеры, как отформатировать этот параметр. | |
| city - | Настраивает город пользователя. | |
| company - | Настраивает название компании пользователя. | |
| country - | Настраивает код страны пользователя. Обратите внимание, что это двухсимвольный код ISO 3166. | |
| description - | Описание пользователя | |
| domain_password - добавлено в 2.5 | Пароль для username. | |
| domain_server - добавлено в 2.5 | Указывает экземпляр служб доменных имен Active Directory для подключения. Может быть в формате FQDN или имени NetBIOS. Если не указано, значение основано на домене компьютера, на котором выполняется PowerShell. | |
| domain_username - добавлено в 2.5 | Имя пользователя для взаимодействия с AD. Если это не установлено, вместо него будет использоваться пользователь Ansible, с помощью которого выполняется вход, при использовании CredSSP или Kerberos с делегированием учетных данных. | |
| email - | Настраивает адрес электронной почты пользователя. Это запись в AD и не выполняет никаких действий по настройке серверов или систем электронной почты. | |
| enabled boolean |
| yes включит учетную запись пользователя.no отключит учетную запись. |
| firstname - | Настраивает имя пользователя (имя). | |
| groups список | Добавляет или удаляет пользователя из этого списка групп в зависимости от значения groups_action. Чтобы удалить все, кроме основной группы, установите groups=<principal group name> и groups_action=replace. Обратите внимание, что пользователей нельзя удалить из их основной группы (например, "Пользователи домена"). | |
| groups_action - |
| Если add, пользователь добавляется в каждую группу в groups, где он еще не член.Если remove, пользователь удаляется из каждой группы в groups.Если replace, пользователь добавляется как член каждой группы в groups и удаляется из других групп. |
| name - / обязательно | Имя пользователя для создания, удаления или изменения. | |
| password - | Дополнительно задайте пароль пользователя (в текстовом формате). Чтобы включить учетную запись - enabled - пароль должен быть уже настроен в учетной записи, или вы должны предоставить пароль здесь. | |
| password_expired boolean |
| yes потребует, чтобы пользователь изменил свой пароль при следующем входе.no очистит флаг истекшего пароля.Это взаимоисключающее с password_never_expires. |
| password_never_expires boolean |
| yes установит пароль так, чтобы он никогда не истекал.no позволит паролю истечь.Это взаимоисключающее с password_expired. |
| path - | Контейнер или организационная единица для нового пользователя; если вы не укажете это, пользователь будет помещен в стандартный контейнер для пользователей в домене. Установка пути доступна только при создании нового пользователя; если вы укажете путь для существующего пользователя, путь пользователя не будет обновлен - вы должны удалить (например, state=absent) пользователя, а затем повторно добавить пользователя с соответствующим путем. | |
| postal_code - | Настраивает почтовый индекс пользователя. | |
| state - |
| Когда present, создает или обновляет учетную запись пользователя. Когда absent, удаляет учетную запись пользователя, если она существует. Когда query, получает данные учетной записи пользователя без внесения изменений. |
| state_province - | Настраивает штат или провинцию пользователя. | |
| street - | Настраивает адрес улицы пользователя. | |
| surname - | Настраивает фамилию пользователя. | |
| update_password - |
| always обновит пароли, если они отличаются.on_create установит пароль только для вновь созданных пользователей.Обратите внимание, что always всегда будет отображать статус Ansible как 'изменён', потому что мы не можем определить, отличается ли новый пароль от старого. |
| upn - | Настраивает имя принципа пользователя (UPN) для учетной записи. Это необязательно, но рекомендуется для настройки современных версий Active Directory. Формат - <username>@<domain>. | |
| user_cannot_change_password boolean |
| yes запретит пользователю изменение пароля.no позволит пользователю изменить пароль. |
Примечания
Примечание
- Работает с Windows 2012R2 и более поздними версиями.
- Если выполняется на сервере, который не является контроллером домена, необходимо использовать делегирование учетных данных через CredSSP или Kerberos с делегированием, или установить domain_username, domain_password.
- Обратите внимание, что некоторые пользователи подтвердили успешную работу на серверах Windows 2008R2 с включенным AD и AD Web Services, но это не подвергалось такому же уровню тестирования, как Windows 2012R2.
Примеры
- name: Ensure user bob is present with address information
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
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
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
win_domain_user:
name: bob
state: absent
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account_locked boolean | всегда | true, если учетная запись заблокирована |
| changed boolean | всегда | true, если учетная запись была изменена во время выполнения |
| city string | всегда | Город пользователя Пример: Indianapolis |
| company string | всегда | Компания пользователя Пример: RedHat |
| country string | всегда | Страна пользователя Пример: US |
| description string | всегда | Описание учетной записи Пример: Администратор серверов |
| 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 | всегда | Группы AD, к которым принадлежит учетная запись Пример: ['Администраторы домена', 'Пользователи домена'] |
| msg string | всегда | Сообщение о том, присутствует ли пользователь или отсутствует Пример: Пользователь nick присутствует |
| name string | всегда | Имя пользователя в учетной записи Пример: nick |
| 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 | всегда | Состояние учетной записи пользователя Пример: присутствует |
| state_province string | всегда | Штат или провинция пользователя Пример: IN |
| street string | всегда | Улицы пользователя Пример: 123 4th St. |
| surname string | всегда | Фамилия пользователя Пример: Doe |
| upn string | всегда | Идентификатор пользователя (User Principal Name) учетной записи Пример: nick@domain.local |
| user_cannot_change_password string | всегда | true, если пользователь не может изменить пароль |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/win_domain_user_module.html