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

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

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

Параметры

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String


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

Параметры

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String


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

Параметры

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be a Hash

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be Fixnum

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

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

Validations:

  • Must be Fixnum

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

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

Validations:

  • Must be String

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

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

Validations:

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

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

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

Validations:

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

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

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

Validations:

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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be one of: IPMI.

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

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

Validations:

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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

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

interface[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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be Hash


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

Параметры

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

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

Validations:

  • Must be String

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.

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

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

Validations:

  • Must be a Hash

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be Fixnum

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

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

Validations:

  • Must be Fixnum

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

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

Validations:

  • Must be String

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

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

Validations:

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

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

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

Validations:

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

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

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

Validations:

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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be one of: IPMI.

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

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

Validations:

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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

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

interface[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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be Hash


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

Параметры

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String