GET /api/hosts
List all hosts.

Parâmentros

Nome parâmetro Descrição
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 requisições

Validations:

  • Must be String


GET /api/hosts/:id
Show a host.

Parâmentros

Nome parâmetro Descrição
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âmentros

Nome parâmetro Descrição
host
requerido

Validations:

  • Must be a Hash

host[name]
requerido

Validations:

  • Must be String

host[location_id]
requerido

necessário se as localizações estão habilitadas

Validations:

  • Must be a number.

host[organization_id]
requerido

necessário se as organizações estão habilitadas

Validations:

  • Must be a number.

host[environment_id]
opcional

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

Validations:

  • Must be String

host[ip]
opcional

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

Validations:

  • Must be String

host[mac]
opcional

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

Validations:

  • Must be String

host[architecture_id]
opcional

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

Validations:

  • Must be a number.

host[domain_id]
opcional

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

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

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

Validations:

  • Must be String

host[medium_id]
opcional

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

Validations:

  • Must be String

host[ptable_id]
opcional

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

Validations:

  • Must be a number.

host[subnet_id]
opcional

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

Validations:

  • Must be a number.

host[compute_resource_id]
opcional

nulo significa que o host é bare metal

Validations:

  • Must be a number.

host[root_pass]
opcional

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

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

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

Validations:

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

host[progress_report_id]
opcional

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

Validations:

  • Must be String

host[comment]
opcional

Informação adicionar sobre este host

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âmentros

Nome parâmetro Descrição
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 a rastrear o status de tarefas de orquestração, 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âmentros

Nome parâmetro Descrição
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
Obter status do host

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

Parâmentros

Nome parâmetro Descrição
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.