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

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.general.ipa_user.

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

Описание

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

Требования

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

base64
hashlib

Параметры

Параметр	Комментарии
displayname string	Отображаемое имя.
gidnumber string	Идентификатор группы POSIX.
givenname string	Имя. Если пользователь не существует и `state=present`, необходимо использовать `givenname`.
homedirectory string added in community.general 0.2.0	Домашний каталог пользователя по умолчанию.
ipa_host string	IP-адрес или имя хоста сервера IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_HOST`. Если и переменная среды `IPA_HOST` и значение не указаны в задаче, то для обнаружения сервера FreeIPA будет использоваться DNS. Необходимая запись в FreeIPA — это запись `ipa-ca`. Если недоступны ни запись DNS, ни переменная среды `IPA_HOST`, ни значение в задаче, то будет использовано значение по умолчанию. Default: `"ipa.example.com"`
ipa_pass string	Пароль административного пользователя. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_PASS`. Обратите внимание, что если доступна библиотека `urllib_gssapi`, можно использовать GSSAPI для аутентификации в FreeIPA. Если доступна переменная среды `KRB5CCNAME`, модуль будет использовать этот кеш учетных данных Kerberos для аутентификации на сервере FreeIPA. Если доступна переменная среды `KRB5_CLIENT_KTNAME`, а `KRB5CCNAME` нет, модуль будет использовать этот ключ Kerberos для аутентификации. Если GSSAPI недоступен, необходимо использовать `ipa_pass`.
ipa_port integer	Порт сервера FreeIPA/IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_PORT`. Если и переменная среды `IPA_PORT` и значение не указаны в задаче, то устанавливается значение по умолчанию. Default: `443`
ipa_prot string	Протокол, используемый сервером IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_PROT`. Если и переменная среды `IPA_PROT` и значение не указаны в задаче, то устанавливается значение по умолчанию. Варианты: `"http"` `"https"` ← (default)
ipa_timeout integer	Указывает время ожидания бездействия (в секундах) для соединения. Для массовых операций может потребоваться увеличение этого значения во избежание истечения времени ожидания со стороны сервера IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_TIMEOUT`. Если и переменная среды `IPA_TIMEOUT` и значение не указаны в задаче, то устанавливается значение по умолчанию. Default: `10`
ipa_user string	Административная учетная запись, используемая на сервере IPA. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `IPA_USER`. Если и переменная среды `IPA_USER` и значение не указаны в задаче, то устанавливается значение по умолчанию. Default: `"admin"`
krbpasswordexpiration string	Дата истечения срока действия пароля пользователя. В формате YYYYMMddHHmmss. Например, 20180121182022 истечет 21 января 2018 года в 18:20:22.
loginshell string	Входная оболочка.
mail list / elements=string	Список адресов электронной почты, назначенных пользователю. Если передается пустой список, все назначенные адреса электронной почты будут удалены. Если передается None, адреса электронной почты не будут проверяться или изменяться.
password string	Пароль для пользователя. Не будет установлен для существующего пользователя, если только `update_password=always`, что является значением по умолчанию.
sn string	Фамилия. Если пользователь не существует и `state=present`, необходимо использовать `sn`.
sshpubkey list / elements=string	Список открытых ключей SSH. Если передается пустой список, все назначенные открытые ключи будут удалены. Если передается None, открытые ключи SSH не будут проверяться или изменяться.
state string	Состояние, которое необходимо обеспечить. Варианты: `"absent"` `"disabled"` `"enabled"` `"present"` ← (default)
telephonenumber list / elements=string	Список номеров телефонов, назначенных пользователю. Если передается пустой список, все назначенные номера телефонов будут удалены. Если передается None, номера телефонов не будут проверяться или изменяться.

Название строка	Название.
uid псевдонимы: имя строка / обязательно	uid пользователя.
uidnumber строка	Номер UID/ID пользователя POSIX.
update_password строка	Установить пароль для пользователя. Варианты: `"always"` ← (по умолчанию) `"on_create"`
userauthtype список / элементы=строка добавлен в community.general 1.2.0	Тип аутентификации для пользователя. Чтобы удалить все типы аутентификации от пользователя, используйте пустой список `[]`. Выбор `idp` и `passkey` добавлен в community.general 8.1.0. Варианты: `"password"` `"radius"` `"otp"` `"pkinit"` `"hardened"` `"idp"` `"passkey"`
validate_certs булево	Это применимо только если `ipa_prot` `https`. Если установлено `false`, сертификаты SSL не будут проверены. Это следует устанавливать только в `false` на сайтах с личной настройкой и использованием самозаверяемых сертификатов. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в `check_mode` и возвращать прогноз изменённого статуса без изменения целевого объекта.
diff_mode	Поддержка: нет	Возвращает подробности о том, что изменилось (или, возможно, должно быть изменено в `check_mode`), когда режим diff активен.

Примеры

- 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 and RADIUS authentication
  community.general.ipa_user:
    name: pinky
    state: present
    userauthtype:
      - otp
      - radius
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

Значения возврата

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

Ключ	Описание
пользователь словарь	Пользователь, возвращённый API IPA Возвращаемое значение: всегда

Авторы

Thomas Krahn (@Nosmoht)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ipa_user_module.html