GET /api/hosts
Enumera todos los hosts

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

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

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

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

Params

Param Name Description
hostgroup_id
Optional

ID del grupo de hosts


Value: Must be String
location_id
Optional

ID de la ubicación


Value: Must be String
organization_id
Optional

ID de la organización


Value: Must be String
environment_id
Optional

ID del entorno


Value: Must be String
search
Optional

filtrar resultados


Value: Must be String
order
Optional

ordenar resultados


Value: Must be String
page
Optional

paginar resultados


Value: Must be String
per_page
Optional

número de entradas por petición


Value: Must be String

GET /api/hosts/:id
Mostrar un host

Params

Param Name Description
id
Required

Value: 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
Crear un host

Params

Param Name Description
host
Required

Value: Must be a Hash
host[name]
Required

Value: Must be String
host[environment_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[ip]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[mac]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[architecture_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[domain_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[realm_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_class_ids]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[medium_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[ptable_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[subnet_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

nil implica que el host es bare metal


Value: Must be a number.
host[root_pass]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[model_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[hostgroup_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[owner_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[image_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[host_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[build]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[enabled]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[managed]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[comment]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Información adicional sobre este equipo


Value: Must be String
host[capabilities]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a Hash

PUT /api/hosts/:id
Actualizar un host

Params

Param Name Description
id
Required

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

Value: Must be a Hash
host[name]
Optional

Value: Must be String
host[environment_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[ip]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[mac]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[architecture_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[domain_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[realm_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_class_ids]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[medium_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[ptable_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[subnet_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

nil implica que el host es bare metal


Value: Must be a number.
host[root_pass]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[model_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[hostgroup_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[owner_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[image_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[host_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type
host[build]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[enabled]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[managed]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[comment]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Información adicional sobre este equipo


Value: Must be String
host[capabilities]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be String
host[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: es.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a Hash

DELETE /api/hosts/:id
Borrar un host

Params

Param Name Description
id
Required

Value: 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

Params

Param Name Description
id
Required

Value: 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/puppetrun
Forzar una ejecución del agente Puppet en el host

Params

Param Name Description
id
Required

Value: 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
Desasociar el host de una MV

Params

Param Name Description
id
Required

Value: 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
Correr operacion de encendido en host

Params

Param Name Description
id
Required

Value: 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
Required

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


Value: Must be String

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

Params

Param Name Description
id
Required

Value: 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
Required

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


Value: Must be String

POST /api/hosts/facts
Subir detalles para un host, creando el host si es necesario

Params

Param Name Description
name
Required

nombre de host del host


Value: Must be String
facts
Required

hash con los detalles para el host


Value: Must be Hash
certname
Optional

opcional: nombre de certificado del host


Value: Must be String
type
Optional

opcional: el tipo STI de host a crear


Value: Must be String