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

Параметры

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

Only list ID and name of hosts

Validations:

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

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

Array of extra information types to include

Validations:

  • Must be one of: parameters, all_parameters.

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

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

Validations:

  • Must be a String

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

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

Search fields

Field name Тип Possible values
ansible_role string
architecture string
build true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
domain string
domain_id integer
environment string
execution_status ok, error
facts string
global_status ok, warning, error
has_ip string
has_mac string
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
image string
installed_at datetime
ip string
job_invocation.id string
job_invocation.result cancelled, failed, pending, success
last_report datetime
location string
location_id integer
mac string
managed true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
realm string
realm_id integer
smart_proxy string
status.applied integer
status.enabled true, false
status.failed integer
status.failed_restarts integer
status.interesting true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string

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

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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.

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

Display hidden parameter values

Validations:

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


POST /api/hosts
Создать узел

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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]
необязательно , nil разрешен

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a 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 разрешен

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

Validations:

  • Must be an array of any type

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

IDs of associated config groups

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

host[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, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

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 a 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[image_id]
необязательно , nil разрешен

Validations:

  • Must be a number.

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

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

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]
необязательно , nil разрешен

Validations:

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

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

Включить этот узел в отчетность Foreman

Validations:

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

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

The method used to provision the host.

Validations:

  • Must be one of: build, image.

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

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

Validations:

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

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

Validations:

  • Must be a 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 a String

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

IPv4 address of interface

Validations:

  • Must be a String

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

IPv6 address of interface

Validations:

  • Must be a 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 a String

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

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

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

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a String

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

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

Validations:

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

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

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

Validations:

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

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

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

Validations:

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

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be one of: IPMI, SSH.

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

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

Validations:

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

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

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

Validations:

  • Must be a String

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

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a String

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

Режим агрегации интерфейсов, например balance-rr. Только для агрегированных интерфейсов.

Validations:

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

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

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

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a Hash

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

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

Validations:

  • Must be a Hash

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

IDs of associated ansible roles

Validations:

  • Must be an array of any type


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

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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[location_id]
необязательно

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a 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 разрешен

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

Validations:

  • Must be an array of any type

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

IDs of associated config groups

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

host[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, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

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 a 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[image_id]
необязательно , nil разрешен

Validations:

  • Must be a number.

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

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

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]
необязательно , nil разрешен

Validations:

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

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

Включить этот узел в отчетность Foreman

Validations:

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

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

The method used to provision the host.

Validations:

  • Must be one of: build, image.

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

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

Validations:

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

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

Validations:

  • Must be a 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 a String

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

IPv4 address of interface

Validations:

  • Must be a String

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

IPv6 address of interface

Validations:

  • Must be a 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 a String

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

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

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

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a String

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

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

Validations:

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

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

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

Validations:

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

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

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

Validations:

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

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be one of: IPMI, SSH.

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

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

Validations:

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

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

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

Validations:

  • Must be a String

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

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a String

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

Режим агрегации интерфейсов, например balance-rr. Только для агрегированных интерфейсов.

Validations:

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

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

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

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a Hash

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

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

Validations:

  • Must be a Hash

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

IDs of associated ansible roles

Validations:

  • Must be an array of any type


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

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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/enc
Get ENC values of host

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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
Получить состояние конфигурации узла

Return value may either be one of the following:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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
обязательно

тип состояния может быть

  • глобальный

  • настройка

  • сборка

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

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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
Отвязать узел от ВМ

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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
Запустить операцию по управлению питанием на узле

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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 a String


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

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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 a String


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

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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

имя узла

Validations:

  • Must be a String

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

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

Validations:

  • Must be a Hash

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String


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

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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.

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

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

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
Просмотр содержимого подготовительного шаблона

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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
обязательно

Тип шаблона. Возможные значения:

Validations:

  • Must be a String


POST /api/hosts/:id/play_roles
Plays Ansible roles on a host

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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/hosts/multiple_play_roles
Plays Ansible roles on hosts

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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

IDs of hosts to play roles on

Validations:

  • Must be an array of any type


GET /api/hosts/:id/ansible_roles
List all Ansible roles for a host

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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/hosts/:id/assign_ansible_roles
Assigns Ansible roles to a host

Параметры

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

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

Validations:

  • Must be a Integer

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

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

Validations:

  • Must be a Integer

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.

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

Ansible roles to assign to a host

Validations:

  • Must be an array of any type