Модуль theforeman.foreman.host_collection – Управление коллекциями хостов

Примечание

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

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

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

Для использования в книге задач укажите: theforeman.foreman.host_collection.

Новинка в theforeman.foreman 1.0.0

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

Описание

Создание и управление коллекциями хостов

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

Требования

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

requests

Параметры

Параметр	Комментарии
description строка	Описание коллекции хостов
name строка / обязательно	Имя коллекции хостов
organization строка / обязательно	Организация, к которой относится сущность
password строка / обязательно	Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_PASSWORD`.
server_url строка / обязательно	URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
state строка	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
updated_name строка	Новое имя коллекции хостов. При установке этого параметра модуль не будет идемпотентным.
username строка / обязательно	Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs логический	Подтверждать ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: "Create Foo host collection"
  theforeman.foreman.host_collection:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Foo"
    description: "Foo host collection for Foo servers"
    organization: "My Cool new Organization"
    state: present

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

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

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

Авторы

Maxim Burgerhout (@wzzrd)
Christoffer Reijer (@ephracis)

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

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