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

Parâmentros

Nome parâmetro Descrição
hostgroup_id
opcional

ID do grupo de host


Value:

Must be String

location_id
opcional

ID de localização


Value:

Must be String

organization_id
opcional

ID de organização


Value:

Must be String

environment_id
opcional

ID de ambiente


Value:

Must be String

search
opcional

filtrar resultados


Value:

Must be String

order
opcional

ordenar resultados


Value:

Must be String

page
opcional

paginar resultados


Value:

Must be String

per_page
opcional

número de entradas por requisições


Value:

Must be String


GET /api/hosts/:id
Mostrar um host

Parâmentros

Nome parâmetro Descrição
id
requerido

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

Parâmentros

Nome parâmetro Descrição
host
requerido

Value:

Must be a Hash

host[name]
requerido

Value:

Must be String

host[environment_id]
opcional , nulo permitido

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


Value:

Must be String

host[ip]
opcional , nulo permitido

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


Value:

Must be String

host[mac]
opcional , nulo permitido

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


Value:

Must be String

host[architecture_id]
opcional , nulo permitido

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


Value:

Must be a number.

host[domain_id]
opcional , nulo permitido

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


Value:

Must be a number.

host[realm_id]
opcional , nulo permitido

Value:

Must be a number.

host[puppet_proxy_id]
opcional , nulo permitido

Value:

Must be a number.

host[puppet_class_ids]
opcional , nulo permitido

Value:

Must be an array of any type

host[operatingsystem_id]
opcional , nulo permitido

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


Value:

Must be String

host[medium_id]
opcional , nulo permitido

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]
opcional , nulo permitido

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


Value:

Must be a number.

host[subnet_id]
opcional , nulo permitido

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


Value:

Must be a number.

host[compute_resource_id]
opcional , nulo permitido

nulo significa que o host é bare metal


Value:

Must be a number.

host[root_pass]
opcional , nulo permitido

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]
opcional , nulo permitido

Value:

Must be a number.

host[hostgroup_id]
opcional , nulo permitido

Value:

Must be a number.

host[owner_id]
opcional , nulo permitido

Value:

Must be a number.

host[owner_type]
opcional , nulo permitido

Tipo do dono do host


Value:

Must be one of: User, Usergroup.

host[puppet_ca_proxy_id]
opcional , nulo permitido

Value:

Must be a number.

host[image_id]
opcional , nulo permitido

Value:

Must be a number.

host[host_parameters_attributes]
opcional , nulo permitido

Value:

Must be an array of any type

host[build]
opcional , nulo permitido

Value:

Must be 'true' or 'false'

host[enabled]
opcional , nulo permitido

Value:

Must be 'true' or 'false'

host[provision_method]
opcional , nulo permitido

The method used to provision the host. Possible provision_methods may be build (Baseada em rede), image (Baseado em Imagem)


Value:

Must be String

host[managed]
opcional , nulo permitido

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]
opcional , nulo permitido

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


Value:

Must be String

host[comment]
opcional , nulo permitido

Informação adicionar sobre este host


Value:

Must be String

host[capabilities]
opcional , nulo permitido

Value:

Must be String

host[compute_profile_id]
opcional , nulo permitido

Value:

Must be a number.

host[interfaces_attributes]
opcional , nulo permitido

Interfaces de rede do host


Value:

Must be an Array of nested elements

host[interfaces_attributes][mac]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][ip]
opcional , nulo permitido

Endereço IP da interface


Value:

Must be String

host[interfaces_attributes][type]
opcional , nulo permitido

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


Value:

Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
opcional , nulo permitido

Interface's DNS name


Value:

Must be String

host[interfaces_attributes][subnet_id]
opcional , nulo permitido

Foreman subnet ID of interface


Value:

Must be Fixnum

host[interfaces_attributes][domain_id]
opcional , nulo permitido

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


Value:

Must be Fixnum

host[interfaces_attributes][identifier]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][managed]
opcional , nulo permitido

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]
opcional , nulo permitido

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.


Value:

Must be 'true' or 'false'

host[interfaces_attributes][provision]
opcional , nulo permitido

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.


Value:

Must be 'true' or 'false'

host[interfaces_attributes][username]
opcional , nulo permitido

Only for BMC interfaces.


Value:

Must be String

host[interfaces_attributes][password]
opcional , nulo permitido

Only for BMC interfaces.


Value:

Must be String

host[interfaces_attributes][provider]
opcional , nulo permitido

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


Value:

Must be one of: IPMI.

host[interfaces_attributes][virtual]
opcional , nulo permitido

Alias ou VLAN


Value:

Must be 'true' or 'false'

host[interfaces_attributes][tag]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][attached_to]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][mode]
opcional , nulo permitido

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]
opcional , nulo permitido

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.


Value:

Must be an array of any type

host[interfaces_attributes][bond_options]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][compute_attributes]
opcional , nulo permitido

Additional compute resource specific attributes for the interface.


Value:

Must be Hash

host[compute_attributes]
opcional , nulo permitido

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


Value:

Must be Hash


PUT /api/hosts/:id
Atualizar um host

Parâmentros

Nome parâmetro Descrição
id
requerido

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
requerido

Value:

Must be a Hash

host[name]
opcional

Value:

Must be String

host[environment_id]
opcional , nulo permitido

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


Value:

Must be String

host[ip]
opcional , nulo permitido

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


Value:

Must be String

host[mac]
opcional , nulo permitido

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


Value:

Must be String

host[architecture_id]
opcional , nulo permitido

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


Value:

Must be a number.

host[domain_id]
opcional , nulo permitido

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


Value:

Must be a number.

host[realm_id]
opcional , nulo permitido

Value:

Must be a number.

host[puppet_proxy_id]
opcional , nulo permitido

Value:

Must be a number.

host[puppet_class_ids]
opcional , nulo permitido

Value:

Must be an array of any type

host[operatingsystem_id]
opcional , nulo permitido

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


Value:

Must be String

host[medium_id]
opcional , nulo permitido

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]
opcional , nulo permitido

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


Value:

Must be a number.

host[subnet_id]
opcional , nulo permitido

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


Value:

Must be a number.

host[compute_resource_id]
opcional , nulo permitido

nulo significa que o host é bare metal


Value:

Must be a number.

host[root_pass]
opcional , nulo permitido

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]
opcional , nulo permitido

Value:

Must be a number.

host[hostgroup_id]
opcional , nulo permitido

Value:

Must be a number.

host[owner_id]
opcional , nulo permitido

Value:

Must be a number.

host[owner_type]
opcional , nulo permitido

Tipo do dono do host


Value:

Must be one of: User, Usergroup.

host[puppet_ca_proxy_id]
opcional , nulo permitido

Value:

Must be a number.

host[image_id]
opcional , nulo permitido

Value:

Must be a number.

host[host_parameters_attributes]
opcional , nulo permitido

Value:

Must be an array of any type

host[build]
opcional , nulo permitido

Value:

Must be 'true' or 'false'

host[enabled]
opcional , nulo permitido

Value:

Must be 'true' or 'false'

host[provision_method]
opcional , nulo permitido

The method used to provision the host. Possible provision_methods may be build (Baseada em rede), image (Baseado em Imagem)


Value:

Must be String

host[managed]
opcional , nulo permitido

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]
opcional , nulo permitido

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


Value:

Must be String

host[comment]
opcional , nulo permitido

Informação adicionar sobre este host


Value:

Must be String

host[capabilities]
opcional , nulo permitido

Value:

Must be String

host[compute_profile_id]
opcional , nulo permitido

Value:

Must be a number.

host[interfaces_attributes]
opcional , nulo permitido

Interfaces de rede do host


Value:

Must be an Array of nested elements

host[interfaces_attributes][mac]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][ip]
opcional , nulo permitido

Endereço IP da interface


Value:

Must be String

host[interfaces_attributes][type]
opcional , nulo permitido

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


Value:

Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
opcional , nulo permitido

Interface's DNS name


Value:

Must be String

host[interfaces_attributes][subnet_id]
opcional , nulo permitido

Foreman subnet ID of interface


Value:

Must be Fixnum

host[interfaces_attributes][domain_id]
opcional , nulo permitido

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


Value:

Must be Fixnum

host[interfaces_attributes][identifier]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][managed]
opcional , nulo permitido

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]
opcional , nulo permitido

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.


Value:

Must be 'true' or 'false'

host[interfaces_attributes][provision]
opcional , nulo permitido

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.


Value:

Must be 'true' or 'false'

host[interfaces_attributes][username]
opcional , nulo permitido

Only for BMC interfaces.


Value:

Must be String

host[interfaces_attributes][password]
opcional , nulo permitido

Only for BMC interfaces.


Value:

Must be String

host[interfaces_attributes][provider]
opcional , nulo permitido

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


Value:

Must be one of: IPMI.

host[interfaces_attributes][virtual]
opcional , nulo permitido

Alias ou VLAN


Value:

Must be 'true' or 'false'

host[interfaces_attributes][tag]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][attached_to]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][mode]
opcional , nulo permitido

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]
opcional , nulo permitido

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.


Value:

Must be an array of any type

host[interfaces_attributes][bond_options]
opcional , nulo permitido

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


Value:

Must be String

host[interfaces_attributes][compute_attributes]
opcional , nulo permitido

Additional compute resource specific attributes for the interface.


Value:

Must be Hash

host[compute_attributes]
opcional , nulo permitido

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


Value:

Must be Hash


DELETE /api/hosts/:id
Apagar host

Parâmentros

Nome parâmetro Descrição
id
requerido

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

Parâmentros

Nome parâmetro Descrição
id
requerido

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

Parâmentros

Nome parâmetro Descrição
id
requerido

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
requerido

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

Parâmentros

Nome parâmetro Descrição
id
requerido

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

Parâmentros

Nome parâmetro Descrição
id
requerido

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

Parâmentros

Nome parâmetro Descrição
id
requerido

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

Parâmentros

Nome parâmetro Descrição
id
requerido

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
requerido

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

Parâmentros

Nome parâmetro Descrição
id
requerido

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
requerido

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

Parâmentros

Nome parâmetro Descrição
name
requerido

hostname do host


Value:

Must be String

facts
requerido

hash contendo os fatos para o host


Value:

Must be Hash

certname
opcional

opcional: certname do host


Value:

Must be String

type
opcional

optional: the STI type of host to create


Value:

Must be String


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

Parâmentros

Nome parâmetro Descrição
id
requerido

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/template/:kind
Preview rendered provisioning template content

Parâmentros

Nome parâmetro Descrição
id
requerido

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.

kind
requerido

Template kinds, available values:


Value:

Must be String