GET /api/hosts/:host_id/interfaces
Список всех интерфейсов узла

GET /api/domains/:domain_id/interfaces
Список всех интерфейсов для домена

GET /api/subnets/:subnet_id/interfaces
Список всех интерфейсов для подсети

Params

Param Name Description
host_id
Required

Код или имя узла


Value: Must be String
domain_id
Optional

Код или имя домена


Value: Must be String
subnet_id
Optional

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


Value: Must be String
page
Optional

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


Value: Must be String
per_page
Optional

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


Value: Must be String

GET /api/hosts/:host_id/interfaces/:id
Показать интерфейс узла

Params

Param Name Description
host_id
Required

Код или имя узла


Value: Must be String
id
Required

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


Value: Must be String

POST /api/hosts/:host_id/interfaces
Создать интерфейс на узле

Params

Param Name Description
host_id
Required

Код или имя узла


Value: Must be String
interface
Required

информация об интерфейсе


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

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


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

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


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

Тип интерфейса, например bmc


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


Value: Must be String
interface[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.
interface[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
interface[bond_options]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


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

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


Value: Must be Hash

PUT /api/hosts/:host_id/interfaces/:id
Изменить интерфейс узла

Params

Param Name Description
host_id
Required

Код или имя узла


Value: Must be String
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.
interface
Required

информация об интерфейсе


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

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


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

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


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

Тип интерфейса, например bmc


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


Value: Must be String
interface[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.
interface[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
interface[bond_options]
Optional , <span class="translation_missing" title="translation missing: ru.apipie.nil_allowed">Nil Allowed</span>

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


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

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


Value: Must be Hash

DELETE /api/hosts/:host_id/interfaces/:id
Удалить интерфейс узла

Params

Param Name Description
host_id
Required

Код или имя узла


Value: Must be String
id
Required

Код интерфейса


Value: Must be String