Имя параметра | Описание |
---|---|
thin необязательно |
Only list ID and name of hosts Validations:
|
hostgroup_id необязательно |
Код группы узлов Validations:
|
location_id необязательно |
Код местоположения Validations:
|
organization_id необязательно |
Код организации Validations:
|
environment_id необязательно |
Код окружения Validations:
|
include необязательно |
Array of extra information types to include Validations:
|
search необязательно |
отфильтровать результаты Validations:
|
order необязательно |
Sort field and order, eg. ‘id DESC’ Validations:
|
page необязательно |
постраничный вывод Validations:
|
per_page необязательно |
количество записей на запрос Validations:
|
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 |
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
show_hidden_parameters необязательно |
Display hidden parameter values Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
host обязательно |
Validations:
|
host[name] обязательно |
Validations:
|
host[location_id] обязательно |
требуется, если используется местоположение Validations:
|
host[organization_id] обязательно |
требуется, если используются организации Validations:
|
host[environment_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[ip] необязательно , nil разрешен |
не требуется, если используется подсеть с DHCP прокси Validations:
|
host[mac] необязательно , nil разрешен |
требуется для управления узлом на голом железе, не требуется для виртуальной машины Validations:
|
host[architecture_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[domain_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[realm_id] необязательно , nil разрешен |
Validations:
|
host[puppet_proxy_id] необязательно , nil разрешен |
Идентификатор прокси Puppet Validations:
|
host[puppet_ca_proxy_id] необязательно , nil разрешен |
Идентификатор прокси Puppet CA Validations:
|
host[puppetclass_ids] необязательно , nil разрешен |
Validations:
|
host[config_group_ids] необязательно , nil разрешен |
IDs of associated config groups Validations:
|
host[operatingsystem_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[medium_id] необязательно , nil разрешен |
требуется, если подготовка управляемого узла осуществляется без участия образов и при этом значение не было унаследовано от группы узлов Validations:
|
host[pxe_loader] необязательно , nil разрешен |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
host[ptable_id] необязательно , nil разрешен |
требуется, если узел находится под управлением, но собственный раздел не был объявлен Validations:
|
host[subnet_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[compute_resource_id] необязательно , nil разрешен |
ноль обозначает узел на голом железе Validations:
|
host[root_pass] необязательно , nil разрешен |
требуется, если узел управляется и значение не унаследовано из группы узлов или не задан пароль по умолчанию в настройках Validations:
|
host[model_id] необязательно , nil разрешен |
Validations:
|
host[hostgroup_id] необязательно , nil разрешен |
Validations:
|
host[owner_id] необязательно , nil разрешен |
Validations:
|
host[owner_type] необязательно , nil разрешен |
Тип владельца узла Validations:
|
host[image_id] необязательно , nil разрешен |
Validations:
|
host[host_parameters_attributes] необязательно , nil разрешен |
Параметры узла (массив или индексированный хэш) Validations:
|
host[host_parameters_attributes][name] обязательно |
Название параметра Validations:
|
host[host_parameters_attributes][value] обязательно |
Значение параметра Validations:
|
host[build] необязательно , nil разрешен |
Validations:
|
host[enabled] необязательно , nil разрешен |
Включить этот узел в отчетность Foreman Validations:
|
host[provision_method] необязательно , nil разрешен |
The method used to provision the host. Validations:
|
host[managed] необязательно , nil разрешен |
Флаг True/False сообщает, является ли узел контролируемым. Кроме того, в зависимости от этого значения может потребоваться настроить дополнительные параметры. Validations:
|
host[progress_report_id] необязательно , nil разрешен |
UUID для отслеживания состояния задач оркестрации, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] необязательно , nil разрешен |
Дополнительная информация об этом узле Validations:
|
host[capabilities] необязательно , nil разрешен |
Validations:
|
host[compute_profile_id] необязательно , nil разрешен |
Validations:
|
host[interfaces_attributes] необязательно , nil разрешен |
Сетевые интерфейсы узла. Validations:
|
host[interfaces_attributes][mac] необязательно , nil разрешен |
MAC адрес интерфейса. Требуется для управления интерфейсами на голом железе. Validations:
|
host[interfaces_attributes][ip] необязательно , nil разрешен |
IPv4 address of interface Validations:
|
host[interfaces_attributes][ip6] необязательно , nil разрешен |
IPv6 address of interface Validations:
|
host[interfaces_attributes][type] необязательно , nil разрешен |
Тип интерфейса, например bmc. По умолчанию interface Validations:
|
host[interfaces_attributes][name] необязательно , nil разрешен |
DNS-имя интерфейса Validations:
|
host[interfaces_attributes][subnet_id] необязательно , nil разрешен |
Foreman subnet ID of IPv4 interface Validations:
|
host[interfaces_attributes][subnet6_id] необязательно , nil разрешен |
Foreman subnet ID of IPv6 interface Validations:
|
host[interfaces_attributes][domain_id] необязательно , nil разрешен |
Код домена Foreman для интерфейса. Требуется для первичного интерфейса на управляемых узлах. Validations:
|
host[interfaces_attributes][identifier] необязательно , nil разрешен |
Имя интерфейса, например eth0 или eth1.1 Validations:
|
host[interfaces_attributes][managed] необязательно , nil разрешен |
Должен ли интерфейс контролироваться капсулой DHCP и DNS? В этом случае он будет настроен во время подготовки узла. Validations:
|
host[interfaces_attributes][primary] необязательно , nil разрешен |
Должен ли интерфейс использоваться для формирования FQDN-имени узла? Каждый управляемый узел должен иметь один первичный интерфейс. Validations:
|
host[interfaces_attributes][provision] необязательно , nil разрешен |
Должен ли интерфейс использоваться для сетевой загрузки по TFTP (или SSH на узлах, устанавливаемых из образа)? Каждый управляемый узел должен иметь один подготовительный интерфейс. Validations:
|
host[interfaces_attributes][username] необязательно , nil разрешен |
Только для интерфейсов BMC. Validations:
|
host[interfaces_attributes][password] необязательно , nil разрешен |
Только для интерфейсов BMC. Validations:
|
host[interfaces_attributes][provider] необязательно , nil разрешен |
Поставщик интерфейса, например IPMI. Только для интерфейса BMC. Validations:
|
host[interfaces_attributes][virtual] необязательно , nil разрешен |
Псевдоним или VLAN устройства. Validations:
|
host[interfaces_attributes][tag] необязательно , nil разрешен |
Метка VLAN, этот атрибут имеет приоритет над подсетью VLAN ID. Только для виртуальных интерфейсов. Validations:
|
host[interfaces_attributes][mtu] необязательно , nil разрешен |
MTU, this attribute has precedence over the subnet MTU. Validations:
|
host[interfaces_attributes][attached_to] необязательно , nil разрешен |
Идентификатор интерфейса к которому принадлежит этот интерфейс, например eth1. Только для виртуальных интерфейсов. Validations:
|
host[interfaces_attributes][mode] необязательно , nil разрешен |
Режим агрегации интерфейсов, например balance-rr. Только для агрегированных интерфейсов. Validations:
|
host[interfaces_attributes][attached_devices] необязательно , nil разрешен |
Идентификаторы подчиненных интерфейсов, например ['eth1', 'eth2']. Только для агрегированных интерфейсов и мостов. Validations:
|
host[interfaces_attributes][bond_options] необязательно , nil разрешен |
Список параметров через запятую, например: miimon=100. Только для агрегированных интерфейсов. Validations:
|
host[interfaces_attributes][compute_attributes] необязательно , nil разрешен |
Дополнительные атрибуты вычислительного ресурса для интерфейса. Validations:
|
host[compute_attributes] необязательно , nil разрешен |
Дополнительные атрибуты вычислительного ресурса. Validations:
|
host[ansible_role_ids] необязательно |
IDs of associated ansible roles Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
host обязательно |
Validations:
|
host[name] необязательно |
Validations:
|
host[location_id] необязательно |
требуется, если используется местоположение Validations:
|
host[organization_id] необязательно |
требуется, если используются организации Validations:
|
host[environment_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[ip] необязательно , nil разрешен |
не требуется, если используется подсеть с DHCP прокси Validations:
|
host[mac] необязательно , nil разрешен |
требуется для управления узлом на голом железе, не требуется для виртуальной машины Validations:
|
host[architecture_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[domain_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[realm_id] необязательно , nil разрешен |
Validations:
|
host[puppet_proxy_id] необязательно , nil разрешен |
Идентификатор прокси Puppet Validations:
|
host[puppet_ca_proxy_id] необязательно , nil разрешен |
Идентификатор прокси Puppet CA Validations:
|
host[puppetclass_ids] необязательно , nil разрешен |
Validations:
|
host[config_group_ids] необязательно , nil разрешен |
IDs of associated config groups Validations:
|
host[operatingsystem_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[medium_id] необязательно , nil разрешен |
требуется, если подготовка управляемого узла осуществляется без участия образов и при этом значение не было унаследовано от группы узлов Validations:
|
host[pxe_loader] необязательно , nil разрешен |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
host[ptable_id] необязательно , nil разрешен |
требуется, если узел находится под управлением, но собственный раздел не был объявлен Validations:
|
host[subnet_id] необязательно , nil разрешен |
требуется, если узел уже контролируется, но значение не было унаследовано от группы узлов Validations:
|
host[compute_resource_id] необязательно , nil разрешен |
ноль обозначает узел на голом железе Validations:
|
host[root_pass] необязательно , nil разрешен |
требуется, если узел управляется и значение не унаследовано из группы узлов или не задан пароль по умолчанию в настройках Validations:
|
host[model_id] необязательно , nil разрешен |
Validations:
|
host[hostgroup_id] необязательно , nil разрешен |
Validations:
|
host[owner_id] необязательно , nil разрешен |
Validations:
|
host[owner_type] необязательно , nil разрешен |
Тип владельца узла Validations:
|
host[image_id] необязательно , nil разрешен |
Validations:
|
host[host_parameters_attributes] необязательно , nil разрешен |
Параметры узла (массив или индексированный хэш) Validations:
|
host[host_parameters_attributes][name] необязательно |
Название параметра Validations:
|
host[host_parameters_attributes][value] необязательно |
Значение параметра Validations:
|
host[build] необязательно , nil разрешен |
Validations:
|
host[enabled] необязательно , nil разрешен |
Включить этот узел в отчетность Foreman Validations:
|
host[provision_method] необязательно , nil разрешен |
The method used to provision the host. Validations:
|
host[managed] необязательно , nil разрешен |
Флаг True/False сообщает, является ли узел контролируемым. Кроме того, в зависимости от этого значения может потребоваться настроить дополнительные параметры. Validations:
|
host[progress_report_id] необязательно , nil разрешен |
UUID для отслеживания состояния задач оркестрации, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] необязательно , nil разрешен |
Дополнительная информация об этом узле Validations:
|
host[capabilities] необязательно , nil разрешен |
Validations:
|
host[compute_profile_id] необязательно , nil разрешен |
Validations:
|
host[interfaces_attributes] необязательно , nil разрешен |
Сетевые интерфейсы узла. Validations:
|
host[interfaces_attributes][mac] необязательно , nil разрешен |
MAC адрес интерфейса. Требуется для управления интерфейсами на голом железе. Validations:
|
host[interfaces_attributes][ip] необязательно , nil разрешен |
IPv4 address of interface Validations:
|
host[interfaces_attributes][ip6] необязательно , nil разрешен |
IPv6 address of interface Validations:
|
host[interfaces_attributes][type] необязательно , nil разрешен |
Тип интерфейса, например bmc. По умолчанию interface Validations:
|
host[interfaces_attributes][name] необязательно , nil разрешен |
DNS-имя интерфейса Validations:
|
host[interfaces_attributes][subnet_id] необязательно , nil разрешен |
Foreman subnet ID of IPv4 interface Validations:
|
host[interfaces_attributes][subnet6_id] необязательно , nil разрешен |
Foreman subnet ID of IPv6 interface Validations:
|
host[interfaces_attributes][domain_id] необязательно , nil разрешен |
Код домена Foreman для интерфейса. Требуется для первичного интерфейса на управляемых узлах. Validations:
|
host[interfaces_attributes][identifier] необязательно , nil разрешен |
Имя интерфейса, например eth0 или eth1.1 Validations:
|
host[interfaces_attributes][managed] необязательно , nil разрешен |
Должен ли интерфейс контролироваться капсулой DHCP и DNS? В этом случае он будет настроен во время подготовки узла. Validations:
|
host[interfaces_attributes][primary] необязательно , nil разрешен |
Должен ли интерфейс использоваться для формирования FQDN-имени узла? Каждый управляемый узел должен иметь один первичный интерфейс. Validations:
|
host[interfaces_attributes][provision] необязательно , nil разрешен |
Должен ли интерфейс использоваться для сетевой загрузки по TFTP (или SSH на узлах, устанавливаемых из образа)? Каждый управляемый узел должен иметь один подготовительный интерфейс. Validations:
|
host[interfaces_attributes][username] необязательно , nil разрешен |
Только для интерфейсов BMC. Validations:
|
host[interfaces_attributes][password] необязательно , nil разрешен |
Только для интерфейсов BMC. Validations:
|
host[interfaces_attributes][provider] необязательно , nil разрешен |
Поставщик интерфейса, например IPMI. Только для интерфейса BMC. Validations:
|
host[interfaces_attributes][virtual] необязательно , nil разрешен |
Псевдоним или VLAN устройства. Validations:
|
host[interfaces_attributes][tag] необязательно , nil разрешен |
Метка VLAN, этот атрибут имеет приоритет над подсетью VLAN ID. Только для виртуальных интерфейсов. Validations:
|
host[interfaces_attributes][mtu] необязательно , nil разрешен |
MTU, this attribute has precedence over the subnet MTU. Validations:
|
host[interfaces_attributes][attached_to] необязательно , nil разрешен |
Идентификатор интерфейса к которому принадлежит этот интерфейс, например eth1. Только для виртуальных интерфейсов. Validations:
|
host[interfaces_attributes][mode] необязательно , nil разрешен |
Режим агрегации интерфейсов, например balance-rr. Только для агрегированных интерфейсов. Validations:
|
host[interfaces_attributes][attached_devices] необязательно , nil разрешен |
Идентификаторы подчиненных интерфейсов, например ['eth1', 'eth2']. Только для агрегированных интерфейсов и мостов. Validations:
|
host[interfaces_attributes][bond_options] необязательно , nil разрешен |
Список параметров через запятую, например: miimon=100. Только для агрегированных интерфейсов. Validations:
|
host[interfaces_attributes][compute_attributes] необязательно , nil разрешен |
Дополнительные атрибуты вычислительного ресурса для интерфейса. Validations:
|
host[compute_attributes] необязательно , nil разрешен |
Дополнительные атрибуты вычислительного ресурса. Validations:
|
host[ansible_role_ids] необязательно |
IDs of associated ansible roles Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
Return value may either be one of the following:
Alerts disabled
No reports
Error
Out of sync
Active
Pending
No changes
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
Returns string representing a host status of a given type
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
type обязательно |
тип состояния может быть
Validations:
|
Return the host's compute attributes that can be used to create a clone of this VM
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
power_action обязательно |
управление питанием, доступные действия: (включить/запустить), (выключить/остановить), (перезагрузка), (сброс), (состояние) Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
device обязательно |
загрузочное устройство, доступные устройства: диск, компакт диск, сеть, BIOS Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
name обязательно |
имя узла Validations:
|
facts обязательно |
хэш содержит факты узла Validations:
|
certname необязательно |
выборочно: имя сертификата узла Validations:
|
type необязательно |
выборочно: тип STI узла для создания Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
only необязательно |
Limit rebuild steps, valid steps are DHCP, DNS, TFTP Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
kind обязательно |
Тип шаблона. Возможные значения: Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
host_ids обязательно |
IDs of hosts to play roles on Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
Имя параметра | Описание |
---|---|
location_id необязательно |
Ограничить местоположением Validations:
|
organization_id необязательно |
Ограничить организацией Validations:
|
id обязательно |
Validations:
|
ansible_role_ids обязательно |
Ansible roles to assign to a host Validations:
|