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
thin
opcional

Listar apenas o ID e o nome dos hosts

Validations:

  • Must be one of: true, false, 1, 0

hostgroup_id
opcional

ID do grupo de host

Validations:

  • String

location_id
opcional

ID de localização

Validations:

  • String

organization_id
opcional

ID de organização

Validations:

  • String

environment_id
opcional

ID de ambiente

Validations:

  • String

include
opcional

Matriz de tipos adicionais de informações a incluir

Validations:

  • Must be one of: parameters, all_parameters.

search
opcional

filtrar resultados

Validations:

  • String

order
opcional

Sort field and order, eg. ‘id DESC’

Validations:

  • String

page
opcional

paginar resultados

Validations:

  • String

per_page
opcional

número de entradas por requisições

Validations:

  • String

Pesquisar campos

Nome do campo Tipo Valores possíveis
activation_key string
activation_key_id string
applicable_errata string
applicable_rpms string
architecture string
autoheal boolean
build true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
content_source string
content_view string
content_view_id integer
domain string
domain_id integer
environment string
errata_status security_needed, errata_needed, updated, unknown
facts string
global_status ok, warning, error
has_ip string
has_mac string
host_collection string
host_collection_id integer
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
hypervisor boolean
hypervisor_host string
image string
installable_errata string
installed_at datetime
installed_package string
installed_package_name string
ip string
last_checkin datetime
last_report datetime
lifecycle_environment string
lifecycle_environment_id integer
location string
location_id integer
mac string
managed true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
service_level string
smart_proxy string
status.applied integer
status.enabled true, false
status.failed integer
status.failed_restarts integer
status.interesting true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
subscription_id string
subscription_name string
subscription_status valid, partial, invalid, unknown, unsubscribed_hypervisor
subscription_uuid string
trace_app string
trace_app_type string
trace_helper string
trace_status reboot_needed, process_restart_needed, updated
upgradable_rpms string
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string

GET /api/hosts/:id
Mostrar um host

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.

show_hidden_parameters
opcional

Exibir valores de parâmetros ocultos

Validations:

  • Must be one of: true, false, 1, 0


POST /api/hosts
Criar um host

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

host
requerido

Validations:

  • Hash

host[name]
requerido

Validations:

  • 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 , nulo permitido

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

Validations:

  • String

host[ip]
opcional , nulo permitido

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

Validations:

  • String

host[mac]
opcional , nulo permitido

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

Validations:

  • String

host[architecture_id]
opcional , nulo permitido

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

Validations:

  • 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

Validations:

  • Must be a number.

host[realm_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcional , nulo permitido

Relatório de Marionete ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcional , nulo permitido

ID de Proxy do Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

host[config_group_ids]
opcional , nulo permitido

ID de grupos de configuração associados

Validations:

  • 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

Validations:

  • String

host[medium_id]
opcional , nulo permitido

solicitado se o provisionamento não for baseado em imagem, o host for gerenciado e o valor não for herdado do grupo de host

Validations:

  • String

host[pxe_loader]
opcional , nulo permitido

opção de nome de arquivo DHCP (Grub2/PXELinux por padrão)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

host[ptable_id]
opcional , nulo permitido

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

Validations:

  • 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

Validations:

  • Must be a number.

host[compute_resource_id]
opcional , nulo permitido

nulo significa que o host é bare metal

Validations:

  • 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

Validations:

  • String

host[model_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[hostgroup_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[owner_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[owner_type]
opcional , nulo permitido

Tipo de proprietário do host

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcional , nulo permitido

Parâmetros do host (matriz ou hash indexado)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
requerido

Nome do parâmetro

Validations:

  • String

host[host_parameters_attributes][value]
requerido

Valor do parâmetro

Validations:

  • String

host[build]
opcional , nulo permitido

Validations:

  • Must be one of: true, false, 1, 0

host[enabled]
opcional , nulo permitido

Incluir este host dentro do relatório do Foreman

Validations:

  • Must be one of: true, false, 1, 0

host[provision_method]
opcional , nulo permitido

O método utilizado para provisionar o host.

Validations:

  • Must be one of: build, image.

host[managed]
opcional , nulo permitido

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 one of: true, false, 1, 0

host[progress_report_id]
opcional , nulo permitido

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

Validations:

  • String

host[comment]
opcional , nulo permitido

Informação adicional sobre este host

Validations:

  • String

host[capabilities]
opcional , nulo permitido

Validations:

  • String

host[compute_profile_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[interfaces_attributes]
opcional , nulo permitido

Interfaces de rede do host

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opcional , nulo permitido

Endereço MAC da interface. Necessário para interfaces gerenciadas em bare metal.

Validations:

  • String

host[interfaces_attributes][ip]
opcional , nulo permitido

endereço IPv4 da interface

Validations:

  • String

host[interfaces_attributes][ip6]
opcional , nulo permitido

endereço IPv6 da interface

Validations:

  • String

host[interfaces_attributes][type]
opcional , nulo permitido

Tipo de interface , por exemplo, bmc . O padrão é % { default_nic_type }

Validations:

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

host[interfaces_attributes][name]
opcional , nulo permitido

nome DNS da interface

Validations:

  • String

host[interfaces_attributes][subnet_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv4

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv6

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
opcional , nulo permitido

Foreman ID de domínio da interface. Necessário para as interfaces primárias em hosts gerenciados.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
opcional , nulo permitido

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

Validations:

  • String

host[interfaces_attributes][managed]
opcional , nulo permitido

Esta interface deve ser gerenciada via o proxy inteligente DNS e DHCP e deve ser configurada durante provisionamento ?

Validations:

  • Must be one of: true, false, 1, 0

host[interfaces_attributes][primary]
opcional , nulo permitido

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

Validations:

  • Must be one of: true, false, 1, 0

host[interfaces_attributes][provision]
opcional , nulo permitido

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.

Validations:

  • Must be one of: true, false, 1, 0

host[interfaces_attributes][username]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • String

host[interfaces_attributes][password]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • String

host[interfaces_attributes][provider]
opcional , nulo permitido

prestador de interface , por exemplo IPMI . Apenas para interfaces BMC

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opcional , nulo permitido

Alias ou VLAN

Validations:

  • Must be one of: true, false, 1, 0

host[interfaces_attributes][tag]
opcional , nulo permitido

VLAN tag, este atributo tem precedência sobre a sub-rede VLAN ID . Apenas para interfaces virtuais

Validations:

  • String

host[interfaces_attributes][mtu]
opcional , nulo permitido

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Integer

host[interfaces_attributes][attached_to]
opcional , nulo permitido

Identificador da interface a que pertence esta interface , por exemplo, eth1 . Apenas para interfaces virtuais

Validations:

  • String

host[interfaces_attributes][mode]
opcional , nulo permitido

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

Validations:

  • 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

Identificadores de interfaces anexadas, ex.`['eth1', 'eth2']`. Para as interfaces vinculadas, esses são os subordinados. Somente para interfaces vinculadas e pontes.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
opcional , nulo permitido

Opções separadas espaço, por exemplo, miimon = 100 . Apenas para interfaces bond

Validations:

  • String

host[interfaces_attributes][compute_attributes]
opcional , nulo permitido

Atributos específicos de recursos adicionais de computação para a interface.

Validations:

  • Hash

host[compute_attributes]
opcional , nulo permitido

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

Validations:

  • Hash

host[content_facet_attributes]
opcional , nulo permitido

Parameters for host's content_facet facet

Validations:

  • Hash

host[content_facet_attributes][content_view_id]
opcional , nulo permitido

Validations:

  • Integer

host[content_facet_attributes][lifecycle_environment_id]
opcional , nulo permitido

Validations:

  • Integer

host[content_facet_attributes][content_source_id]
opcional , nulo permitido

Validations:

  • Integer

host[content_facet_attributes][kickstart_repository_id]
opcional , nulo permitido

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer

host[subscription_facet_attributes]
opcional , nulo permitido

Parameters for host's subscription_facet facet

Validations:

  • Hash

host[subscription_facet_attributes][release_version]
opcional , nulo permitido

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String

host[subscription_facet_attributes][autoheal]
opcional , nulo permitido

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

  • Must be one of: true, false, 1, 0

host[subscription_facet_attributes][service_level]
opcional , nulo permitido

Service level to be used for autoheal.

Validations:

  • Integer

host[subscription_facet_attributes][hypervisor_guest_uuids]
opcional , nulo permitido

List of hypervisor guest uuids

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][installed_products_attributes]
opcional , nulo permitido

List of products installed on the host

Validations:

  • Must be an Array of nested elements

host[subscription_facet_attributes][installed_products_attributes][product_id]
opcional , nulo permitido

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][product_name]
opcional , nulo permitido

Product name as listed from a host's installed products

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][arch]
opcional , nulo permitido

Product architecture

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][version]
opcional , nulo permitido

Product version

Validations:

  • String


PUT /api/hosts/:id
Atualizar um host

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

id
requerido

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host
requerido

Validations:

  • Hash

host[name]
opcional

Validations:

  • String

host[location_id]
opcional

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

Validations:

  • Must be a number.

host[organization_id]
opcional

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

Validations:

  • Must be a number.

host[environment_id]
opcional , nulo permitido

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

Validations:

  • String

host[ip]
opcional , nulo permitido

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

Validations:

  • String

host[mac]
opcional , nulo permitido

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

Validations:

  • String

host[architecture_id]
opcional , nulo permitido

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

Validations:

  • 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

Validations:

  • Must be a number.

host[realm_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcional , nulo permitido

Relatório de Marionete ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcional , nulo permitido

ID de Proxy do Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

host[config_group_ids]
opcional , nulo permitido

ID de grupos de configuração associados

Validations:

  • 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

Validations:

  • String

host[medium_id]
opcional , nulo permitido

solicitado se o provisionamento não for baseado em imagem, o host for gerenciado e o valor não for herdado do grupo de host

Validations:

  • String

host[pxe_loader]
opcional , nulo permitido

opção de nome de arquivo DHCP (Grub2/PXELinux por padrão)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

host[ptable_id]
opcional , nulo permitido

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

Validations:

  • 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

Validations:

  • Must be a number.

host[compute_resource_id]
opcional , nulo permitido

nulo significa que o host é bare metal

Validations:

  • 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

Validations:

  • String

host[model_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[hostgroup_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[owner_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[owner_type]
opcional , nulo permitido

Tipo de proprietário do host

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcional , nulo permitido

Parâmetros do host (matriz ou hash indexado)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
opcional

Nome do parâmetro

Validations:

  • String

host[host_parameters_attributes][value]
opcional

Valor do parâmetro

Validations:

  • String

host[build]
opcional , nulo permitido

Validations:

  • Must be one of: true, false, 1, 0

host[enabled]
opcional , nulo permitido

Incluir este host dentro do relatório do Foreman

Validations:

  • Must be one of: true, false, 1, 0

host[provision_method]
opcional , nulo permitido

O método utilizado para provisionar o host.

Validations:

  • Must be one of: build, image.

host[managed]
opcional , nulo permitido

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 one of: true, false, 1, 0

host[progress_report_id]
opcional , nulo permitido

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

Validations:

  • String

host[comment]
opcional , nulo permitido

Informação adicional sobre este host

Validations:

  • String

host[capabilities]
opcional , nulo permitido

Validations:

  • String

host[compute_profile_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[interfaces_attributes]
opcional , nulo permitido

Interfaces de rede do host

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opcional , nulo permitido

Endereço MAC da interface. Necessário para interfaces gerenciadas em bare metal.

Validations:

  • String

host[interfaces_attributes][ip]
opcional , nulo permitido

endereço IPv4 da interface

Validations:

  • String

host[interfaces_attributes][ip6]
opcional , nulo permitido

endereço IPv6 da interface

Validations:

  • String

host[interfaces_attributes][type]
opcional , nulo permitido

Tipo de interface , por exemplo, bmc . O padrão é % { default_nic_type }

Validations:

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

host[interfaces_attributes][name]
opcional , nulo permitido

nome DNS da interface

Validations:

  • String

host[interfaces_attributes][subnet_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv4

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv6

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
opcional , nulo permitido

Foreman ID de domínio da interface. Necessário para as interfaces primárias em hosts gerenciados.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
opcional , nulo permitido

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

Validations:

  • String

host[interfaces_attributes][managed]
opcional , nulo permitido

Esta interface deve ser gerenciada via o proxy inteligente DNS e DHCP e deve ser configurada durante provisionamento ?

Validations:

  • Must be one of: true, false, 1, 0

host[interfaces_attributes][primary]
opcional , nulo permitido

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

Validations:

  • Must be one of: true, false, 1, 0

host[interfaces_attributes][provision]
opcional , nulo permitido

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.

Validations:

  • Must be one of: true, false, 1, 0

host[interfaces_attributes][username]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • String

host[interfaces_attributes][password]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • String

host[interfaces_attributes][provider]
opcional , nulo permitido

prestador de interface , por exemplo IPMI . Apenas para interfaces BMC

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opcional , nulo permitido

Alias ou VLAN

Validations:

  • Must be one of: true, false, 1, 0

host[interfaces_attributes][tag]
opcional , nulo permitido

VLAN tag, este atributo tem precedência sobre a sub-rede VLAN ID . Apenas para interfaces virtuais

Validations:

  • String

host[interfaces_attributes][mtu]
opcional , nulo permitido

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Integer

host[interfaces_attributes][attached_to]
opcional , nulo permitido

Identificador da interface a que pertence esta interface , por exemplo, eth1 . Apenas para interfaces virtuais

Validations:

  • String

host[interfaces_attributes][mode]
opcional , nulo permitido

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

Validations:

  • 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

Identificadores de interfaces anexadas, ex.`['eth1', 'eth2']`. Para as interfaces vinculadas, esses são os subordinados. Somente para interfaces vinculadas e pontes.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
opcional , nulo permitido

Opções separadas espaço, por exemplo, miimon = 100 . Apenas para interfaces bond

Validations:

  • String

host[interfaces_attributes][compute_attributes]
opcional , nulo permitido

Atributos específicos de recursos adicionais de computação para a interface.

Validations:

  • Hash

host[compute_attributes]
opcional , nulo permitido

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

Validations:

  • Hash

host[content_facet_attributes]
opcional , nulo permitido

Parameters for host's content_facet facet

Validations:

  • Hash

host[content_facet_attributes][content_view_id]
opcional , nulo permitido

Validations:

  • Integer

host[content_facet_attributes][lifecycle_environment_id]
opcional , nulo permitido

Validations:

  • Integer

host[content_facet_attributes][content_source_id]
opcional , nulo permitido

Validations:

  • Integer

host[content_facet_attributes][kickstart_repository_id]
opcional , nulo permitido

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer

host[subscription_facet_attributes]
opcional , nulo permitido

Parameters for host's subscription_facet facet

Validations:

  • Hash

host[subscription_facet_attributes][release_version]
opcional , nulo permitido

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String

host[subscription_facet_attributes][autoheal]
opcional , nulo permitido

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

  • Must be one of: true, false, 1, 0

host[subscription_facet_attributes][service_level]
opcional , nulo permitido

Service level to be used for autoheal.

Validations:

  • Integer

host[subscription_facet_attributes][hypervisor_guest_uuids]
opcional , nulo permitido

List of hypervisor guest uuids

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][installed_products_attributes]
opcional , nulo permitido

List of products installed on the host

Validations:

  • Must be an Array of nested elements

host[subscription_facet_attributes][installed_products_attributes][product_id]
opcional , nulo permitido

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][product_name]
opcional , nulo permitido

Product name as listed from a host's installed products

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][arch]
opcional , nulo permitido

Product architecture

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][version]
opcional , nulo permitido

Product version

Validations:

  • String


DELETE /api/hosts/:id
Apagar host

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

id
requerido

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


GET /api/hosts/:id/enc
Obter valores ENC do host

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.


GET /api/hosts/:id/status
Obter status de configuração de host

Return value may either be one of the following:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.


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
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.

type
requerido

tipo de status, pode ser um dos seguintes

  • global

  • configuração

  • compilação

Validations:

  • 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
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.


PUT /api/hosts/:id/disassociate
Desassociar o host de uma VM

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.


PUT /api/hosts/:id/power
Execute uma operação de força no host

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.

power_action
requerido

ação de energia , as ações são válidos ( on / start ) , ( off / stop) , (soft / reboot ) , ( ciclo / reset ) , (estado / status)

Validations:

  • String


PUT /api/hosts/:id/boot
Inicie o nó através do dispositivo especificado

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.

device
requerido

dispositivo de boot, dispositivos válidos são disco, cdrom, pxe, bios

Validations:

  • String


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

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

name
requerido

hostname do host

Validations:

  • String

facts
requerido

hash contendo os fatos para o host

Validations:

  • Hash

certname
opcional

opcional: certname do host

Validations:

  • String

type
opcional

opcional: o tipo STI host para criar

Validations:

  • String


PUT /api/hosts/:id/rebuild_config
Reconstruir configuração orquestração

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.

only
opcional

Limitar etapas de reconstrução, as etapas válidas são DHCP, DNS, TFTP

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
Visualizar conteúdo de modelo de provisionamento renderizado

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

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.

kind
requerido

Tipos de modelo, valores disponíveis:

Validations:

  • String


PUT /api/hosts/:host_id/host_collections
Alter a hosts host collections

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Integer

organization_id
opcional

Escopo de organização

Validations:

  • Integer

host_id
requerido

The id of the host to alter

Validations:

  • Must be a number.

host_collection_ids
requerido

List of host collection ids to update

Validations:

  • Must be an array of any type