GET /api/hostgroups
Список всех групп узлов

GET /api/puppetclasses/:puppetclass_id/hostgroups
Список всех групп для класса Puppet

GET /api/locations/:location_id/hostgroups
Список всех групп по местоположениям

GET /api/organizations/:organization_id/hostgroups
Список всех групп по организациям

Параметры

Имя параметра Описание
puppetclass_id
необязательно

Код класса Puppet

Validations:

  • Must be a String

location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

отсортировать результаты

Validations:

  • Must be a String

page
необязательно

постраничный вывод

Validations:

  • Must be a String

per_page
необязательно

количество записей на запрос

Validations:

  • Must be a String

include
необязательно

Array of extra information types to include

Validations:

  • Must be an array of [“parameters”]


GET /api/hostgroups/:id
Показать группу узлов

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

show_hidden_parameters
необязательно

Display hidden parameter values

Validations:

  • Must be one of: true, false, 1, 0


POST /api/hostgroups
Создать группу узлов

Параметры

Имя параметра Описание
hostgroup
обязательно

Validations:

  • Must be a Hash

hostgroup[name]
обязательно

Имя группы узлов

Validations:

  • Must be a String

hostgroup[description]
необязательно , nil разрешен

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
необязательно , nil разрешен

Родительский код для группы узлов

Validations:

  • Must be a number.

hostgroup[environment_id]
необязательно , nil разрешен

Код окружения

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
необязательно , nil разрешен

Код вычислительного профиля

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
необязательно , nil разрешен

Код операционной системы

Validations:

  • Must be a number.

hostgroup[architecture_id]
необязательно , nil разрешен

Код архитектуры

Validations:

  • Must be a number.

hostgroup[pxe_loader]
необязательно , nil разрешен

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
необязательно , nil разрешен

Код носителя

Validations:

  • Must be a number.

hostgroup[ptable_id]
необязательно , nil разрешен

Код таблицы разделов

Validations:

  • Must be a number.

hostgroup[subnet_id]
необязательно , nil разрешен

Код подсети

Validations:

  • Must be a number.

hostgroup[domain_id]
необязательно , nil разрешен

Код домена

Validations:

  • Must be a number.

hostgroup[realm_id]
необязательно , nil разрешен

Код области

Validations:

  • Must be a number.

hostgroup[config_group_ids]
необязательно , nil разрешен

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
необязательно , nil разрешен

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
обязательно

Название параметра

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
обязательно

Значение параметра

Validations:

  • Must be a String

hostgroup[puppet_proxy_id]
необязательно , nil разрешен

Идентификатор прокси Puppet

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
необязательно , nil разрешен

Идентификатор прокси Puppet CA

Validations:

  • Must be a number.

hostgroup[root_pass]
необязательно , nil разрешен

Пароль root на подготавливаемых узлах

Validations:

  • Must be a String

hostgroup[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


PUT /api/hostgroups/:id
Изменить группу узлов

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

hostgroup
обязательно

Validations:

  • Must be a Hash

hostgroup[name]
необязательно

Имя группы узлов

Validations:

  • Must be a String

hostgroup[description]
необязательно , nil разрешен

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
необязательно , nil разрешен

Родительский код для группы узлов

Validations:

  • Must be a number.

hostgroup[environment_id]
необязательно , nil разрешен

Код окружения

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
необязательно , nil разрешен

Код вычислительного профиля

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
необязательно , nil разрешен

Код операционной системы

Validations:

  • Must be a number.

hostgroup[architecture_id]
необязательно , nil разрешен

Код архитектуры

Validations:

  • Must be a number.

hostgroup[pxe_loader]
необязательно , nil разрешен

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
необязательно , nil разрешен

Код носителя

Validations:

  • Must be a number.

hostgroup[ptable_id]
необязательно , nil разрешен

Код таблицы разделов

Validations:

  • Must be a number.

hostgroup[subnet_id]
необязательно , nil разрешен

Код подсети

Validations:

  • Must be a number.

hostgroup[domain_id]
необязательно , nil разрешен

Код домена

Validations:

  • Must be a number.

hostgroup[realm_id]
необязательно , nil разрешен

Код области

Validations:

  • Must be a number.

hostgroup[config_group_ids]
необязательно , nil разрешен

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
необязательно , nil разрешен

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
необязательно

Название параметра

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
необязательно

Значение параметра

Validations:

  • Must be a String

hostgroup[puppet_proxy_id]
необязательно , nil разрешен

Идентификатор прокси Puppet

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
необязательно , nil разрешен

Идентификатор прокси Puppet CA

Validations:

  • Must be a number.

hostgroup[root_pass]
необязательно , nil разрешен

Пароль root на подготавливаемых узлах

Validations:

  • Must be a String

hostgroup[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


DELETE /api/hostgroups/:id
Удалить группу узлов

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/hostgroups/:id/clone
Клонировать группу узлов

Параметры

Имя параметра Описание
name
обязательно

Validations:

  • Must be a String


PUT /api/hostgroups/:id/rebuild_config
Пересобрать конфигурацию оркестратора

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

only
необязательно

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type

children_hosts
необязательно

Operate on child hostgroup hosts

Validations:

  • Must be one of: true, false, 1, 0