Модуль theforeman.foreman.domain — управление доменами

Примечание

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

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

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

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

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

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

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

Создание, обновление и удаление доменов

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

Требования

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

requests

Параметры

Параметр	Комментарии
ca_path path	Файл в формате PEM, содержащий сертификат ЦС, который будет использоваться для проверки. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_CA_PATH`.
description псевдонимы: fullname string	Полное описание домена
dns_proxy псевдонимы: dns string	Прокси-сервер DNS, используемый в этом домене для управления записями A
locations list / элементы=string	Список местоположений, которым следует назначить сущность
name string / обязательный	Полное доменное имя DNS
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секретный ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organizations list / элементы=string	Список организаций, которым следует назначить сущность
parameters list / элементы=dictionary	Параметры хоста, относящиеся к домену
hidden_value boolean	Следует ли скрыть значение Варианты: `false` `true`
name string / обязательный	Имя параметра
parameter_type string	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value any / обязательный	Значение параметра
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_PASSWORD`.
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `FOREMAN_SERVER_URL`.
state string	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
updated_name string	Новое имя домена. Если задан этот параметр, модуль не будет идемпотентным.
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: domain
  theforeman.foreman.domain:
    name: "example.org"
    description: "Example Domain"
    locations:
      - "Munich"
    organizations:
      - "ACME"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

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

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

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

Авторы

Markus Bucher (@m-bucher) ATIX AG

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

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