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 Domain Services для подключения. Может быть в формате FQDN или NetBIOS-имени. Если не указано, значение основано на домене компьютера, на котором выполняется PowerShell. | |
| domain_username (добавлен в 2.5) | Имя пользователя для взаимодействия с AD. Если не указано, вместо него будет использоваться пользователь Ansible, который вошёл в систему, при использовании CredSSP или Kerberos с делегированием учетных данных. | |
| Настройка адреса электронной почты пользователя. Это запись в AD и не выполняет никаких действий для настройки серверов или систем электронной почты. | ||
| enabled |
| yes активирует учетную запись пользователя. no отключит учетную запись. |
| firstname | Настройка имени пользователя (имени) | |
| groups | Добавляет или удаляет пользователя из этого списка групп в зависимости от значения groups_action. Чтобы удалить все, кроме основной группы, установите groups=<principal group name> и groups_action=replace. Обратите внимание, что пользователей нельзя удалить из их основной группы (например, "Пользователи домена"). | |
| groups_action |
| Если replace, пользователь добавляется в качестве члена каждой группы в groups и удаляется из любых других групп. Если add, пользователь добавляется в каждую группу в groups, где ещё не является членом. Если remove, пользователь удаляется из каждой группы в groups. |
| name обязательно | Имя пользователя для создания, удаления или изменения. | |
| password | Необязательно установите пароль пользователя в это значение (в виде простого текста). Для активации учетной записи - enabled - пароль должен быть уже настроен в учетной записи или вы должны предоставить пароль здесь. | |
| password_expired |
| yes потребует от пользователя сменить пароль при следующей авторизации. no очистит флаг истекшего пароля. Это взаимоисключающие параметры с password_never_expires. |
| password_never_expires |
| 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. Формат: "<имя пользователя>@<домен>". | |
| user_cannot_change_password |
| 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, если пользователь не может изменить пароль |
Статус
Этот модуль помечен как превью, что означает, что совместимость с предыдущими версиями не гарантируется.
Автор
- 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.5/modules/win_domain_user_module.html