Spec-Zone.ru › Ansible 2.8

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

Новая версия 2.3.

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

Обзор

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

Требования

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

  • base64
  • hashlib

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
displayname
-
Имя для отображения
gidnumber
-
добавлен в 2.5
Идентификатор группы Posix
givenname
-
Имя
ipa_host
строка
По умолчанию:
"ipa.example.com"
IP-адрес или имя хоста сервера IPA.
Если значение не указано в задаче, используется значение переменной окружения IPA_HOST.
Если ни переменная окружения IPA_HOST, ни значение не указаны в задаче, то DNS будет использоваться для поиска сервера FreeIPA.
Необходимая запись в 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
целое число
добавлен в 2.7
По умолчанию:
10
Устанавливает таймаут бездействия (в секундах) для соединения.
Для массовых операций может потребоваться увеличить это значение, чтобы избежать таймаута от сервера IPA.
Если значение не указано в задаче, используется значение переменной окружения IPA_TIMEOUT.
Если ни переменная окружения IPA_TIMEOUT, ни значение не указаны в задаче, то используется значение по умолчанию.
ipa_user
строка
По умолчанию:
"admin"
Административная учетная запись, используемая на сервере IPA.
Если значение не указано в задаче, используется значение переменной окружения IPA_USER.
Если ни переменная окружения IPA_USER, ни значение не указаны в задаче, то используется значение по умолчанию.
Функция обратного вызова для переменных окружения добавлена в Ansible 2.5.
krbpasswordexpiration
-
добавлен в 2.5
Дата истечения срока действия пароля пользователя.
В формате YYYYMMddHHmmss
Например, 20180121182022 истечет 21 января 2018 года в 18:20:22
loginshell
-
Оболочка входа
mail
-
Список адресов электронной почты, назначенных пользователю.
Если передается пустой список, все назначенные адреса электронной почты будут удалены.
Если передается None, адреса электронной почты не будут проверяться или изменятся.
password
-
Пароль пользователя. Не будет установлен для существующего пользователя, если update_password не установлено на always, что является значением по умолчанию.
sn
-
Фамилия
sshpubkey
-
Список открытых ключей SSH.
Если передается пустой список, все назначенные открытые ключи будут удалены.
Если передается None, открытые ключи SSH не будут проверяться или изменятся.
state
-
    Варианты:
  • present ←
  • absent
  • enabled
  • disabled
Состояние, которое должно быть обеспечено
telephonenumber
-
Список телефонных номеров, назначенных пользователю.
Если передается пустой список, все назначенные телефонные номера будут удалены.
Если передается None, телефонные номера не будут проверяться или изменятся.
title
-
Должность
uid
- / обязательно
Идентификатор пользователя (uid)

Псевдонимы: name
uidnumber
-
добавлен в 2.5
Идентификатор пользователя (uid)/номер пользователя Posix
update_password
строка
добавлен в 2.8
    Варианты:
  • всегда ←
  • при создании
Установка пароля для пользователя.
validate_certs
булево
    Варианты:
  • нет
  • да ←
Это относится только к тому случаю, если ipa_prot равно https.
Если установлено в no, сертификаты SSL не будут проверены.
Это следует устанавливать в no только для сайтов с собственными самозаверяющими сертификатами.

Примеры

# Ensure pinky is present and always reset password
- 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
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

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

# Ensure pinky is present but don't reset password if already exists
- 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

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

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

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



Статус

  • Этот модуль не гарантирует обратной совместимости. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Thomas Krahn (@Nosmoht)
END_OF_DOCUMENT_MARKER

Подсказка

Если вы заметили какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ipa_user_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API