модуль theforeman.foreman.realm — управление областями

Примечание

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

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

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

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

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

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

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

Управление областями

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

Требования

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

requests

Параметры

Параметр	Комментарии
ca_path path	Файл в формате PEM, содержащий сертификат центра сертификации для проверки. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_CA_PATH`.
locations list / elements=string	Список местоположений, которым должна быть назначена сущность
name string / обязательный	Имя области
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секретный ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organizations list / elements=string	Список организаций, которым должна быть назначена сущность
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_PASSWORD`.
realm_proxy string / обязательный	Прокси-сервер для этой области
realm_type string / обязательный	Тип области Варианты: `"Red Hat Identity Management"` `"FreeIPA"` `"Active Directory"`
server_url string / обязательный	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
use_gssapi boolean	Использовать GSSAPI для аутентификации; обычно это применяется для Kerberos или Kerberos через аутентификацию Negotiate. Требуется установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_USE_GSSAPI`. Варианты: `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: "Create EXAMPLE.LOCAL Realm"
  theforeman.foreman.realm:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "EXAMPLE.COM"
    realm_proxy: "foreman.example.com"
    realm_type: "Red Hat Identity Management"
    state: present

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

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

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

Авторы

Lester R Claudio (@claudiol1)

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

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