GET /api/v2/discovered_hosts
Listar todos os hosts descobertos

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

ordenar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be a String


GET /api/v2/discovered_hosts/:id
Exibir um host descoberto

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a 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.


POST /api/v2/discovered_hosts
Crie um host descoberto para testes (use /facts para criar novos hosts)

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

discovered_host
opcional , nulo permitido

Validations:

  • Must be a Hash

discovered_host[name]
requerido

Validations:

  • Must be a String

discovered_host[ip]
requerido

Validations:

  • Must be a String

discovered_host[mac]
requerido

Validations:

  • Must be a String

discovered_host[pxe_loader]
opcional , nulo permitido

Opção do nome de arquivo DHCP (Grub2 ou PXELinux por padrão)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.


PUT /api/v2/discovered_hosts/:id
Provisionar um host descoberto

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

discovered_host
opcional , nulo permitido

Validations:

  • Must be a Hash

discovered_host[name]
opcional , nulo permitido

Validations:

  • Must be a String

discovered_host[environment_id]
opcional , nulo permitido

Validations:

  • Must be a String

discovered_host[ip]
opcional , nulo permitido

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

Validations:

  • Must be a String

discovered_host[mac]
opcional , nulo permitido

não é obrigatório se for uma máquina virtual

Validations:

  • Must be a String

discovered_host[architecture_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[domain_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[puppet_proxy_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[puppet_class_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

discovered_host[operatingsystem_id]
opcional , nulo permitido

Validations:

  • Must be a String

discovered_host[medium_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[ptable_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[subnet_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[sp_subnet_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[model_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[hostgroup_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[owner_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[puppet_ca_proxy_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[image_id]
opcional , nulo permitido

Validations:

  • Must be a number.

discovered_host[host_parameters_attributes]
opcional , nulo permitido

Validations:

  • Must be an array of any type

discovered_host[build]
opcional , nulo permitido

Validations:

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

discovered_host[enabled]
opcional , nulo permitido

Validations:

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

discovered_host[provision_method]
opcional , nulo permitido

Validations:

  • Must be a String

discovered_host[managed]
opcional , nulo permitido

Validations:

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

discovered_host[progress_report_id]
opcional , nulo permitido

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

Validations:

  • Must be a String

discovered_host[capabilities]
opcional , nulo permitido

Validations:

  • Must be a String

discovered_host[root_pass]
opcional , nulo permitido

obrigatório se o valor não for herdado do grupo de hosts ou da senha padrão nas configurações

Validations:

  • Must be a String

discovered_host[pxe_loader]
opcional , nulo permitido

Opção do nome de arquivo DHCP (Grub2 ou PXELinux por padrão)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.


DELETE /api/v2/discovered_hosts/:id
Excluir um host descoberto

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/v2/discovered_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:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

facts
requerido

fatos com hashes pra o host com conjunto mínimo de fatos: discovery_bootif, macaddress_eth0, ipaddress, ipaddress_eth0, interfaces: eth0 (exemplo caso a interface primária tenha como nome eth0)

Validations:

  • Must be a Hash


POST /api/v2/discovered_hosts/:id/auto_provision
Executar regras em relação a um host descoberto

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/v2/discovered_hosts/auto_provision_all
Executar regras em relação a todos os hosts descobertos atualmente

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer


PUT /api/v2/discovered_hosts/:id/refresh_facts
Atualizando os fatos de um host descoberto

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/v2/discovered_hosts/:id/reboot
Reinicializando um host descoberto

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/v2/discovered_hosts/reboot_all
Reinicializando todos os hosts descobertos

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer