Nome parâmetro | Descrição |
---|---|
thin opcional |
Listar apenas o ID e o nome dos hosts Validations:
|
hostgroup_id opcional |
ID do grupo de host Validations:
|
location_id opcional |
ID de localização Validations:
|
organization_id opcional |
ID de organização Validations:
|
environment_id opcional |
ID de ambiente Validations:
|
include opcional |
Matriz de tipos adicionais de informações a incluir Validations:
|
search opcional |
filtrar resultados Validations:
|
order opcional |
Classificar campo e ordem, ex.: ‘id DESC’ Validations:
|
page opcional |
paginar resultados Validations:
|
per_page opcional |
número de entradas por requisições Validations:
|
Nome do campo | Tipo | Valores possíveis |
---|---|---|
ansible_role | string | |
architecture | string | |
build | true, false | |
class | string | |
comment | text | |
compute_resource | string | |
compute_resource_id | integer | |
config_group | string | |
domain | string | |
domain_id | integer | |
environment | string | |
execution_status | ok, error | |
facts | string | |
global_status | ok, warning, error | |
has_ip | string | |
has_mac | string | |
hostgroup | string | |
hostgroup_fullname | string | |
hostgroup_id | integer | |
hostgroup_name | string | |
hostgroup_title | string | |
image | string | |
installed_at | datetime | |
ip | string | |
job_invocation.id | string | |
job_invocation.result | cancelled, failed, pending, success | |
last_report | datetime | |
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 | |
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 | |
user.firstname | string | |
user.lastname | string | |
user.login | string | |
user.mail | string | |
usergroup | string | |
usergroup.name | string | |
uuid | string |
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
show_hidden_parameters opcional |
Exibir valores de parâmetros ocultos Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
host requerido |
Validations:
|
host[name] requerido |
Validations:
|
host[location_id] requerido |
necessário se as localizações estão habilitadas Validations:
|
host[organization_id] requerido |
necessário se as organizações estão habilitadas Validations:
|
host[environment_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
host[ip] opcional , nulo permitido |
não necessário se utilizar um subrede com proxy DHCP Validations:
|
host[mac] opcional , nulo permitido |
necessário para host gerenciado que é bare metal, não necessário se é uma máquina virtual Validations:
|
host[architecture_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
host[domain_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
host[realm_id] opcional , nulo permitido |
Validations:
|
host[puppet_proxy_id] opcional , nulo permitido |
Relatório de Marionete ID Validations:
|
host[puppet_ca_proxy_id] opcional , nulo permitido |
ID de Proxy do Puppet CA Validations:
|
host[puppetclass_ids] opcional , nulo permitido |
Validations:
|
host[config_group_ids] opcional , nulo permitido |
ID de grupos de configuração associados Validations:
|
host[operatingsystem_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
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:
|
host[pxe_loader] opcional , nulo permitido |
opção de nome de arquivo DHCP (Grub2/PXELinux por padrão) Validations:
|
host[ptable_id] opcional , nulo permitido |
requerido se o host é gerenciado e uma partição customizada não foi definida Validations:
|
host[subnet_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
host[compute_resource_id] opcional , nulo permitido |
nulo significa que o host é bare metal Validations:
|
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:
|
host[model_id] opcional , nulo permitido |
Validations:
|
host[hostgroup_id] opcional , nulo permitido |
Validations:
|
host[owner_id] opcional , nulo permitido |
Validations:
|
host[owner_type] opcional , nulo permitido |
Tipo de proprietário do host Validations:
|
host[image_id] opcional , nulo permitido |
Validations:
|
host[host_parameters_attributes] opcional , nulo permitido |
Parâmetros do host (matriz ou hash indexado) Validations:
|
host[host_parameters_attributes][name] requerido |
Nome do parâmetro Validations:
|
host[host_parameters_attributes][value] requerido |
Valor do parâmetro Validations:
|
host[build] opcional , nulo permitido |
Validations:
|
host[enabled] opcional , nulo permitido |
Incluir este host dentro do relatório do Foreman Validations:
|
host[provision_method] opcional , nulo permitido |
O método utilizado para provisionar o host. Validations:
|
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:
|
host[progress_report_id] opcional , nulo permitido |
UUID a rastrear o status de tarefas de orquestração, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] opcional , nulo permitido |
Informação adicional sobre este host Validations:
|
host[capabilities] opcional , nulo permitido |
Validations:
|
host[compute_profile_id] opcional , nulo permitido |
Validations:
|
host[interfaces_attributes] opcional , nulo permitido |
Interfaces de rede do host Validations:
|
host[interfaces_attributes][mac] opcional , nulo permitido |
Endereço MAC da interface. Necessário para interfaces gerenciadas em bare metal. Validations:
|
host[interfaces_attributes][ip] opcional , nulo permitido |
endereço IPv4 da interface Validations:
|
host[interfaces_attributes][ip6] opcional , nulo permitido |
endereço IPv6 da interface Validations:
|
host[interfaces_attributes][type] opcional , nulo permitido |
Tipo de interface , por exemplo, bmc . O padrão é % { default_nic_type } Validations:
|
host[interfaces_attributes][name] opcional , nulo permitido |
nome DNS da interface Validations:
|
host[interfaces_attributes][subnet_id] opcional , nulo permitido |
ID de sub-rede do Foreman de interface IPv4 Validations:
|
host[interfaces_attributes][subnet6_id] opcional , nulo permitido |
ID de sub-rede do Foreman de interface IPv6 Validations:
|
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:
|
host[interfaces_attributes][identifier] opcional , nulo permitido |
Identificador do dispositivo, ex.: eth0 ou eth1.1 Validations:
|
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:
|
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:
|
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:
|
host[interfaces_attributes][username] opcional , nulo permitido |
Apenas para interfaces BMC. Validations:
|
host[interfaces_attributes][password] opcional , nulo permitido |
Apenas para interfaces BMC. Validations:
|
host[interfaces_attributes][provider] opcional , nulo permitido |
prestador de interface , por exemplo IPMI . Apenas para interfaces BMC Validations:
|
host[interfaces_attributes][virtual] opcional , nulo permitido |
Alias ou VLAN Validations:
|
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:
|
host[interfaces_attributes][mtu] opcional , nulo permitido |
MTU, esse atributo tem precedência sobre a sub-rede MTU. Validations:
|
host[interfaces_attributes][attached_to] opcional , nulo permitido |
Identificador da interface a que pertence esta interface , por exemplo, eth1 . Apenas para interfaces virtuais Validations:
|
host[interfaces_attributes][mode] opcional , nulo permitido |
Modo do bond da interface, ex.: balance-rr. Somente para interfaces em bond. Validations:
|
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:
|
host[interfaces_attributes][bond_options] opcional , nulo permitido |
Opções separadas espaço, por exemplo, miimon = 100 . Apenas para interfaces bond Validations:
|
host[interfaces_attributes][compute_attributes] opcional , nulo permitido |
Atributos específicos de recursos adicionais de computação para a interface. Validations:
|
host[compute_attributes] opcional , nulo permitido |
Atributos específicos adicionais de recurso de computação. Validations:
|
host[ansible_role_ids] opcional |
IDs of associated ansible roles Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
host requerido |
Validations:
|
host[name] opcional |
Validations:
|
host[location_id] opcional |
necessário se as localizações estão habilitadas Validations:
|
host[organization_id] opcional |
necessário se as organizações estão habilitadas Validations:
|
host[environment_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
host[ip] opcional , nulo permitido |
não necessário se utilizar um subrede com proxy DHCP Validations:
|
host[mac] opcional , nulo permitido |
necessário para host gerenciado que é bare metal, não necessário se é uma máquina virtual Validations:
|
host[architecture_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
host[domain_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
host[realm_id] opcional , nulo permitido |
Validations:
|
host[puppet_proxy_id] opcional , nulo permitido |
Relatório de Marionete ID Validations:
|
host[puppet_ca_proxy_id] opcional , nulo permitido |
ID de Proxy do Puppet CA Validations:
|
host[puppetclass_ids] opcional , nulo permitido |
Validations:
|
host[config_group_ids] opcional , nulo permitido |
ID de grupos de configuração associados Validations:
|
host[operatingsystem_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
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:
|
host[pxe_loader] opcional , nulo permitido |
opção de nome de arquivo DHCP (Grub2/PXELinux por padrão) Validations:
|
host[ptable_id] opcional , nulo permitido |
requerido se o host é gerenciado e uma partição customizada não foi definida Validations:
|
host[subnet_id] opcional , nulo permitido |
necessário se o host é gerenciado e valor não é herdado do grupo de host Validations:
|
host[compute_resource_id] opcional , nulo permitido |
nulo significa que o host é bare metal Validations:
|
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:
|
host[model_id] opcional , nulo permitido |
Validations:
|
host[hostgroup_id] opcional , nulo permitido |
Validations:
|
host[owner_id] opcional , nulo permitido |
Validations:
|
host[owner_type] opcional , nulo permitido |
Tipo de proprietário do host Validations:
|
host[image_id] opcional , nulo permitido |
Validations:
|
host[host_parameters_attributes] opcional , nulo permitido |
Parâmetros do host (matriz ou hash indexado) Validations:
|
host[host_parameters_attributes][name] opcional |
Nome do parâmetro Validations:
|
host[host_parameters_attributes][value] opcional |
Valor do parâmetro Validations:
|
host[build] opcional , nulo permitido |
Validations:
|
host[enabled] opcional , nulo permitido |
Incluir este host dentro do relatório do Foreman Validations:
|
host[provision_method] opcional , nulo permitido |
O método utilizado para provisionar o host. Validations:
|
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:
|
host[progress_report_id] opcional , nulo permitido |
UUID a rastrear o status de tarefas de orquestração, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] opcional , nulo permitido |
Informação adicional sobre este host Validations:
|
host[capabilities] opcional , nulo permitido |
Validations:
|
host[compute_profile_id] opcional , nulo permitido |
Validations:
|
host[interfaces_attributes] opcional , nulo permitido |
Interfaces de rede do host Validations:
|
host[interfaces_attributes][mac] opcional , nulo permitido |
Endereço MAC da interface. Necessário para interfaces gerenciadas em bare metal. Validations:
|
host[interfaces_attributes][ip] opcional , nulo permitido |
endereço IPv4 da interface Validations:
|
host[interfaces_attributes][ip6] opcional , nulo permitido |
endereço IPv6 da interface Validations:
|
host[interfaces_attributes][type] opcional , nulo permitido |
Tipo de interface , por exemplo, bmc . O padrão é % { default_nic_type } Validations:
|
host[interfaces_attributes][name] opcional , nulo permitido |
nome DNS da interface Validations:
|
host[interfaces_attributes][subnet_id] opcional , nulo permitido |
ID de sub-rede do Foreman de interface IPv4 Validations:
|
host[interfaces_attributes][subnet6_id] opcional , nulo permitido |
ID de sub-rede do Foreman de interface IPv6 Validations:
|
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:
|
host[interfaces_attributes][identifier] opcional , nulo permitido |
Identificador do dispositivo, ex.: eth0 ou eth1.1 Validations:
|
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:
|
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:
|
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:
|
host[interfaces_attributes][username] opcional , nulo permitido |
Apenas para interfaces BMC. Validations:
|
host[interfaces_attributes][password] opcional , nulo permitido |
Apenas para interfaces BMC. Validations:
|
host[interfaces_attributes][provider] opcional , nulo permitido |
prestador de interface , por exemplo IPMI . Apenas para interfaces BMC Validations:
|
host[interfaces_attributes][virtual] opcional , nulo permitido |
Alias ou VLAN Validations:
|
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:
|
host[interfaces_attributes][mtu] opcional , nulo permitido |
MTU, esse atributo tem precedência sobre a sub-rede MTU. Validations:
|
host[interfaces_attributes][attached_to] opcional , nulo permitido |
Identificador da interface a que pertence esta interface , por exemplo, eth1 . Apenas para interfaces virtuais Validations:
|
host[interfaces_attributes][mode] opcional , nulo permitido |
Modo do bond da interface, ex.: balance-rr. Somente para interfaces em bond. Validations:
|
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:
|
host[interfaces_attributes][bond_options] opcional , nulo permitido |
Opções separadas espaço, por exemplo, miimon = 100 . Apenas para interfaces bond Validations:
|
host[interfaces_attributes][compute_attributes] opcional , nulo permitido |
Atributos específicos de recursos adicionais de computação para a interface. Validations:
|
host[compute_attributes] opcional , nulo permitido |
Atributos específicos adicionais de recurso de computação. Validations:
|
host[ansible_role_ids] opcional |
IDs of associated ansible roles Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
Return value may either be one of the following:
Alerts disabled
No reports
Error
Out of sync
Active
Pending
No changes
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
Returns string representing a host status of a given type
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
type requerido |
tipo de status, pode ser um dos seguintes
Validations:
|
Return the host's compute attributes that can be used to create a clone of this VM
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
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:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
device requerido |
dispositivo de boot, dispositivos válidos são disco, cdrom, pxe, bios Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
name requerido |
hostname do host Validations:
|
facts requerido |
hash contendo os fatos para o host Validations:
|
certname opcional |
opcional: certname do host Validations:
|
type opcional |
opcional: o tipo STI host para criar Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
only opcional |
Limitar etapas de reconstrução, as etapas válidas são DHCP, DNS, TFTP Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
kind requerido |
Tipos de modelo, valores disponíveis: Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
host_ids requerido |
IDs of hosts to play roles on Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
Nome parâmetro | Descrição |
---|---|
location_id opcional |
Escopo de localizações Validations:
|
organization_id opcional |
Escopo de organização Validations:
|
id requerido |
Validations:
|
ansible_role_ids requerido |
Ansible roles to assign to a host Validations:
|