GET /api/hosts/:host_id/interfaces
Listar todas las interfaces por host

GET /api/domains/:domain_id/interfaces
Listar todas las interfaces por dominio

GET /api/subnets/:subnet_id/interfaces
Listar todas las interfaces por subred

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be a String

domain_id
opcional

ID del nombre de dominio

Validations:

  • Must be a String

subnet_id
opcional

ID o nombre de subred

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por solicitud

Validations:

  • Must be a String


GET /api/hosts/:host_id/interfaces/:id
Mostrar una interfaz para host

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be a String

id
requerido

ID o nombre de la interfaz

Validations:

  • Must be a String


POST /api/hosts/:host_id/interfaces
Crear una interfaz en un host

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be a String

interface
requerido

información de interfaz

Validations:

  • Must be a Hash

interface[mac]
opcional , nil permitido

Dirección MAC de la interfaz. Requerida para interfaces administradas bare metal.

Validations:

  • Must be a String

interface[ip]
opcional , nil permitido

Dirección IPv4 de la interfaz

Validations:

  • Must be a String

interface[ip6]
opcional , nil permitido

Dirección IPv6 de la interfaz

Validations:

  • Must be a String

interface[type]
opcional , nil permitido

Tipo de interfaz, por ejemplo, bmc. El tipo predeterminado es interface

Validations:

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

interface[name]
opcional , nil permitido

Nombre de DNS de la interfaz

Validations:

  • Must be a String

interface[subnet_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv4

Validations:

  • Must be a number.

interface[subnet6_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv6

Validations:

  • Must be a number.

interface[domain_id]
opcional , nil permitido

ID del dominio de Foreman de la interfaz. Requerida para interfaces principales en hosts administrados.

Validations:

  • Must be a number.

interface[identifier]
opcional , nil permitido

Identificador de dispositivo, p.ej. eth0 o eth1.1

Validations:

  • Must be a String

interface[managed]
opcional , nil permitido

¿Debería esta interfaz ser administrada vía proxy inteligente DHCP y DNS y configurarse durante el aprovisionamiento?

Validations:

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

interface[primary]
opcional , nil permitido

¿Debería ser usada esta interface para construir el FQDN del host? Cada host gestionado necesita tener una interfaz primaria.

Validations:

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

interface[provision]
opcional , nil permitido

¿Debería ser usada esta interfaz para TFTP o PXELinux (o SSH para hosts basados en imágenes)? Cada host gestionado necesita tener una interfaz de provisión.

Validations:

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

interface[username]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

interface[password]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

interface[provider]
opcional , nil permitido

Proveedor de interfaz, p.ej., IPMI. Solo para interfaces BMC.

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
opcional , nil permitido

Dispositivo VLAN o alias

Validations:

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

interface[tag]
opcional , nil permitido

Etiqueta VLAN, este atributo tiene precedencia sobre la ID de subred VLAN. Solo para interfaces virtuales.

Validations:

  • Must be a String

interface[attached_to]
opcional , nil permitido

Identificador de la interfaz a la que pertenece esta interfaz, p.ej., eth1. Solo para interfaces virtuales.

Validations:

  • Must be a String

interface[mode]
opcional , nil permitido

Modo de vinculación de la interfaz, p. ej,. balance-rr. Solo para interfaces de vínculo.

Validations:

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

interface[attached_devices]
opcional , nil permitido

Identificadores de interfaces adjuntas, por ejemplo: `['eth1', 'eth2']`. Para las interfaces vinculadas son esclavos. Solo para interfaces vinculadas y puentes.

Validations:

  • Must be an array of any type

interface[bond_options]
opcional , nil permitido

Opciones separadas por espacios, p.ej miimon=100. Solo para interfaces de vínculo.

Validations:

  • Must be a String

interface[compute_attributes]
opcional , nil permitido

Atributos adicionales específicos del recurso de computación para la interfaz.

Validations:

  • Must be a Hash


PUT /api/hosts/:host_id/interfaces/:id
Actualizar una interfaz de host

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be a String

id
requerido

ID de la interfaz

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

información de interfaz

Validations:

  • Must be a Hash

interface[mac]
opcional , nil permitido

Dirección MAC de la interfaz. Requerida para interfaces administradas bare metal.

Validations:

  • Must be a String

interface[ip]
opcional , nil permitido

Dirección IPv4 de la interfaz

Validations:

  • Must be a String

interface[ip6]
opcional , nil permitido

Dirección IPv6 de la interfaz

Validations:

  • Must be a String

interface[type]
opcional , nil permitido

Tipo de interfaz, por ejemplo, bmc. El tipo predeterminado es interface

Validations:

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

interface[name]
opcional , nil permitido

Nombre de DNS de la interfaz

Validations:

  • Must be a String

interface[subnet_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv4

Validations:

  • Must be a number.

interface[subnet6_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv6

Validations:

  • Must be a number.

interface[domain_id]
opcional , nil permitido

ID del dominio de Foreman de la interfaz. Requerida para interfaces principales en hosts administrados.

Validations:

  • Must be a number.

interface[identifier]
opcional , nil permitido

Identificador de dispositivo, p.ej. eth0 o eth1.1

Validations:

  • Must be a String

interface[managed]
opcional , nil permitido

¿Debería esta interfaz ser administrada vía proxy inteligente DHCP y DNS y configurarse durante el aprovisionamiento?

Validations:

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

interface[primary]
opcional , nil permitido

¿Debería ser usada esta interface para construir el FQDN del host? Cada host gestionado necesita tener una interfaz primaria.

Validations:

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

interface[provision]
opcional , nil permitido

¿Debería ser usada esta interfaz para TFTP o PXELinux (o SSH para hosts basados en imágenes)? Cada host gestionado necesita tener una interfaz de provisión.

Validations:

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

interface[username]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

interface[password]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

interface[provider]
opcional , nil permitido

Proveedor de interfaz, p.ej., IPMI. Solo para interfaces BMC.

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
opcional , nil permitido

Dispositivo VLAN o alias

Validations:

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

interface[tag]
opcional , nil permitido

Etiqueta VLAN, este atributo tiene precedencia sobre la ID de subred VLAN. Solo para interfaces virtuales.

Validations:

  • Must be a String

interface[attached_to]
opcional , nil permitido

Identificador de la interfaz a la que pertenece esta interfaz, p.ej., eth1. Solo para interfaces virtuales.

Validations:

  • Must be a String

interface[mode]
opcional , nil permitido

Modo de vinculación de la interfaz, p. ej,. balance-rr. Solo para interfaces de vínculo.

Validations:

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

interface[attached_devices]
opcional , nil permitido

Identificadores de interfaces adjuntas, por ejemplo: `['eth1', 'eth2']`. Para las interfaces vinculadas son esclavos. Solo para interfaces vinculadas y puentes.

Validations:

  • Must be an array of any type

interface[bond_options]
opcional , nil permitido

Opciones separadas por espacios, p.ej miimon=100. Solo para interfaces de vínculo.

Validations:

  • Must be a String

interface[compute_attributes]
opcional , nil permitido

Atributos adicionales específicos del recurso de computación para la interfaz.

Validations:

  • Must be a Hash


DELETE /api/hosts/:host_id/interfaces/:id
Borrar una interfaz de host

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be a String

id
requerido

ID de la interfaz

Validations:

  • Must be a String