GET /api/hosts/:host_id/interfaces
Listar todas as interfaces para host

GET /api/domains/:domain_id/interfaces
Listar todas as interfaces para domínio

GET /api/subnets/:subnet_id/interfaces
Listar todas as interfaces para subrede

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host

Validations:

  • Must be a String

domain_id
opcional

ID ou nome do domínio

Validations:

  • Must be a String

subnet_id
opcional

ID ou nome da subrede

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be a String


GET /api/hosts/:host_id/interfaces/:id
Exibir uma interface para host

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host

Validations:

  • Must be a String

id
requerido

ID ou nome da interface

Validations:

  • Must be a String


POST /api/hosts/:host_id/interfaces
Criar uma interface no host

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host

Validations:

  • Must be a String

interface
requerido

informação de interface

Validations:

  • Must be a Hash

interface[mac]
opcional , nulo permitido

Endereço MAC da interface. Necessário para interfaces gerenciadas em bare metal.

Validations:

  • Must be a String

interface[ip]
opcional , nulo permitido

endereço IPv4 da interface

Validations:

  • Must be a String

interface[ip6]
opcional , nulo permitido

endereço IPv6 da interface

Validations:

  • Must be a String

interface[type]
opcional , nulo permitido

Tipo de interface , por exemplo, bmc . O padrão é % { default_nic_type }

Validations:

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

interface[name]
opcional , nulo permitido

nome DNS da interface

Validations:

  • Must be a String

interface[subnet_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv4

Validations:

  • Must be a number.

interface[subnet6_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv6

Validations:

  • Must be a number.

interface[domain_id]
opcional , nulo permitido

Foreman ID de domínio da interface. Necessário para as interfaces primárias em hosts gerenciados.

Validations:

  • Must be a number.

interface[identifier]
opcional , nulo permitido

Identificador do dispositivo, ex.: eth0 ou eth1.1

Validations:

  • Must be a String

interface[managed]
opcional , nulo permitido

Esta interface deve ser gerenciada via o proxy inteligente DNS e DHCP e deve ser configurada durante provisionamento ?

Validations:

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

interface[primary]
opcional , nulo permitido

Está interface deverá ser usada para a construção do FQDN do host? Cada gerenciamento de host precisa ter uma interface primária.

Validations:

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

interface[provision]
opcional , nulo permitido

Esta interface deverá ser usada para TFTP do PXELinux (ou SSH para a base de imagem host)? Cada gerenciamento de host precisa ter uma interface de provisão.

Validations:

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

interface[username]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • Must be a String

interface[password]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • Must be a String

interface[provider]
opcional , nulo permitido

prestador de interface , por exemplo IPMI . Apenas para interfaces BMC

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
opcional , nulo permitido

Alias ou VLAN

Validations:

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

interface[tag]
opcional , nulo permitido

VLAN tag, este atributo tem precedência sobre a sub-rede VLAN ID . Apenas para interfaces virtuais

Validations:

  • Must be a String

interface[attached_to]
opcional , nulo permitido

Identificador da interface a que pertence esta interface , por exemplo, eth1 . Apenas para interfaces virtuais

Validations:

  • Must be a String

interface[mode]
opcional , nulo permitido

Modo do bond da interface, ex.: balance-rr. Somente para interfaces em bond.

Validations:

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

interface[attached_devices]
opcional , nulo permitido

Identificadores de interfaces anexadas, ex.`['eth1', 'eth2']`. Para as interfaces vinculadas, esses são os subordinados. Somente para interfaces vinculadas e pontes.

Validations:

  • Must be an array of any type

interface[bond_options]
opcional , nulo permitido

Opções separadas espaço, por exemplo, miimon = 100 . Apenas para interfaces bond

Validations:

  • Must be a String

interface[compute_attributes]
opcional , nulo permitido

Atributos específicos de recursos adicionais de computação para a interface.

Validations:

  • Must be a Hash


PUT /api/hosts/:host_id/interfaces/:id
Atualizar a interface de um host

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host

Validations:

  • Must be a String

id
requerido

ID da interface

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
requerido

informação de interface

Validations:

  • Must be a Hash

interface[mac]
opcional , nulo permitido

Endereço MAC da interface. Necessário para interfaces gerenciadas em bare metal.

Validations:

  • Must be a String

interface[ip]
opcional , nulo permitido

endereço IPv4 da interface

Validations:

  • Must be a String

interface[ip6]
opcional , nulo permitido

endereço IPv6 da interface

Validations:

  • Must be a String

interface[type]
opcional , nulo permitido

Tipo de interface , por exemplo, bmc . O padrão é % { default_nic_type }

Validations:

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

interface[name]
opcional , nulo permitido

nome DNS da interface

Validations:

  • Must be a String

interface[subnet_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv4

Validations:

  • Must be a number.

interface[subnet6_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv6

Validations:

  • Must be a number.

interface[domain_id]
opcional , nulo permitido

Foreman ID de domínio da interface. Necessário para as interfaces primárias em hosts gerenciados.

Validations:

  • Must be a number.

interface[identifier]
opcional , nulo permitido

Identificador do dispositivo, ex.: eth0 ou eth1.1

Validations:

  • Must be a String

interface[managed]
opcional , nulo permitido

Esta interface deve ser gerenciada via o proxy inteligente DNS e DHCP e deve ser configurada durante provisionamento ?

Validations:

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

interface[primary]
opcional , nulo permitido

Está interface deverá ser usada para a construção do FQDN do host? Cada gerenciamento de host precisa ter uma interface primária.

Validations:

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

interface[provision]
opcional , nulo permitido

Esta interface deverá ser usada para TFTP do PXELinux (ou SSH para a base de imagem host)? Cada gerenciamento de host precisa ter uma interface de provisão.

Validations:

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

interface[username]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • Must be a String

interface[password]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • Must be a String

interface[provider]
opcional , nulo permitido

prestador de interface , por exemplo IPMI . Apenas para interfaces BMC

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
opcional , nulo permitido

Alias ou VLAN

Validations:

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

interface[tag]
opcional , nulo permitido

VLAN tag, este atributo tem precedência sobre a sub-rede VLAN ID . Apenas para interfaces virtuais

Validations:

  • Must be a String

interface[attached_to]
opcional , nulo permitido

Identificador da interface a que pertence esta interface , por exemplo, eth1 . Apenas para interfaces virtuais

Validations:

  • Must be a String

interface[mode]
opcional , nulo permitido

Modo do bond da interface, ex.: balance-rr. Somente para interfaces em bond.

Validations:

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

interface[attached_devices]
opcional , nulo permitido

Identificadores de interfaces anexadas, ex.`['eth1', 'eth2']`. Para as interfaces vinculadas, esses são os subordinados. Somente para interfaces vinculadas e pontes.

Validations:

  • Must be an array of any type

interface[bond_options]
opcional , nulo permitido

Opções separadas espaço, por exemplo, miimon = 100 . Apenas para interfaces bond

Validations:

  • Must be a String

interface[compute_attributes]
opcional , nulo permitido

Atributos específicos de recursos adicionais de computação para a interface.

Validations:

  • Must be a Hash


DELETE /api/hosts/:host_id/interfaces/:id
Apagar um interface do host

Parâmentros

Nome parâmetro Descrição
host_id
requerido

ID ou nome do host

Validations:

  • Must be a String

id
requerido

ID da interface

Validations:

  • Must be a String