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
Список узлов по окружениям

Параметры

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String


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

Параметры

Имя параметра Описание
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
Создать узел

Параметры

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

Validations:

  • Must be a Hash

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

Validations:

  • Must be String

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be one of: User, Usergroup.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

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

Name of the parameter

Validations:

  • Must be String

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

Parameter value

Validations:

  • Must be String

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

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

The method used to provision the host. Possible provision_methods may be build (По сети), image (Из образа)

Validations:

  • Must be String

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

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][ip]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][type]
необязательно , nil разрешен

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

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
необязательно , nil разрешен

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

Validations:

  • Must be String

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

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

Validations:

  • Must be Fixnum

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

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

Validations:

  • Must be Fixnum

host[interfaces_attributes][identifier]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][managed]
необязательно , nil разрешен

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[interfaces_attributes][primary]
необязательно , nil разрешен

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[interfaces_attributes][provision]
необязательно , nil разрешен

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[interfaces_attributes][username]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][password]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][provider]
необязательно , nil разрешен

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

Validations:

  • Must be one of: IPMI.

host[interfaces_attributes][virtual]
необязательно , nil разрешен

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[interfaces_attributes][tag]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][attached_to]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][mode]
необязательно , nil разрешен

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

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
необязательно , nil разрешен

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][compute_attributes]
необязательно , nil разрешен

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

Validations:

  • Must be Hash

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

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

Validations:

  • Must be Hash


PUT /api/hosts/: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.

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

Validations:

  • Must be a Hash

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

Validations:

  • Must be String

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be one of: User, Usergroup.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

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

Name of the parameter

Validations:

  • Must be String

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

Parameter value

Validations:

  • Must be String

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

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

The method used to provision the host. Possible provision_methods may be build (По сети), image (Из образа)

Validations:

  • Must be String

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

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][ip]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][type]
необязательно , nil разрешен

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

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
необязательно , nil разрешен

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

Validations:

  • Must be String

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

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

Validations:

  • Must be Fixnum

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

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

Validations:

  • Must be Fixnum

host[interfaces_attributes][identifier]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][managed]
необязательно , nil разрешен

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[interfaces_attributes][primary]
необязательно , nil разрешен

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[interfaces_attributes][provision]
необязательно , nil разрешен

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[interfaces_attributes][username]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][password]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][provider]
необязательно , nil разрешен

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

Validations:

  • Must be one of: IPMI.

host[interfaces_attributes][virtual]
необязательно , nil разрешен

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[interfaces_attributes][tag]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][attached_to]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][mode]
необязательно , nil разрешен

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

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
необязательно , nil разрешен

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
необязательно , nil разрешен

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

Validations:

  • Must be String

host[interfaces_attributes][compute_attributes]
необязательно , nil разрешен

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

Validations:

  • Must be Hash

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

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

Validations:

  • Must be Hash


DELETE /api/hosts/: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.


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.


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

Returns string representing a host status of a given type

Параметры

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

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

status type, can be one of

  • global

  • configuration

  • build

Validations:

  • 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

Параметры

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


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

Параметры

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


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

Параметры

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


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

Параметры

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

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

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

Validations:

  • Must be String


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

Параметры

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

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

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

Validations:

  • Must be String


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

Параметры

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

имя узла

Validations:

  • Must be String

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

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

Validations:

  • Must be Hash

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String


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

Параметры

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


GET /api/hosts/:id/template/:kind
Preview rendered provisioning template content

Параметры

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

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

Template kinds, available values:

Validations:

  • Must be String