GET /api/hosts
List all hosts.

Params

Param Name Description
search
Optional

Filter results


Value: Must be String
order
Optional

Sort results


Value: Must be String
page
Optional

paginar resultados


Value: Must be String
per_page
Optional

número de entradas por requisições


Value: Must be String

GET /api/hosts/:id
Show a 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
Create a host.

Params

Param Name Description
host
Required

Value: Must be a Hash
host[name]
Required

Value: Must be String
host[environment_id]
Optional

necessário se o host é gerenciado e valor não é herdado do grupo de host


Value: Must be String
host[ip]
Optional

não necessário se utilizar um subrede com proxy DHCP


Value: Must be String
host[mac]
Optional

necessário para host gerenciado que é bare metal, não necessário se é uma máquina virtual


Value: Must be String
host[architecture_id]
Optional

necessário se o host é gerenciado e valor não é herdado do grupo de host


Value: Must be a number.
host[domain_id]
Optional

necessário se o host é gerenciado e valor não é herdado do grupo de host


Value: Must be a number.
host[realm_id]
Optional

Value: Must be a number.
host[puppet_proxy_id]
Optional

Value: Must be a number.
host[puppet_class_ids]
Optional

Value: Must be an array of any type
host[operatingsystem_id]
Optional

necessário se o host é gerenciado e valor não é herdado do grupo de host


Value: Must be String
host[medium_id]
Optional

Requerido se não baseado na imagem provisionando e host é gerenciado e o valor não é herdado do grupo de host


Value: Must be String
host[ptable_id]
Optional

requerido se o host é gerenciado e uma partição customizada não foi definida


Value: Must be a number.
host[subnet_id]
Optional

necessário se o host é gerenciado e valor não é herdado do grupo de host


Value: Must be a number.
host[compute_resource_id]
Optional

nulo significa que o host é bare metal


Value: Must be a number.
host[root_pass]
Optional

requerido se o host é gerenciado e o valor não é herdado do grupo de host ou senha padrão em configurações


Value: Must be String
host[model_id]
Optional

Value: Must be a number.
host[hostgroup_id]
Optional

Value: Must be a number.
host[owner_id]
Optional

Value: Must be a number.
host[puppet_ca_proxy_id]
Optional

Value: Must be a number.
host[image_id]
Optional

Value: Must be a number.
host[host_parameters_attributes]
Optional

Host's parameters (array or indexed hash)


Value: Must be an Array of nested elements
host[host_parameters_attributes][name]
Required

Name of the parameter


Value: Must be String
host[host_parameters_attributes][value]
Required

Parameter value


Value: Must be String
host[build]
Optional

Value: Must be 'true' or 'false'
host[enabled]
Optional

Value: Must be 'true' or 'false'
host[provision_method]
Optional

Value: Must be String
host[managed]
Optional

Sinal Verdadeiro / Falso se um host é gerenciado ou não . Nota: este valor também determina se são necessários vários parâmetros ou não


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional

UUID a rastrear o status de tarefas de orquestração, GET /api/orchestration/:UUID/tasks


Value: Must be String
host[comment]
Optional

Informação adicionar sobre este host


Value: Must be String
host[capabilities]
Optional

Value: Must be String
host[compute_profile_id]
Optional

Value: Must be a number.
host[compute_attributes]
Optional

Value: Must be a Hash

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

Value: Must be String
host[ip]
Optional

not required if using a subnet with dhcp proxy


Value: Must be String
host[mac]
Optional

not required if its a virtual machine


Value: Must be String
host[architecture_id]
Optional

Value: Must be a number.
host[domain_id]
Optional

Value: Must be a number.
host[puppet_proxy_id]
Optional

Value: Must be a number.
host[operatingsystem_id]
Optional

Value: Must be String
host[puppet_class_ids]
Optional

Value: Must be an array of any type
host[medium_id]
Optional

Value: Must be a number.
host[ptable_id]
Optional

Value: Must be a number.
host[subnet_id]
Optional

Value: Must be a number.
host[compute_resource_id]
Optional

Value: Must be a number.
host[sp_subnet_id]
Optional

Value: Must be a number.
host[model_id]
Optional

Value: Must be a number.
host[hostgroup_id]
Optional

Value: Must be a number.
host[owner_id]
Optional

Value: Must be a number.
host[puppet_ca_proxy_id]
Optional

Value: Must be a number.
host[image_id]
Optional

Value: Must be a number.
host[host_parameters_attributes]
Optional

Value: Must be an array of any type
host[build]
Optional

Value: Must be 'true' or 'false'
host[enabled]
Optional

Value: Must be 'true' or 'false'
host[provision_method]
Optional

Value: Must be String
host[managed]
Optional

Value: Must be 'true' or 'false'
host[progress_report_id]
Optional

UUID a rastrear o status de tarefas de orquestração, GET /api/orchestration/:UUID/tasks


Value: Must be String
host[capabilities]
Optional

Value: Must be String
host[compute_attributes]
Optional

Value: Must be a Hash

DELETE /api/hosts/:id
Delete an 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
Obter status do 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.