Модуль theforeman.foreman.hostgroup — управление группами хостов

Примечание

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

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

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

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

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

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

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

Создание, обновление и удаление групп хостов

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

Требования

Следующие компоненты должны быть установлены на хосте, выполняющем этот модуль.

requests

Параметры

Параметр	Комментарии
activation_keys string	Ключи активации, используемые для развёртывания. Список значений, разделённых запятыми. Доступно только для установок Katello.
ansible_roles list / elements=string добавлено в theforeman.foreman 2.1.0	Список ролей Ansible, связанных с группой хостов. Для использования этого параметра необходимо установить плагин foreman-ansible.
architecture string	Название архитектуры
ca_path path	Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_CA_PATH`.
compute_profile string	Название вычислительного профиля
compute_resource string	Название вычислительного ресурса
config_groups list / elements=string	Список групп конфигурации
content_source string	Название источника содержимого (Smart Proxy с содержимым). Доступно только для установок Katello.
content_view string	Представление содержимого. Доступно только для установок Katello.
description string	Описание группы хостов
domain string	Название домена
environment string	Название среды Puppet
kickstart_repository string	Название репозитория Kickstart. Этот параметр необходимо указать, чтобы использовать функцию «Синхронизированное содержимое». Не может использоваться одновременно с medium. Доступно только для установок Katello.
lifecycle_environment string	Среда жизненного цикла. Доступно только для установок Katello.
locations list / elements=string	Список расположений, которым должна быть назначена сущность
medium псевдонимы: media string	Название носителя Не может использоваться одновременно с kickstart_repository.
name string / обязательный	Название группы хостов
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
openscap_proxy string	Название прокси OpenSCAP. Доступно только при установленном плагине OpenSCAP.
operatingsystem string	Операционные системы выбираются по заголовку, сформированному по шаблону «<name> <major>.<minor>». Версию можно не указывать, если существует только одна операционная система с таким названием.
organization string	Организация для ресурсов с заданной областью действия, связанных с группой хостов. Используется только для установок Katello. При необходимости эта организация будет неявно добавлена в параметр organizations.
organizations list / elements=string	Список организаций, которым должна быть назначена сущность
parameters list / elements=dictionary	Параметры узла, относящиеся к группе хостов
hidden_value boolean	Следует ли скрыть значение Варианты: `false` `true`
name string / обязательный	Название параметра
parameter_type string	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value any / обязательный	Значение параметра
parent string	Заголовок родительской группы хостов. Можно указать вложенную группу в формате «Основная группа/Подгруппа».
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
ptable string	Название таблицы разделов
puppet_ca_proxy string	Название прокси центра сертификации Puppet
puppet_proxy string	Название прокси-сервера Puppet
puppetclasses list / elements=string	Список классов Puppet, включаемых в эту группу хостов. Они должны существовать в среде Puppet этой группы хостов.
pxe_loader string	Загрузчик PXE Варианты: `"PXELinux BIOS"` `"PXELinux UEFI"` `"Grub UEFI"` `"Grub2 BIOS"` `"Grub2 ELF"` `"Grub2 UEFI"` `"Grub2 UEFI SecureBoot"` `"Grub2 UEFI HTTP"` `"Grub2 UEFI HTTPS"` `"Grub2 UEFI HTTPS SecureBoot"` `"iPXE Embedded"` `"iPXE UEFI HTTP"` `"iPXE Chain BIOS"` `"iPXE Chain UEFI"` `"None"`
realm string	Название области (realm)
root_pass string	Пароль root. Сущность будет обновляться при каждом запуске, так как текущий пароль невозможно получить.
server_url string / обязательный	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
subnet string	Название подсети IPv4
subnet6 string	Название подсети IPv6
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: "Create a Hostgroup"
  theforeman.foreman.hostgroup:
    name: "new_hostgroup"
    architecture: "architecture_name"
    operatingsystem: "operatingsystem_name"
    medium: "media_name"
    ptable: "Partition_table_name"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: "Update a Hostgroup"
  theforeman.foreman.hostgroup:
    name: "new_hostgroup"
    architecture: "updated_architecture_name"
    operatingsystem: "updated_operatingsystem_name"
    organizations:
      - Org One
      - Org Two
    locations:
      - Loc One
      - Loc Two
      - Loc One/Nested loc
    medium: "updated_media_name"
    ptable: "updated_Partition_table_name"
    root_pass: "password"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: "My nested hostgroup"
  theforeman.foreman.hostgroup:
    parent: "new_hostgroup"
    name: "my nested hostgroup"

- name: "My hostgroup with some proxies"
  theforeman.foreman.hostgroup:
    name: "my hostgroup"
    environment: production
    puppet_proxy: puppet-proxy.example.com
    puppet_ca_proxy: puppet-proxy.example.com
    openscap_proxy: openscap-proxy.example.com

- name: "My katello related hostgroup"
  theforeman.foreman.hostgroup:
    organization: "My Org"
    name: "kt hostgroup"
    content_source: capsule.example.com
    lifecycle_environment: "Production"
    content_view: "My content view"
    activation_keys: "my_prod_ak"

- name: "Delete a Hostgroup"
  theforeman.foreman.hostgroup:
    name: "new_hostgroup"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: absent

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

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

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

Авторы

Manisha Singhal (@Manisha15) ATIX AG
Baptiste Agasse (@bagasse)

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

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