GET /api/hosts
Listar todos os hosts

GET /api/hostgroups/:hostgroup_id/hosts
Listar todos os hosts para um grupo de host

GET /api/locations/:location_id/hosts
Listar hosts por localização

GET /api/organizations/:organization_id/hosts
Listar hosts por organização

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

Params

Param Name Description
hostgroup_id
Optional

ID do grupo de host


Value: Must be String
location_id
Optional

ID de localização


Value: Must be String
organization_id
Optional

ID de organização


Value: Must be String
environment_id
Optional

ID de ambiente


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 requisições


Value: Must be String

GET /api/hosts/:id
Mostrar um 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
Criar um 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: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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 , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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

Value: Must be a number.
host[puppet_class_ids]
Optional , <span class="translation_missing" title="translation missing: pt-BR.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: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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


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

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 , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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


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

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 , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

nulo significa que o host é bare metal


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

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 , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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

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

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

Tipo do dono do host


Value: Must be one of: User, Usergroup.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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

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

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

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

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

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

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not


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

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


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

Informação adicionar sobre este host


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

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

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

Interfaces de rede do host


Value: Must be an Array of nested elements
host[interfaces_attributes][mac]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Mac address da interface. Necessário para gerenciar interfaces em bare metal.


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

Endereço IP da interface


Value: Must be String
host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Interface type, e.g. bmc. Default is interface


Value: Must be one of: interface, bmc, bond.
host[interfaces_attributes][name]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Interface's DNS name


Value: Must be String
host[interfaces_attributes][subnet_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of interface


Value: Must be Fixnum
host[interfaces_attributes][domain_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Foreman domain ID of interface. Required for primary interfaces on managed hosts.


Value: Must be Fixnum
host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Identificador do dispositivo, ex.: eth0 ou eth1.1


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

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?


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

Está interface deverá ser usada para a construção do FQDN do host? Cada gerenciamento de host precisa ter uma interface primária.


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

Esta interface deverá ser usada para TFTP do PXELinux (ou SSH para a base de imagem host)? Cada gerenciamento de host precisa ter uma interface de provisão.


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

Only for BMC interfaces.


Value: Must be String
host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Only for BMC interfaces.


Value: Must be String
host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Interface provider, e.g. IPMI. Only for BMC interfaces.


Value: Must be one of: IPMI.
host[interfaces_attributes][virtual]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Alias ou VLAN


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

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.


Value: Must be String
host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.


Value: Must be String
host[interfaces_attributes][mode]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Modo do bond da interface, ex.: balance-rr. Somente para interfaces em bond.


Value: Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
host[interfaces_attributes][attached_devices]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Identifiers of slave interfaces, e.g. `['eth1', 'eth2']`. Only for bond interfaces.


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

Space separated options, e.g. miimon=100. Only for bond interfaces.


Value: Must be String
host[interfaces_attributes][compute_attributes]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes for the interface.


Value: Must be Hash
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Atributos específicos adicionais de recurso de computação.


Value: Must be Hash

PUT /api/hosts/:id
Atualizar um 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: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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 , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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


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

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


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

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

Value: Must be a number.
host[puppet_class_ids]
Optional , <span class="translation_missing" title="translation missing: pt-BR.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: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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


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

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 , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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


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

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 , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

nulo significa que o host é bare metal


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

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 , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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

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

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

Tipo do dono do host


Value: Must be one of: User, Usergroup.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

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

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

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

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

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

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

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not


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

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


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

Informação adicionar sobre este host


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

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

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

Interfaces de rede do host


Value: Must be an Array of nested elements
host[interfaces_attributes][mac]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Mac address da interface. Necessário para gerenciar interfaces em bare metal.


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

Endereço IP da interface


Value: Must be String
host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Interface type, e.g. bmc. Default is interface


Value: Must be one of: interface, bmc, bond.
host[interfaces_attributes][name]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Interface's DNS name


Value: Must be String
host[interfaces_attributes][subnet_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of interface


Value: Must be Fixnum
host[interfaces_attributes][domain_id]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Foreman domain ID of interface. Required for primary interfaces on managed hosts.


Value: Must be Fixnum
host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Identificador do dispositivo, ex.: eth0 ou eth1.1


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

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?


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

Está interface deverá ser usada para a construção do FQDN do host? Cada gerenciamento de host precisa ter uma interface primária.


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

Esta interface deverá ser usada para TFTP do PXELinux (ou SSH para a base de imagem host)? Cada gerenciamento de host precisa ter uma interface de provisão.


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

Only for BMC interfaces.


Value: Must be String
host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Only for BMC interfaces.


Value: Must be String
host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Interface provider, e.g. IPMI. Only for BMC interfaces.


Value: Must be one of: IPMI.
host[interfaces_attributes][virtual]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Alias ou VLAN


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

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.


Value: Must be String
host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.


Value: Must be String
host[interfaces_attributes][mode]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Modo do bond da interface, ex.: balance-rr. Somente para interfaces em bond.


Value: Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
host[interfaces_attributes][attached_devices]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Identifiers of slave interfaces, e.g. `['eth1', 'eth2']`. Only for bond interfaces.


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

Space separated options, e.g. miimon=100. Only for bond interfaces.


Value: Must be String
host[interfaces_attributes][compute_attributes]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Additional compute resource specific attributes for the interface.


Value: Must be Hash
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: pt-BR.apipie.nil_allowed">Nil Allowed</span>

Atributos específicos adicionais de recurso de computação.


Value: Must be Hash

DELETE /api/hosts/:id
Apagar 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
Get configuration status of 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.

GET /api/hosts/:id/status/:type
Obter status do host

Returns string representing a host status of a given type

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.
type
Required

status type, can be one of

  • global

  • configuration

  • build


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

GET /api/hosts/:id/vm_compute_attributes
Obter atributos de vm do host

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

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
Força uma execução do agente Puppet no 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
Desassociar o host de uma VM

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
Run a power operation on 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

power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)


Value: Must be String

PUT /api/hosts/:id/boot
Inicie o nó através do 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 boot, dispositivos válidos são disco, cdrom, pxe, bios


Value: Must be String

POST /api/hosts/facts
Enviar fatos para um host, criando o host se necessário

Params

Param Name Description
name
Required

hostname do host


Value: Must be String
facts
Required

hash contendo os fatos para o host


Value: Must be Hash
certname
Optional

opcional: certname do host


Value: Must be String
type
Optional

optional: the STI type of host to create


Value: Must be String

PUT /api/hosts/:id/rebuild_config
Rebuild orchestration config

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.