GET /api/hosts
Listar todos los hosts

GET /api/hostgroups/:hostgroup_id/hosts
Listar todos los hosts para un grupo de hosts

GET /api/locations/:location_id/hosts
Listar hosts por ubicación

GET /api/organizations/:organization_id/hosts
Listar hosts por organización

GET /api/environments/:environment_id/hosts
Listar hosts por entorno

Parámetros

Nombre del parámetro Descripción
thin
opcional

Only list ID and name of hosts

Validations:

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

hostgroup_id
opcional

ID del grupo de hosts

Validations:

  • Must be a String

location_id
opcional

ID de la ubicación

Validations:

  • Must be a String

organization_id
opcional

ID de la organización

Validations:

  • Must be a String

environment_id
opcional

ID del entorno

Validations:

  • Must be a String

include
opcional

Serie de tipos de información adicionales para incluir

Validations:

  • Must be an array of [“parameters”, “all_parameters”]

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

organizar resultados

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/:id
Mostrar un host

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

show_hidden_parameters
opcional

Mostrar valores de parámetros ocultos

Validations:

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


POST /api/hosts
Crear un host

Parámetros

Nombre del parámetro Descripción
host
requerido

Validations:

  • Must be a Hash

host[name]
requerido

Validations:

  • Must be a String

host[location_id]
requerido

obligatorio si las ubicaciones están activadas

Validations:

  • Must be a number.

host[organization_id]
requerido

obligatorio si las organizaciones están activadas

Validations:

  • Must be a number.

host[environment_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a String

host[ip]
opcional , nil permitido

no es necesario si se usa una subred con un proxy DHCP

Validations:

  • Must be a String

host[mac]
opcional , nil permitido

obligatorio para hosts administrados bare metal, no se requiere para máquinas virtuales

Validations:

  • Must be a String

host[architecture_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a number.

host[domain_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a number.

host[realm_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcional , nil permitido

ID del Proxy Puppet

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcional , nil permitido

ID del Proxy Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

host[config_group_ids]
opcional , nil permitido

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a String

host[medium_id]
opcional , nil permitido

obligatorio si el aprovisionamiento no se basa en imágenes, el host está administrado y el valor no se hereda de un grupo de hosts

Validations:

  • Must be a String

host[pxe_loader]
opcional , nil permitido

Opción de nombre de archivo DHCP (Grub2/PXELinux por defecto)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

host[ptable_id]
opcional , nil permitido

obligatorio si el host está administrado y no se han definido particiones personalizadas

Validations:

  • Must be a number.

host[subnet_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a number.

host[compute_resource_id]
opcional , nil permitido

nil implica que el host es bare metal

Validations:

  • Must be a number.

host[root_pass]
opcional , nil permitido

obligatorio si el host está administrado y el valor no se hereda de un grupo de hosts o contraseñas predeterminadas en parámetros

Validations:

  • Must be a String

host[model_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[hostgroup_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[owner_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[owner_type]
opcional , nil permitido

Tipo de propietario de host

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcional , nil permitido

Parámetros del host (array o hash indexado)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
requerido

Nombre del parámetro

Validations:

  • Must be a String

host[host_parameters_attributes][value]
requerido

Valor del parámetro

Validations:

  • Must be a String

host[build]
opcional , nil permitido

Validations:

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

host[enabled]
opcional , nil permitido

Incluir este host en el informe de Foreman

Validations:

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

host[provision_method]
opcional , nil permitido

El método utilizado para aprovisionar el host. Entre los posibles métodos de aprovisionamiento se pueden encontrar los siguientes: build (Basado en red), image (Basado en Imagen)

Validations:

  • Must be a String

host[managed]
opcional , nil permitido

Indicador verdadero/falso que indica si el host es administradoo no. Nota: este valor también determina si ciertos parámetros son obligatorios.

Validations:

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

host[progress_report_id]
opcional , nil permitido

UUID para seguir el estado de la tarea de orquestación, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
opcional , nil permitido

Información adicional sobre este host

Validations:

  • Must be a String

host[capabilities]
opcional , nil permitido

Validations:

  • Must be a String

host[compute_profile_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[interfaces_attributes]
opcional , nil permitido

Interfaces de red del host

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opcional , nil permitido

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

Validations:

  • Must be a String

host[interfaces_attributes][ip]
opcional , nil permitido

Dirección IPv4 de la interfaz

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
opcional , nil permitido

Dirección IPv6 de la interfaz

Validations:

  • Must be a String

host[interfaces_attributes][type]
opcional , nil permitido

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

Validations:

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

host[interfaces_attributes][name]
opcional , nil permitido

Nombre de DNS de la interfaz

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv4

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv6

Validations:

  • Must be a number.

host[interfaces_attributes][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.

host[interfaces_attributes][identifier]
opcional , nil permitido

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

Validations:

  • Must be a String

host[interfaces_attributes][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

host[interfaces_attributes][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

host[interfaces_attributes][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

host[interfaces_attributes][username]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

host[interfaces_attributes][password]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
opcional , nil permitido

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

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opcional , nil permitido

Dispositivo VLAN o alias

Validations:

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

host[interfaces_attributes][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

host[interfaces_attributes][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

host[interfaces_attributes][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.

host[interfaces_attributes][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

host[interfaces_attributes][bond_options]
opcional , nil permitido

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

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
opcional , nil permitido

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

Validations:

  • Must be a Hash

host[compute_attributes]
opcional , nil permitido

Atributos adicionales específicos del recurso de computación

Validations:

  • Must be a Hash


PUT /api/hosts/:id
Actualizar un host

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

host
requerido

Validations:

  • Must be a Hash

host[name]
opcional

Validations:

  • Must be a String

host[location_id]
opcional

obligatorio si las ubicaciones están activadas

Validations:

  • Must be a number.

host[organization_id]
opcional

obligatorio si las organizaciones están activadas

Validations:

  • Must be a number.

host[environment_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a String

host[ip]
opcional , nil permitido

no es necesario si se usa una subred con un proxy DHCP

Validations:

  • Must be a String

host[mac]
opcional , nil permitido

obligatorio para hosts administrados bare metal, no se requiere para máquinas virtuales

Validations:

  • Must be a String

host[architecture_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a number.

host[domain_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a number.

host[realm_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcional , nil permitido

ID del Proxy Puppet

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcional , nil permitido

ID del Proxy Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

host[config_group_ids]
opcional , nil permitido

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a String

host[medium_id]
opcional , nil permitido

obligatorio si el aprovisionamiento no se basa en imágenes, el host está administrado y el valor no se hereda de un grupo de hosts

Validations:

  • Must be a String

host[pxe_loader]
opcional , nil permitido

Opción de nombre de archivo DHCP (Grub2/PXELinux por defecto)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

host[ptable_id]
opcional , nil permitido

obligatorio si el host está administrado y no se han definido particiones personalizadas

Validations:

  • Must be a number.

host[subnet_id]
opcional , nil permitido

obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts

Validations:

  • Must be a number.

host[compute_resource_id]
opcional , nil permitido

nil implica que el host es bare metal

Validations:

  • Must be a number.

host[root_pass]
opcional , nil permitido

obligatorio si el host está administrado y el valor no se hereda de un grupo de hosts o contraseñas predeterminadas en parámetros

Validations:

  • Must be a String

host[model_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[hostgroup_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[owner_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[owner_type]
opcional , nil permitido

Tipo de propietario de host

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcional , nil permitido

Parámetros del host (array o hash indexado)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
opcional

Nombre del parámetro

Validations:

  • Must be a String

host[host_parameters_attributes][value]
opcional

Valor del parámetro

Validations:

  • Must be a String

host[build]
opcional , nil permitido

Validations:

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

host[enabled]
opcional , nil permitido

Incluir este host en el informe de Foreman

Validations:

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

host[provision_method]
opcional , nil permitido

El método utilizado para aprovisionar el host. Entre los posibles métodos de aprovisionamiento se pueden encontrar los siguientes: build (Basado en red), image (Basado en Imagen)

Validations:

  • Must be a String

host[managed]
opcional , nil permitido

Indicador verdadero/falso que indica si el host es administradoo no. Nota: este valor también determina si ciertos parámetros son obligatorios.

Validations:

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

host[progress_report_id]
opcional , nil permitido

UUID para seguir el estado de la tarea de orquestación, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
opcional , nil permitido

Información adicional sobre este host

Validations:

  • Must be a String

host[capabilities]
opcional , nil permitido

Validations:

  • Must be a String

host[compute_profile_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[interfaces_attributes]
opcional , nil permitido

Interfaces de red del host

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opcional , nil permitido

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

Validations:

  • Must be a String

host[interfaces_attributes][ip]
opcional , nil permitido

Dirección IPv4 de la interfaz

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
opcional , nil permitido

Dirección IPv6 de la interfaz

Validations:

  • Must be a String

host[interfaces_attributes][type]
opcional , nil permitido

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

Validations:

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

host[interfaces_attributes][name]
opcional , nil permitido

Nombre de DNS de la interfaz

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv4

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv6

Validations:

  • Must be a number.

host[interfaces_attributes][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.

host[interfaces_attributes][identifier]
opcional , nil permitido

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

Validations:

  • Must be a String

host[interfaces_attributes][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

host[interfaces_attributes][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

host[interfaces_attributes][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

host[interfaces_attributes][username]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

host[interfaces_attributes][password]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
opcional , nil permitido

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

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opcional , nil permitido

Dispositivo VLAN o alias

Validations:

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

host[interfaces_attributes][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

host[interfaces_attributes][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

host[interfaces_attributes][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.

host[interfaces_attributes][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

host[interfaces_attributes][bond_options]
opcional , nil permitido

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

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
opcional , nil permitido

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

Validations:

  • Must be a Hash

host[compute_attributes]
opcional , nil permitido

Atributos adicionales específicos del recurso de computación

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
Borrar un host

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/enc
Obtener valores ENC del host

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/status
Obtener el estado de configuración del host

Return value may either be one of the following:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/status/:type
Estado del host

Returns string representing a host status of a given type

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

type
requerido

tipo de estado, se puede hacer

  • global

  • configuración

  • construir

Validations:

  • Must be one of: HostStatus::Global, configuration, build.


GET /api/hosts/:id/vm_compute_attributes
Obtener atributos de vm del host

Return the host's compute attributes that can be used to create a clone of this VM

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/disassociate
Disociar el host de una máquinas virtuales

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/power
Ejecutar operacion de encendido en host

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

power_action
requerido

acción de encendido, las acciones válidas incluyen (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

Validations:

  • Must be a String


PUT /api/hosts/:id/boot
Iniciar el host desde el dispositivo especificado

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

device
requerido

dispositivo de inicio, dispositivos validos son disk, cdrom, pxe, bios

Validations:

  • Must be a String


POST /api/hosts/facts
Subir eventos para un host, si es necesario cree el host.

Parámetros

Nombre del parámetro Descripción
name
requerido

nombre de host del host

Validations:

  • Must be a String

facts
requerido

hash con los eventos para el host

Validations:

  • Must be a Hash

certname
opcional

opcional: nombre de certificado del host

Validations:

  • Must be a String

type
opcional

opcional: el tipo STI de host a crear

Validations:

  • Must be a String


PUT /api/hosts/:id/rebuild_config
Volver a construir la configuración de orquestación

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

only
opcional

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
Vista previa del contenido producido de la plantilla de aprovisionamiento

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

kind
requerido

Tipos de plantilla, valores disponibles: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP

Validations:

  • Must be a String