Модуль theforeman.foreman.host_collection — управление коллекциями хостов
Примечание
Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.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
Параметры
Параметр | Комментарии |
|---|---|
ca_path path | Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
description string | Описание коллекции хостов |
name string / обязательный | Название коллекции хостов |
oauth1_consumer_key string | Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
oauth1_consumer_secret string | Секретный ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
organization string / обязательный | Организация, к которой относится объект |
password string | Пароль пользователя, который обращается к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
server_url string / обязательный | URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
state string | Состояние объекта Варианты:
|
updated_name string | Новое название коллекции хостов. Если задан этот параметр, модуль не будет идемпотентным. |
use_gssapi boolean | Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos через аутентификацию Negotiate. Требуется установленная библиотека Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
username string | Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
validate_certs boolean | Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
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 dictionary | Итоговое состояние затронутых объектов, сгруппированных по типу. Возвращается: при успешном выполнении |
|
host_collections list / элементы=dictionary |
Список коллекций хостов. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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/host_collection_module.html
