user - Управление учетными записями пользователей
Обзор
- Управление учетными записями пользователей и атрибутами пользователей.
- Для целей Windows используйте модуль win_user вместо этого.
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| append | нет | нет |
| Если yes, будут добавлены только группы, а не установлены только те, что указаны в groups. |
| comment | нет | Необязательно задаёт описание (также известное как GECOS) учетной записи пользователя. | ||
| createhome | нет | да |
| Если не установлено no, домашний каталог будет создан для пользователя при создании учетной записи или если домашний каталог не существует. |
| expires (добавлено в 1.9)
| нет | Нет | Время истечения срока действия для пользователя в эпохе, оно будет проигнорировано на платформах, которые этого не поддерживают. В настоящее время поддерживается на Linux и FreeBSD. | |
| force | нет | нет |
| При использовании с state=absent, поведение такое же, как с userdel --force. |
| generate_ssh_key | нет | нет |
| Создать ли ключ SSH для данного пользователя. Это не перепишет существующий ключ SSH. |
| group | нет | Необязательно задаёт основную группу пользователя (задаётся имя группы). | ||
| groups | нет | Добавляет пользователя в список групп. Если задано пустой строкой ('groups='), пользователь удаляется из всех групп, кроме основной. До версии 2.3 единственный допустимый формат ввода — «строка, разделённая запятыми», теперь он также должен принимать списки YAML. | ||
| home | нет | Необязательно задаёт домашний каталог пользователя. | ||
| local (добавлено в 2.4)
| нет | False | Принудительно использует альтернативы команды «local» на платформах, которые её реализуют. Это полезно в средах с централизованной аутентификацией, когда вы хотите манипулировать локальными пользователями. То есть использует `luseradd` вместо `useradd`. Это требует, чтобы эти команды существовали на целевом хосте, в противном случае это будет ошибка. | |
| login_class | нет | Необязательно задаёт класс входа для систем FreeBSD, OpenBSD и NetBSD. | ||
| move_home | нет | нет |
| Если установлено yes, при использовании с home=, попытаться переместить домашний каталог пользователя в указанный каталог, если он там ещё не существует. |
| name | да | Имя пользователя для создания, удаления или изменения. псевдонимы: user | ||
| non_unique | нет | нет |
| Необязательно, при использовании с опцией -u, эта опция позволяет изменить идентификатор пользователя на не уникальное значение. |
| password | нет | Необязательно задаёт пароль пользователя этому зашифрованному значению. См. пример пользователя в каталоге примеров github для того, как это выглядит в книге. См. http://docs.ansible.com/ansible/faq.html#how-do-i-generate-crypted-passwords-for-the-user-module для получения дополнительной информации о различных способах генерации этих значений пароля. Обратите внимание, что в системах Darwin это значение должно быть открытым текстом. Остерегайтесь проблем безопасности. | ||
| remove | нет | нет |
| При использовании с state=absent, поведение такое же, как с userdel --remove. |
| seuser (добавлено в 2.1)
| нет | Необязательно устанавливает тип seuser (user_u) на системах с включённым selinux. | ||
| shell | нет | Необязательно задаёт оболочку пользователя. | ||
| skeleton (добавлено в 2.0)
| нет | Необязательно задаёт домашний каталог скелета. Требуется опция createhome! | ||
| ssh_key_bits | нет | значение по умолчанию устанавливается ssh-keygen | Необязательно укажите количество бит в ключе SSH для создания. | |
| ssh_key_comment | нет | сгенерировано ansible на $HOSTNAME | Необязательно задайте комментарий для ключа SSH. | |
| ssh_key_file | нет | .ssh/id_rsa | Необязательно укажите имя файла ключа SSH. Если это имя файла относительно, то оно будет относительно домашнего каталога пользователя. | |
| ssh_key_passphrase | нет | Установите пароль для ключа SSH. Если пароль не предоставлен, ключ SSH будет по умолчанию без пароля. | ||
| ssh_key_type | нет | rsa | Необязательно укажите тип ключа SSH для генерации. Доступные типы ключей SSH будут зависеть от реализации, присутствующей на целевом хосте. | |
| state | нет | present |
| Должна существовать учетная запись или нет, выполняя действия, если состояние отличается от заявленного. |
| system | нет | нет |
| При создании учетной записи, установив это значение в yes, делает пользователя системным. Это значение нельзя изменить для существующих пользователей. |
| uid | нет | Необязательно задаёт UID пользователя. | ||
| update_password (добавлено в 1.3)
| нет | всегда |
| always обновит пароли, если они отличаются. on_create установит пароль только для вновь созданных пользователей. |
Примеры
# Add the user 'johnd' with a specific uid and a primary group of 'admin'
- user:
name: johnd
comment: "John Doe"
uid: 1040
group: admin
# Add the user 'james' with a bash shell, appending the group 'admins' and 'developers' to the user's groups
- user:
name: james
shell: /bin/bash
groups: admins,developers
append: yes
# Remove the user 'johnd'
- user:
name: johnd
state: absent
remove: yes
# Create a 2048-bit SSH key for user jsmith in ~jsmith/.ssh/id_rsa
- user:
name: jsmith
generate_ssh_key: yes
ssh_key_bits: 2048
ssh_key_file: .ssh/id_rsa
# added a consultant whose account you want to expire
- user:
name: james18
shell: /bin/zsh
groups: developers
expires: 1422403387
Примечания
Примечание
- Существуют определённые требования к платформам для утилиты управления пользователями. Тем не менее, они обычно предварительно установлены в системе, и Ansible потребует их наличия во время выполнения. Если их нет, будет отображено описательное сообщение об ошибке.
- Для целей Windows используйте модуль win_user вместо этого.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет производиться обратной несовместимости изменений интерфейса.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если у вас есть желание, прочтите Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/user_module.html