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

Примечание

Этот плагин входит в состав коллекции theforeman.foreman (версия 1.5.1).

Для его установки используйте: ansible-galaxy collection install theforeman.foreman.

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

Новое в версии 1.0.0: of theforeman.foreman

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

Описание

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

Требования

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

requests

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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 строка			Имя носителя Взаимоисключающий с параметром kickstart_repository. псевдонимы: media
name строка / обязательно			Имя группы хостов
openscap_proxy строка			Имя прокси OpenSCAP. Доступно только при установке плагина OpenSCAP.
operatingsystem строка			Операционные системы ищутся по их названию, которое состоит из «<name> <major>.<minor>». Вы можете опустить часть версии, если у вас есть только одна операционная система с таким именем.
organization строка			Организация для ресурсов, ограниченных по области, прикрепленных к группе хостов. Используется только для установок Katello. Эта организация неявно добавится к параметру organizations, если это необходимо.
organizations список / элементы=строка			Список организаций, которым должна быть назначена сущность
parameters список / элементы=словарь			Параметры хостов, специфичные для группы хостов
	name строка / обязательно		Имя параметра
	parameter_type строка	Варианты: string ← boolean integer real array hash yaml json	Тип параметра
	value сырой / обязательно		Значение параметра
parent строка			Имя родительской группы хостов
password строка / обязательно			Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_PASSWORD`.
ptable строка			Имя таблицы разбиения
puppet_ca_proxy строка			Имя прокси Puppet CA
puppet_proxy строка			Имя прокси-сервера Puppet
puppetclasses список / элементы=строка			Список классов Puppet, которые следует включить в эту группу хостов. Должен существовать для среды Puppet группы хостов.
pxe_loader строка		Варианты: 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	Загрузчик PXE
realm строка			Имя домена
root_pass строка			Пароль root. Приведёт к обновлению сущности всегда, так как текущий пароль получить нельзя.
server_url строка / обязательно			URL сервера Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_SERVER_URL`.
state строка		Варианты: present ← absent	Состояние сущности
subnet строка			Имя подсети IPv4
subnet6 строка			Имя подсети IPv6
updated_name строка			Новое имя группы хостов. При установке этого параметра модуль не будет идемпотентным.
username строка / обязательно			Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_USERNAME`.
validate_certs boolean		Варианты: no yes ←	Требуется ли проверка сертификатов TLS сервера Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_VALIDATE_CERTS`.

Примеры

- 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 список / элементы=словарь	успех	Список групп хостов.

Авторы

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/theforeman/foreman/hostgroup_module.html