theforeman.foreman.auth_source_ldap module – Управление источниками аутентификации LDAP

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.auth_source_ldap.

Добавлено в theforeman.foreman 1.0.0

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

Краткое описание

Создание, обновление и удаление источников аутентификации LDAP

Псевдонимы: foreman_auth_source_ldap

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

requests

Параметры

Параметр	Комментарии
account string	Имя учетной записи для доступа к серверу LDAP.
account_password string	Пароль учетной записи для доступа к серверу LDAP. Обязателен при использовании onthefly_register. Если задан этот параметр, модуль не будет идемпотентным.
attr_firstname string	Атрибут, содержащий имя. Обязателен при использовании onthefly_register.
attr_lastname string	Атрибут, содержащий фамилию. Обязателен при использовании onthefly_register.
attr_login string	Атрибут, содержащий идентификатор для входа. Обязателен при использовании onthefly_register.
attr_mail string	Атрибут, содержащий адрес электронной почты. Обязателен при использовании onthefly_register.
attr_photo string	Атрибут, содержащий фотографию пользователя
base_dn string	Базовый DN для поиска.
ca_path path	Файл в формате PEM, содержащий сертификат ЦС для проверки. Если значение не задано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_CA_PATH`.
groups_base string	Базовый DN, в котором находятся группы.
host string / обязательный	Имя узла сервера LDAP
ldap_filter string	Фильтр для LDAP-поиска
ldap_group_membership string	Метод определения членства в группах; недопустим для server_type=active_directory. Параметр rfc4519 допустим только для server_type=posix. Варианты: `"posix"` `"nis_netgroups"` `"rfc4519"`
locations list / elements=string	Список местоположений, которым должна быть назначена сущность
name string / обязательный	Имя источника аутентификации LDAP
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не задано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не задано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
onthefly_register boolean	Определяет, следует ли регистрировать пользователей автоматически при входе. Варианты: `false` `true`
organizations list / elements=string	Список организаций, которым должна быть назначена сущность
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не задано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_PASSWORD`.
port integer	Номер порта сервера LDAP По умолчанию: `389`
server_type string	Тип сервера LDAP Варианты: `"free_ipa"` `"active_directory"` `"posix"`
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не задано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
tls boolean	Определяет, следует ли использовать TLS при подключении к серверу LDAP. Варианты: `false` `true`
use_gssapi boolean	Использовать GSSAPI для аутентификации; обычно он применяется для Kerberos или Kerberos с аутентификацией Negotiate. Требуется установленная библиотека Python requests-gssapi. Если значение не задано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
use_netgroups boolean	Использовать сетевые группы NIS вместо групп POSIX; недопустимо для server_type=active_directory Устарело: параметр use_netgroups объявлен устаревшим в Foreman 3.16 в пользу ldap_group_membership и будет удален в одном из будущих выпусков. Варианты: `false` `true`
usergroup_sync boolean	Определяет, следует ли синхронизировать внешние группы пользователей при входе Варианты: `false` `true`
username string	Имя пользователя для доступа к серверу Foreman. Если значение не задано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_USERNAME`.
validate_certs boolean	Определяет, следует ли проверять сертификаты TLS сервера Foreman. Если значение не задано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Simple FreeIPA authentication source
  theforeman.foreman.auth_source_ldap:
    name: "Example LDAP"
    host: "ldap.example.org"
    server_url: "https://foreman.example.com"
    locations:
      - "Uppsala"
    organizations:
      - "Sweden"
    username: "admin"
    password: "changeme"
    state: present

- name: FreeIPA with automatic registration
  theforeman.foreman.auth_source_ldap:
    name: "Example LDAP"
    host: "ldap.example.org"
    onthefly_register: true
    account: uid=ansible,cn=sysaccounts,cn=etc,dc=example,dc=com
    account_password: secret
    base_dn: dc=example,dc=com
    groups_base: cn=groups,cn=accounts, dc=example,dc=com
    server_type: free_ipa
    attr_login: uid
    attr_firstname: givenName
    attr_lastname: sn
    attr_mail: mail
    attr_photo: jpegPhoto
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: Active Directory with automatic registration
  theforeman.foreman.auth_source_ldap:
    name: "Example AD"
    host: "ad.example.org"
    onthefly_register: true
    account: EXAMPLE\ansible
    account_password: secret
    base_dn: cn=Users,dc=example,dc=com
    groups_base: cn=Users,dc=example,dc=com
    server_type: active_directory
    attr_login: sAMAccountName
    attr_firstname: givenName
    attr_lastname: sn
    attr_mail: mail
    ldap_filter: (memberOf=CN=Domain Users,CN=Users,DC=example,DC=com)
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

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

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

Ключ	Описание
entity dictionary	Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успешном выполнении
auth_source_ldaps list / elements=dictionary	Список источников аутентификации LDAP. Возвращается: при успешном выполнении

Авторы

Christoffer Reijer (@ephracis) Basalt AB

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/theforeman/foreman/auth_source_ldap_module.html