Модуль theforeman.foreman.organization – Управление организациями

Примечание

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

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

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

Для использования в плейбуке укажите: theforeman.foreman.organization.

Новое в theforeman.foreman 1.0.0

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

Обзор

Управление организациями

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

Требования

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

requests

Параметры

Параметр	Комментарии
description строка	Описание организации
ignore_types псевдонимы: select_all_types список / элементы=строка добавлено в theforeman.foreman 3.8.0	Список типов ресурсов, которые будут автоматически ассоциированы
label строка	Метка организации
name строка / обязательно	Имя организации
parameters список / элементы=словарь	Параметры хоста, специфичные для домена сущности
name строка / обязательно	Имя параметра
parameter_type строка	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value любой / обязательно	Значение параметра
password строка / обязательно	Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_PASSWORD`.
server_url строка / обязательно	URL сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_SERVER_URL`.
state строка	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
username строка / обязательно	Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_USERNAME`.
validate_certs логическое	Выполнять ли проверку сертификатов TLS сервера Foreman. Если значение не указано в задаче, вместо него используется значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: "Create CI Organization"
  theforeman.foreman.organization:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My Cool New Organization"
    state: present

Значения возврата

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

Ключ	Описание
entity словарь	Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращено: success
organizations список / элементы=словарь	Список организаций. Возвращено: success

Авторы

Eric D Helms (@ehelms)
Matthias M Dellweg (@mdellweg) 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/organization_module.html