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

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.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

Параметры

Параметр	Комментарии
описание псевдонимы: полное_имя строка	Полное имя, описывающее домен
dns_proxy псевдонимы: dns строка	DNS-прокси для использования в этом домене для управления записями A
locations список / элементы=строка	Список местоположений, к которым должна быть назначена сущность
имя строка / обязательно	Полное имя DNS-домена
organizations список / элементы=строка	Список организаций, которым должна быть назначена сущность
parameters список / элементы=словарь	Параметры хоста, специфичные для домена
имя строка / обязательно	Имя параметра
тип_параметра строка	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
значение любое / обязательно	Значение параметра
пароль строка / обязательно	Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
url_сервера строка / обязательно	URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
состояние строка	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
обновлённое_имя строка	Новое имя домена. При установке этого параметра модуль не будет идемпотентным.
имя_пользователя строка / обязательно	Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения `FOREMAN_USERNAME`.
validate_certs логическое	Проверка сертификатов 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 словарь	Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращаемое значение: успех
domains список / элементы=словарь	Список доменов. Возвращаемое значение: успех

Авторы

Markus Bucher (@m-bucher) ATIX AG

Ссылки на сборку

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