GET /api/hosts
Список всех узлов

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

GET /api/locations/:location_id/hosts
Список узлов по местоположениям

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

GET /api/environments/:environment_id/hosts
Список узлов по окружениям

Params

Param Name Description
hostgroup_id
Optional

Код группы узлов


Value: Must be String
location_id
Optional

Код местоположения


Value: Must be String
organization_id
Optional

Код организации


Value: Must be String
environment_id
Optional

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


Value: Must be String
search
Optional

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


Value: Must be String
order
Optional

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


Value: Must be String
page
Optional

разместить результат на нескольких страницах


Value: Must be String
per_page
Optional

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


Value: Must be String

GET /api/hosts/:id
Показать узел

Params

Param Name Description
id
Required

Value: 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
Создать узел

Params

Param Name Description
host
Required

Value: Must be a Hash
host[name]
Required

Value: Must be String
host[environment_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[ip]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

не требуется, если используется подсеть с DHCP прокси


Value: Must be String
host[mac]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[architecture_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[domain_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[realm_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_class_ids]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[medium_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[ptable_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[root_pass]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[model_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[hostgroup_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[owner_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[owner_type]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Тип владельца узла


Value: Must be one of: User, Usergroup.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[image_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[host_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[build]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[enabled]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[managed]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Параметр Истина/Ложь указывает управляется узел или нет. Примечание: это значение также определяет, требуется ли несколько параметров или нет.


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

UUID для инструментального отслеживания состояния задания, GET /api/orchestration/:UUID/tasks


Value: Must be String
host[comment]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[capabilities]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[interfaces_attributes]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Сетевые интерфейсы узла.


Value: Must be an Array of nested elements
host[interfaces_attributes][mac]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

MAC адрес интерфейса. Требуется для управления интерфейсами на голом железе.


Value: Must be String
host[interfaces_attributes][ip]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

IP адрес интерфейса


Value: Must be String
host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Тип интерфейса, например bmc. По умолчанию interface


Value: Must be one of: interface, bmc, bond.
host[interfaces_attributes][name]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

DNS имя интерфейса


Value: Must be String
host[interfaces_attributes][subnet_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Код подсети Foreman для интерфейса


Value: Must be Fixnum
host[interfaces_attributes][domain_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Код домена Foreman для интерфейса. Требуется для первичного интерфейса на управляемых узлах.


Value: Must be Fixnum
host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Имя интерфейса, например eth0 или eth1.1


Value: Must be String
host[interfaces_attributes][managed]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Должен ли интерфейс управляться DHCP и DNS капсулем и должен ли он быть сконфигурирован во время подготовки?


Value: Must be 'true' or 'false'
host[interfaces_attributes][primary]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Должен ли интерфейс быть использован для построения FQDN имени узла? Каждый управляемый узел должен иметь один первичный интерфейс.


Value: Must be 'true' or 'false'
host[interfaces_attributes][provision]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Должен ли интерфейс быть использован для сетевой загрузки через TFTP (или SSH для основанных на образах узлах)? Каждый управляемый узел должен иметь один интерфейс для подготовки.


Value: Must be 'true' or 'false'
host[interfaces_attributes][username]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Только для интерфейсов BMC.


Value: Must be String
host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Только для интерфейсов BMC.


Value: Must be String
host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Поставщик интерфейса, например IPMI. Только для интерфейса BMC.


Value: Must be one of: IPMI.
host[interfaces_attributes][virtual]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Псевдоним или VLAN устройства.


Value: Must be 'true' or 'false'
host[interfaces_attributes][tag]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Метка VLAN, этот атрибут имеет приоритет над подсетью VLAN ID. Только для виртуальных интерфейсов.


Value: Must be String
host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Идентификатор интерфейса к которому принадлежит этот интерфейс, например eth1. Только для виртуальных интерфейсов.


Value: Must be String
host[interfaces_attributes][mode]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Режим агрегации интерфейсов, например балансировка “бегающий кролик”. Только для агрегированных интерфейсов.


Value: Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
host[interfaces_attributes][attached_devices]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Идентификатор подчиненного интерфейса, например [‘eth1’, ‘eth2’]. Только для агрегированных интерфейсов.


Value: Must be an array of any type
host[interfaces_attributes][bond_options]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Разделенные пробелами варианты, например miimon=100. Только для агрегированных интерфейсов.


Value: Must be String
host[interfaces_attributes][compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Дополнительные атрибуты вычислительного ресурса определенные для интерфейса.


Value: Must be Hash
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Специфичные дополнительные атрибута вычислительного ресурса.


Value: Must be Hash

PUT /api/hosts/:id
Изменить узел

Params

Param Name Description
id
Required

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

Value: Must be a Hash
host[name]
Optional

Value: Must be String
host[environment_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[ip]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

не требуется, если используется подсеть с DHCP прокси


Value: Must be String
host[mac]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[architecture_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[domain_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[realm_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_class_ids]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[medium_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[ptable_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[root_pass]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[model_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[hostgroup_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[owner_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[owner_type]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Тип владельца узла


Value: Must be one of: User, Usergroup.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[image_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[host_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[build]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[enabled]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[managed]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Параметр Истина/Ложь указывает управляется узел или нет. Примечание: это значение также определяет, требуется ли несколько параметров или нет.


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

UUID для инструментального отслеживания состояния задания, GET /api/orchestration/:UUID/tasks


Value: Must be String
host[comment]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[capabilities]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[interfaces_attributes]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Сетевые интерфейсы узла.


Value: Must be an Array of nested elements
host[interfaces_attributes][mac]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

MAC адрес интерфейса. Требуется для управления интерфейсами на голом железе.


Value: Must be String
host[interfaces_attributes][ip]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

IP адрес интерфейса


Value: Must be String
host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Тип интерфейса, например bmc. По умолчанию interface


Value: Must be one of: interface, bmc, bond.
host[interfaces_attributes][name]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

DNS имя интерфейса


Value: Must be String
host[interfaces_attributes][subnet_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Код подсети Foreman для интерфейса


Value: Must be Fixnum
host[interfaces_attributes][domain_id]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Код домена Foreman для интерфейса. Требуется для первичного интерфейса на управляемых узлах.


Value: Must be Fixnum
host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Имя интерфейса, например eth0 или eth1.1


Value: Must be String
host[interfaces_attributes][managed]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Должен ли интерфейс управляться DHCP и DNS капсулем и должен ли он быть сконфигурирован во время подготовки?


Value: Must be 'true' or 'false'
host[interfaces_attributes][primary]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Должен ли интерфейс быть использован для построения FQDN имени узла? Каждый управляемый узел должен иметь один первичный интерфейс.


Value: Must be 'true' or 'false'
host[interfaces_attributes][provision]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Должен ли интерфейс быть использован для сетевой загрузки через TFTP (или SSH для основанных на образах узлах)? Каждый управляемый узел должен иметь один интерфейс для подготовки.


Value: Must be 'true' or 'false'
host[interfaces_attributes][username]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Только для интерфейсов BMC.


Value: Must be String
host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Только для интерфейсов BMC.


Value: Must be String
host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Поставщик интерфейса, например IPMI. Только для интерфейса BMC.


Value: Must be one of: IPMI.
host[interfaces_attributes][virtual]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Псевдоним или VLAN устройства.


Value: Must be 'true' or 'false'
host[interfaces_attributes][tag]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Метка VLAN, этот атрибут имеет приоритет над подсетью VLAN ID. Только для виртуальных интерфейсов.


Value: Must be String
host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Идентификатор интерфейса к которому принадлежит этот интерфейс, например eth1. Только для виртуальных интерфейсов.


Value: Must be String
host[interfaces_attributes][mode]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Режим агрегации интерфейсов, например балансировка “бегающий кролик”. Только для агрегированных интерфейсов.


Value: Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
host[interfaces_attributes][attached_devices]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Идентификатор подчиненного интерфейса, например [‘eth1’, ‘eth2’]. Только для агрегированных интерфейсов.


Value: Must be an array of any type
host[interfaces_attributes][bond_options]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Разделенные пробелами варианты, например miimon=100. Только для агрегированных интерфейсов.


Value: Must be String
host[interfaces_attributes][compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Дополнительные атрибуты вычислительного ресурса определенные для интерфейса.


Value: Must be Hash
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

Специфичные дополнительные атрибута вычислительного ресурса.


Value: Must be Hash

DELETE /api/hosts/:id
Удалить узел

Params

Param Name Description
id
Required

Value: 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

Params

Param Name Description
id
Required

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

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

Returns string representing a host status of a given type

Params

Param Name Description
id
Required

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

status type, can be one of

  • global

  • configuration

  • build


Value: Must be one of: HostStatus::Global, configuration, build.

GET /api/hosts/:id/vm_compute_attributes
Получить атрибуты ВМ узла

Return the host's compute attributes that can be used to create a clone of this VM

Params

Param Name Description
id
Required

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

PUT /api/hosts/:id/puppetrun
Насильно запустить агента Puppet на узле

Params

Param Name Description
id
Required

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

PUT /api/hosts/:id/disassociate
Отвязать узел от ВМ

Params

Param Name Description
id
Required

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

PUT /api/hosts/:id/power
Запустить операцию по управлению питанием на узле

Params

Param Name Description
id
Required

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

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


Value: Must be String

PUT /api/hosts/:id/boot
Загрузить узел с определенного устройства

Params

Param Name Description
id
Required

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

загрузочное устройство, доступные устройства: диск, компакт диск, сеть, BIOS


Value: Must be String

POST /api/hosts/facts
Загрузить факты узла, требуемые для создания узла

Params

Param Name Description
name
Required

имя узла


Value: Must be String
facts
Required

хэш содержит факты узла


Value: Must be Hash
certname
Optional

выборочно: имя сертификата узла


Value: Must be String
type
Optional

выборочно: тип STI узла для создания


Value: Must be String

PUT /api/hosts/:id/rebuild_config
Rebuild orchestration config

Params

Param Name Description
id
Required

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