GET /api/hosts/:host_id/interfaces
Enumera todos los interfaces de un host

GET /api/domains/:domain_id/interfaces
Enumerar los interfaces por dominio

GET /api/subnets/:subnet_id/interfaces
Enumerar las interfaces por subred

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be String

domain_id
opcional

ID del nombre de dominio

Validations:

  • Must be String

subnet_id
opcional

ID o nombre de subred

Validations:

  • Must be String

page
opcional

paginar resultados

Validations:

  • Must be String

per_page
opcional

número de entradas por petición

Validations:

  • Must be String


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

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be String

id
requerido

ID o nombre del interfaz

Validations:

  • Must be String


POST /api/hosts/:host_id/interfaces
Crear un interfaz a un host

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be String

interface
requerido

información de interfaz

Validations:

  • Must be a Hash

interface[mac]
opcional , nil permitido

Dirección MAC del interfaz. Requisito para interfaces gestionados en bare-metal.

Validations:

  • Must be String

interface[ip]
opcional , nil permitido

Dirección IP del interfaz

Validations:

  • Must be String

interface[type]
opcional , nil permitido

Tipo de interfaz, p. ej. bmc. Por defecto interface

Validations:

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

interface[name]
opcional , nil permitido

Nombre DNS del interfaz

Validations:

  • Must be String

interface[subnet_id]
opcional , nil permitido

ID de la subred de la interfaz

Validations:

  • Must be Fixnum

interface[domain_id]
opcional , nil permitido

ID de Foreman de dominio del interfaz. Obligatorio para interfaces primarios en los hosts gestionados.

Validations:

  • Must be Fixnum

interface[identifier]
opcional , nil permitido

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

Validations:

  • Must be String

interface[managed]
opcional , nil permitido

¿Debería gestionarse este interfaz por proxy inteligente DHCP y DNS y debería configurarse en la provisión?

Validations:

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

interface[primary]
opcional , nil permitido

¿Debería usarse este interfaz para construir el FQDN del host? Cada host gestionado necesita tener un interfaz primario.

Validations:

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

interface[provision]
opcional , nil permitido

¿Debería usarse este interfaz para TFTP o PXELinux (o SSH para hosts definidos por imagen)? Cada host gestionado necesita tener un interfaz de provisión.

Validations:

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

interface[username]
opcional , nil permitido

Sólo para interfaces BMC.

Validations:

  • Must be String

interface[password]
opcional , nil permitido

Sólo para interfaces BMC.

Validations:

  • Must be String

interface[provider]
opcional , nil permitido

Proveedor del interfaz, p.ej. IPMI. Sólo para interfaces BMC.

Validations:

  • Must be one of: IPMI.

interface[virtual]
opcional , nil permitido

Dispositivo VLAN o alias

Validations:

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

interface[tag]
opcional , nil permitido

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

Validations:

  • Must be String

interface[attached_to]
opcional , nil permitido

Identificador del interfaz al que pertenece este interfaz, p.ej. eth1. Sólo para interfaces virtuales.

Validations:

  • Must be String

interface[mode]
opcional , nil permitido

Modo de bonding tdel interfaz, p.ej. balance-rr. Solo para interfaces bond.

Validations:

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

interface[attached_devices]
opcional , nil permitido

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]
opcional , nil permitido

Opciones separadas por espacios, p.ej miimon=100. Solo para interfaces bond.

Validations:

  • Must be String

interface[compute_attributes]
opcional , nil permitido

Atributos específicos suplementarios de recursos de cómputo para el interfaz.

Validations:

  • Must be Hash


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

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be String

id
requerido

ID del 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 del interfaz. Requisito para interfaces gestionados en bare-metal.

Validations:

  • Must be String

interface[ip]
opcional , nil permitido

Dirección IP del interfaz

Validations:

  • Must be String

interface[type]
opcional , nil permitido

Tipo de interfaz, p. ej. bmc. Por defecto interface

Validations:

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

interface[name]
opcional , nil permitido

Nombre DNS del interfaz

Validations:

  • Must be String

interface[subnet_id]
opcional , nil permitido

ID de la subred de la interfaz

Validations:

  • Must be Fixnum

interface[domain_id]
opcional , nil permitido

ID de Foreman de dominio del interfaz. Obligatorio para interfaces primarios en los hosts gestionados.

Validations:

  • Must be Fixnum

interface[identifier]
opcional , nil permitido

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

Validations:

  • Must be String

interface[managed]
opcional , nil permitido

¿Debería gestionarse este interfaz por proxy inteligente DHCP y DNS y debería configurarse en la provisión?

Validations:

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

interface[primary]
opcional , nil permitido

¿Debería usarse este interfaz para construir el FQDN del host? Cada host gestionado necesita tener un interfaz primario.

Validations:

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

interface[provision]
opcional , nil permitido

¿Debería usarse este interfaz para TFTP o PXELinux (o SSH para hosts definidos por imagen)? Cada host gestionado necesita tener un interfaz de provisión.

Validations:

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

interface[username]
opcional , nil permitido

Sólo para interfaces BMC.

Validations:

  • Must be String

interface[password]
opcional , nil permitido

Sólo para interfaces BMC.

Validations:

  • Must be String

interface[provider]
opcional , nil permitido

Proveedor del interfaz, p.ej. IPMI. Sólo para interfaces BMC.

Validations:

  • Must be one of: IPMI.

interface[virtual]
opcional , nil permitido

Dispositivo VLAN o alias

Validations:

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

interface[tag]
opcional , nil permitido

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

Validations:

  • Must be String

interface[attached_to]
opcional , nil permitido

Identificador del interfaz al que pertenece este interfaz, p.ej. eth1. Sólo para interfaces virtuales.

Validations:

  • Must be String

interface[mode]
opcional , nil permitido

Modo de bonding tdel interfaz, p.ej. balance-rr. Solo para interfaces bond.

Validations:

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

interface[attached_devices]
opcional , nil permitido

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]
opcional , nil permitido

Opciones separadas por espacios, p.ej miimon=100. Solo para interfaces bond.

Validations:

  • Must be String

interface[compute_attributes]
opcional , nil permitido

Atributos específicos suplementarios de recursos de cómputo para el interfaz.

Validations:

  • Must be Hash


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

Parámetros

Nombre del parámetro Descripción
host_id
requerido

ID o nombre del host

Validations:

  • Must be String

id
requerido

ID del interfaz

Validations:

  • Must be String