theforeman.foreman.auth_source_ldap модуль — Управление источниками аутентификации LDAP
Примечание
Этот модуль является частью коллекции theforeman.foreman (версия 4.2.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 для использования при поиске. |
groups_base string | Базовое DN, где находятся группы. |
host string / required | Имя хоста LDAP-сервера |
ldap_filter string | Фильтр для применения к LDAP-поиску |
locations list / elements=string | Список местоположений, к которым следует назначить сущность |
name string / required | Имя источника LDAP-аутентификации |
onthefly_register boolean | Регистрировать ли пользователей на лету. Варианты:
|
organizations list / elements=string | Список организаций, к которым следует назначить сущность |
password string / required | Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
port integer | Номер порта LDAP-сервера По умолчанию: |
server_type string | Тип LDAP-сервера Варианты:
|
server_url string / required | URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
state string | Состояние сущности Варианты:
|
tls boolean | Использовать ли TLS при обращении к LDAP-серверу. Варианты:
|
use_netgroups boolean | Использовать ли NIS netgroups вместо групп posix, недействительно для server_type=active_directory Варианты:
|
usergroup_sync boolean | Синхронизировать ли внешние группы пользователей при входе Варианты:
|
логин строка / обязательно | Логин для доступа к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения |
validate_certs логический тип | Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Может работать в режиме check_mode и возвращать прогноз изменений состояния без модификации сущности |
diff_mode | Поддержка: полная | Возвращает детали изменений (или, возможно, необходимости изменений в режиме check_mode) в режиме diff |
Примеры
- 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 словарь | Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращено: успех |
|
auth_source_ldaps список / элементы=словарь |
Список источников авторизации для LDAP. Возвращено: успех |
Ссылки на коллекцию
© 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/theforeman/foreman/auth_source_ldap_module.html