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

Примечание

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
activation_keys строка	Ключи активации, используемые для развертывания. Список, разделённый запятыми. Доступен только для установок Katello.
ansible_roles список / элементы=строка добавлен в theforeman.foreman 2.1.0	Список ролей Ansible, которые необходимо связать с группой хостов. Для использования этого параметра необходимо установить плагин foreman-ansible.
architecture строка	Название архитектуры
compute_profile строка	Имя профиля вычислений
compute_resource строка	Имя вычислительного ресурса
config_groups список / элементы=строка	Список групп конфигурации
content_source строка	Имя источника контента (умный прокси с контентом). Доступен только для установок Katello.
content_view строка	Представление контента. Доступен только для установок Katello.
description строка	Описание группы хостов
domain строка	Имя домена
environment строка	Имя среды Puppet
kickstart_repository строка	Имя репозитория kickstart. Необходимо для использования функции «Синхронизированный контент». Исключительно с параметром medium. Доступен только для установок Katello.
lifecycle_environment строка	Среда жизненного цикла. Доступен только для установок Katello.
locations список / элементы=строка	Список локаций, к которым должна быть привязана сущность
medium псевдонимы: media строка	Имя носителя Исключительно с параметром kickstart_repository.
name строка / обязательно	Имя группы хостов
openscap_proxy строка	Имя прокси OpenSCAP. Доступен только при установке плагина OpenSCAP.
operatingsystem строка	Операционные системы находятся по их названию, которое состоит из «<имя> <major>.<minor>». Можно опустить версию, если у вас только одна операционная система с таким именем.
organization строка	Организация для привязанных к группе хостов ресурсов. Используется только для установок Katello. Эта организация неявно добавляется в параметр organizations при необходимости.
organizations список / элементы=строка	Список организаций, к которым должна быть привязана сущность
parameters список / элементы=словарь	Параметры хоста, специфичные для группы хостов
name строка / обязательно	Имя параметра
parameter_type строка	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value любой / обязательно	Значение параметра

parent string	Родительская группа хостов
password string / обязательно	Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
ptable string	Имя таблицы разделов
puppet_ca_proxy string	Имя прокси-сервера Puppet CA
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	Имя домена
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	Новое имя группы хостов. При установке этого параметра модуль не будет идемпотентным.
username string / обязательно	Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения `FOREMAN_USERNAME`.
validate_certs boolean	Подтверждать ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- 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"
    parameters:
      - name: "kt_activation_keys"
        value: "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 словарь	Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращено: успех
hostgroups список / элементы=словарь	Список hostgroups. Возвращено: успех

Авторы

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

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

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