community.general.ipa_user – Управление пользователями FreeIPA

Примечание

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

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

Чтобы использовать его в книге задач, укажите: community.general.ipa_user

Обзор
Требования
Параметры
Примеры
Возвращаемые значения

Обзор

Добавление, изменение и удаление пользователей на сервере IPA.

Требования

Ниже приведены требования к хосту, на котором будет выполняться этот модуль.

base64
hashlib

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
displayname строка		Имя для отображения.
gidnumber строка		Идентификатор группы POSIX.
givenname строка		Имя.
homedirectory строка добавлен в 0.2.0 community.general		Стандартный домашний каталог пользователя.
ipa_host строка	По умолчанию: "ipa.example.com"	IP-адрес или имя хоста сервера IPA. Если значение не указано в задаче, используется значение переменной среды `IPA_HOST`. Если обе переменные среды `IPA_HOST` и значение не указаны в задаче, для поиска сервера FreeIPA используется DNS. В FreeIPA необходима запись 'ipa-ca'. Если ни запись DNS, ни переменная среды `IPA_HOST`, ни значение не указаны в задаче, используется значение по умолчанию. Механизм обратной совместимости с переменными среды добавлен в Ansible 2.5.
ipa_pass строка		Пароль административного пользователя. Если значение не указано в задаче, используется значение переменной среды `IPA_PASS`. Если доступна библиотека 'urllib_gssapi', можно использовать GSSAPI для аутентификации в FreeIPA. Если доступна переменная среды `KRB5CCNAME`, модуль будет использовать этот кэш учетных данных Kerberos для аутентификации на сервере FreeIPA. Если доступна переменная среды `KRB5_CLIENT_KTNAME`, и `KRB5CCNAME` не указана, модуль будет использовать этот ключ Kerberos для аутентификации. Если GSSAPI недоступен, требуется использовать 'ipa_pass'. Механизм обратной совместимости с переменными среды добавлен в Ansible 2.5.
ipa_port целое число	По умолчанию: 443	Порт сервера FreeIPA/IPA. Если значение не указано в задаче, используется значение переменной среды `IPA_PORT`. Если обе переменные среды `IPA_PORT` и значение не указаны в задаче, используется значение по умолчанию. Механизм обратной совместимости с переменными среды добавлен в Ansible 2.5.
ipa_prot строка	Варианты: http https ←	Протокол, используемый сервером IPA. Если значение не указано в задаче, используется значение переменной среды `IPA_PROT`. Если обе переменные среды `IPA_PROT` и значение не указаны в задаче, используется значение по умолчанию. Механизм обратной совместимости с переменными среды добавлен в Ansible 2.5.
ipa_timeout целое число	По умолчанию: 10	Устанавливает таймаут бездействия (в секундах) для подключения. Для массовых операций может потребоваться увеличить это значение, чтобы избежать таймаутов со стороны сервера IPA. Если значение не указано в задаче, используется значение переменной среды `IPA_TIMEOUT`. Если обе переменные среды `IPA_TIMEOUT` и значение не указаны в задаче, используется значение по умолчанию.
ipa_user строка	По умолчанию: "admin"	Используемый на сервере IPA административный аккаунт. Если значение не указано в задаче, используется значение переменной среды `IPA_USER`. Если обе переменные среды `IPA_USER` и значение не указаны в задаче, используется значение по умолчанию. Механизм обратной совместимости с переменными среды добавлен в Ansible 2.5.
krbpasswordexpiration строка		Дата истечения срока действия пароля пользователя. В формате ГГГГММДДЧЧММСС. Например, 20180121182022 истечёт 21 января 2018 года в 18:20:22.
loginshell строка		Логический интерфейс.
mail список / элементы=строка		Список адресов электронной почты, назначенных пользователю. Если передан пустой список, все назначенные адреса электронной почты будут удалены. Если передано None, адреса электронной почты не будут проверены или изменены.
password строка		Пароль пользователя. Не будет установлен для существующего пользователя, если update_password=always, что является значением по умолчанию.
sn строка		Фамилия.
sshpubkey список / элементы=строка		Список публичных SSH-ключей. Если передан пустой список, все назначенные ключи будут удалены. Если передано None, SSH-ключи не будут проверены или изменены.
state строка	Варианты: absent disabled enabled present ←	Требуемое состояние.
telephonenumber список / элементы=строка		Список телефонных номеров, назначенных пользователю. Если передан пустой список, все назначенные телефонные номера будут удалены. Если передано None, телефонные номера не будут проверены или изменены.
title строка		Должность.
uid строка / обязательно		Идентификатор пользователя. псевдонимы: имя
uidnumber строка		Номер идентификатора пользователя/почтового ящика.
update_password строка	Варианты: always ← on_create	Установка пароля пользователя.
userauthtype строка добавлен в 1.2.0 community.general	Варианты: password radius otp pkinit hardened	Тип аутентификации для пользователя.
validate_certs булево	Варианты: no yes ←	Это относится только если `ipa_prot` равно https. Если установлено значение `no`, сертификаты SSL не будут проверены. Это следует устанавливать только в `no` на сайтах с собственными сертификатами.

Примеры

- name: Ensure pinky is present and always reset password
  community.general.ipa_user:
    name: pinky
    state: present
    krbpasswordexpiration: 20200119235959
    givenname: Pinky
    sn: Acme
    mail:
    - pinky@acme.com
    telephonenumber:
    - '+555123456'
    sshpubkey:
    - ssh-rsa ....
    - ssh-dsa ....
    uidnumber: '1001'
    gidnumber: '100'
    homedirectory: /home/pinky
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure brain is absent
  community.general.ipa_user:
    name: brain
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure pinky is present but don't reset password if already exists
  community.general.ipa_user:
    name: pinky
    state: present
    givenname: Pinky
    sn: Acme
    password: zounds
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    update_password: on_create

- name: Ensure pinky is present and using one time password authentication
  community.general.ipa_user:
    name: pinky
    state: present
    userauthtype: otp
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

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

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

Ключ	Возвращаемое значение	Описание
user словарь	всегда	Пользователь, как возвращается API IPA

Авторы

Thomas Krahn (@Nosmoht)

© 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/general/ipa_user_module.html