GET /api/hosts
List all hosts.

Parámetros

Nombre del parámetro Descripción
search
opcional

Filter results

Validations:

  • Must be String

order
opcional

Sort results

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/:id
Show a 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.


POST /api/hosts
Create a host.

Parámetros

Nombre del parámetro Descripción
host
requerido

Validations:

  • Must be a Hash

host[name]
requerido

Validations:

  • Must be String

host[environment_id]
opcional

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

Validations:

  • Must be String

host[ip]
opcional

no es necesario si estás usando una subred con un proxy DHCP

Validations:

  • Must be String

host[mac]
opcional

obligatorio para hosts bare metal gestionados, opcional para máquinas virtuales

Validations:

  • Must be String

host[architecture_id]
opcional

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

Validations:

  • Must be a number.

host[domain_id]
opcional

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

Validations:

  • Must be a number.

host[realm_id]
opcional

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcional

Validations:

  • Must be a number.

host[puppetclass_ids]
opcional

Validations:

  • Must be an array of any type

host[operatingsystem_id]
opcional

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

Validations:

  • Must be String

host[medium_id]
opcional

obligatorio si la provisión no está basada en imágenes y el host está gestionado y el valor no se hereda de un grupo de hosts

Validations:

  • Must be String

host[ptable_id]
opcional

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

Validations:

  • Must be a number.

host[subnet_id]
opcional

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

Validations:

  • Must be a number.

host[compute_resource_id]
opcional

nil implica que el host es bare metal

Validations:

  • Must be a number.

host[root_pass]
opcional

obligatorio si el host está gestionado y el valor no se hereda de un grupo de hosts o passwords por defecto en la configuración

Validations:

  • Must be String

host[model_id]
opcional

Validations:

  • Must be a number.

host[hostgroup_id]
opcional

Validations:

  • Must be a number.

host[owner_id]
opcional

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcional

Validations:

  • Must be a number.

host[image_id]
opcional

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcional

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
requerido

Name of the parameter

Validations:

  • Must be String

host[host_parameters_attributes][value]
requerido

Parameter value

Validations:

  • Must be String

host[build]
opcional

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

host[enabled]
opcional

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

host[provision_method]
opcional

Validations:

  • Must be String

host[managed]
opcional

Bandera Verdadero/Falso indicando si el host está gestionado o no. Nota: este valor también determina si ciertos parámetros son obligatorios.

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

host[progress_report_id]
opcional

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

Validations:

  • Must be String

host[comment]
opcional

Información adicional sobre este equipo

Validations:

  • Must be String

host[capabilities]
opcional

Validations:

  • Must be String

host[compute_profile_id]
opcional

Validations:

  • Must be a number.

host[compute_attributes]
opcional

Validations:

  • Must be a Hash


PUT /api/hosts/:id
Update a 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 String

host[environment_id]
opcional

Validations:

  • Must be String

host[ip]
opcional

not required if using a subnet with dhcp proxy

Validations:

  • Must be String

host[mac]
opcional

not required if its a virtual machine

Validations:

  • Must be String

host[architecture_id]
opcional

Validations:

  • Must be a number.

host[domain_id]
opcional

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcional

Validations:

  • Must be a number.

host[operatingsystem_id]
opcional

Validations:

  • Must be String

host[puppetclass_ids]
opcional

Validations:

  • Must be an array of any type

host[medium_id]
opcional

Validations:

  • Must be a number.

host[ptable_id]
opcional

Validations:

  • Must be a number.

host[subnet_id]
opcional

Validations:

  • Must be a number.

host[compute_resource_id]
opcional

Validations:

  • Must be a number.

host[sp_subnet_id]
opcional

Validations:

  • Must be a number.

host[model_id]
opcional

Validations:

  • Must be a number.

host[hostgroup_id]
opcional

Validations:

  • Must be a number.

host[owner_id]
opcional

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcional

Validations:

  • Must be a number.

host[image_id]
opcional

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcional

Validations:

  • Must be an array of any type

host[build]
opcional

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

host[enabled]
opcional

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

host[provision_method]
opcional

Validations:

  • Must be String

host[managed]
opcional

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

host[progress_report_id]
opcional

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

Validations:

  • Must be String

host[capabilities]
opcional

Validations:

  • Must be String

host[compute_attributes]
opcional

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
Delete an 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/status
Estado del host

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

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.