GET /api/hosts
List all hosts.

Параметры

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

Filter results

Validations:

  • Must be a String

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

Sort results

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String


GET /api/hosts/:id
Show a host.

Параметры

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

Validations:

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


POST /api/hosts
Create a host.

Параметры

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

Validations:

  • Must be a Hash

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

Validations:

  • Must be a String

host[location_id]
обязательно

требуется, если используется местоположение

Validations:

  • Must be a number.

host[organization_id]
обязательно

требуется, если используются организации

Validations:

  • Must be a number.

host[environment_id]
необязательно

требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов

Validations:

  • Must be a String

host[ip]
необязательно

IPv4 address

Validations:

  • Must be a String

host[ip6]
необязательно

IPv6 address

Validations:

  • Must be a String

host[mac]
необязательно

требуется для управления узлом на голом железе, не требуется для виртуальной машины

Validations:

  • Must be a String

host[architecture_id]
необязательно

требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов

Validations:

  • Must be a number.

host[domain_id]
необязательно

требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов

Validations:

  • Must be a number.

host[realm_id]
необязательно

Validations:

  • Must be a number.

host[puppet_proxy_id]
необязательно

Validations:

  • Must be a number.

host[puppetclass_ids]
необязательно

Validations:

  • Must be an array of any type

host[operatingsystem_id]
необязательно

требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов

Validations:

  • Must be a String

host[medium_id]
необязательно

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

Validations:

  • Must be a String

host[pxe_loader]
необязательно

DHCP filename option

Validations:

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

host[ptable_id]
необязательно

требуется, если узел находится под управлением, но собственный раздел не был объявлен

Validations:

  • Must be a number.

host[subnet_id]
необязательно

IPv4 subnet

Validations:

  • Must be a number.

host[subnet6_id]
необязательно

IPv6 subnet

Validations:

  • Must be a number.

host[compute_resource_id]
необязательно

ноль обозначает узел на голом железе

Validations:

  • Must be a number.

host[root_pass]
необязательно

требуется, если узел управляется и значение не унаследовано из группы узлов или не задан пароль по умолчанию в настройках

Validations:

  • Must be a String

host[model_id]
необязательно

Validations:

  • Must be a number.

host[hostgroup_id]
необязательно

Validations:

  • Must be a number.

host[owner_id]
необязательно

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
необязательно

Validations:

  • Must be a number.

host[image_id]
необязательно

Validations:

  • Must be a number.

host[host_parameters_attributes]
необязательно

Параметры узла (массив или индексированный хэш)

Validations:

  • Must be an Array of nested elements

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

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

Validations:

  • Must be a String

host[host_parameters_attributes][value]
обязательно

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

Validations:

  • Must be a String

host[build]
необязательно

Validations:

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

host[enabled]
необязательно

Validations:

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

host[provision_method]
необязательно

Validations:

  • Must be a String

host[managed]
необязательно

Флаг True/False сообщает, является ли узел контролируемым. Кроме того, в зависимости от этого значения может потребоваться настроить дополнительные параметры.

Validations:

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

host[progress_report_id]
необязательно

UUID для отслеживания состояния задач оркестрации, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
необязательно

Дополнительная информация об этом узле

Validations:

  • Must be a String

host[capabilities]
необязательно

Validations:

  • Must be a String

host[compute_profile_id]
необязательно

Validations:

  • Must be a number.

host[compute_attributes]
необязательно

Validations:

  • Must be a Hash


PUT /api/hosts/:id
Update a host.

Параметры

Имя параметра Описание
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.

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

Validations:

  • Must be a Hash

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

Validations:

  • Must be a String

host[environment_id]
необязательно

Validations:

  • Must be a String

host[ip]
необязательно

IPv4 address, not required if using a subnet with dhcp proxy

Validations:

  • Must be a String

host[ip6]
необязательно

IPv6 address

Validations:

  • Must be a String

host[mac]
необязательно

not required if its a virtual machine

Validations:

  • Must be a String

host[architecture_id]
необязательно

Validations:

  • Must be a number.

host[domain_id]
необязательно

Validations:

  • Must be a number.

host[puppet_proxy_id]
необязательно

Validations:

  • Must be a number.

host[operatingsystem_id]
необязательно

Validations:

  • Must be a String

host[puppetclass_ids]
необязательно

Validations:

  • Must be an array of any type

host[medium_id]
необязательно

Validations:

  • Must be a number.

host[ptable_id]
необязательно

Validations:

  • Must be a number.

host[subnet_id]
необязательно

IPv4 subnet

Validations:

  • Must be a number.

host[subnet6_id]
необязательно

IPv6 subnet

Validations:

  • Must be a number.

host[compute_resource_id]
необязательно

Validations:

  • Must be a number.

host[sp_subnet_id]
необязательно

Validations:

  • Must be a number.

host[model_id]
необязательно

Validations:

  • Must be a number.

host[hostgroup_id]
необязательно

Validations:

  • Must be a number.

host[owner_id]
необязательно

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
необязательно

Validations:

  • Must be a number.

host[image_id]
необязательно

Validations:

  • Must be a number.

host[host_parameters_attributes]
необязательно

Validations:

  • Must be an array of any type

host[build]
необязательно

Validations:

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

host[enabled]
необязательно

Validations:

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

host[provision_method]
необязательно

Validations:

  • Must be a String

host[managed]
необязательно

Validations:

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

host[progress_report_id]
необязательно

UUID для отслеживания состояния задач оркестрации, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[capabilities]
необязательно

Validations:

  • Must be a String

host[compute_attributes]
необязательно

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
Delete an host.

Параметры

Имя параметра Описание
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.


GET /api/hosts/:id/status
Получить состояние узла

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

Параметры

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

Validations:

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