Discovered hosts

>>>

GET /api/v2/discovered_hosts
Llista tots els amfitrions descoberts

Params

Param Name Description
search
Optional

filtra els resultats

Validations:

  • Must be String
order
Optional

ordena els resultats

Validations:

  • Must be String
page
Optional

pagina els resultats

Validations:

  • Must be String
per_page
Optional

Nombre d'entrades per petició

Validations:

  • Must be String
>>>

GET /api/v2/discovered_hosts/:id
Mostra un amfitrió descobert

Params

Param Name Description
id
Required

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
Crea un amfitrió descobert per a provar-ho (utilitzeu /facts per crear nous amfitrions)

Params

Param Name Description
discovered_host
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a Hash
discovered_host[name]
Required

Validations:

  • Must be String
discovered_host[ip]
Required

Validations:

  • Must be String
discovered_host[mac]
Required

Validations:

  • Must be String
discovered_host[pxe_loader]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DHCP filename option (Grub2 or PXELinux by default)

Validations:

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

PUT /api/v2/discovered_hosts/:id
Aprovisiona un amfitrió descobert

Params

Param Name Description
id
Required

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

Validations:

  • Must be a Hash
discovered_host[name]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String
discovered_host[environment_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String
discovered_host[ip]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

no es requereix si s'està utilitzant una subxarxa amb servidor intermediari de DHCP

Validations:

  • Must be String
discovered_host[mac]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

not required if it's a virtual machine

Validations:

  • Must be String
discovered_host[architecture_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[domain_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[puppet_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[puppet_class_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
discovered_host[operatingsystem_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String
discovered_host[medium_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[ptable_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[sp_subnet_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[model_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[hostgroup_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[owner_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[image_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a number.
discovered_host[host_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type
discovered_host[build]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'
discovered_host[enabled]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'
discovered_host[provision_method]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String
discovered_host[managed]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'
discovered_host[progress_report_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be String
discovered_host[capabilities]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String
discovered_host[root_pass]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

required if value is not inherited from host group or default password in settings

Validations:

  • Must be String
discovered_host[pxe_loader]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DHCP filename option (Grub2 or PXELinux by default)

Validations:

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

DELETE /api/v2/discovered_hosts/:id
Suprimeix un amfitrió descobert

Params

Param Name Description
id
Required

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
Puja els objectes d'interès per a un amfitrió, creant el nou amfitrió si fos necessari

Params

Param Name Description
facts
Required

hash containing facts for the host with minimum set of facts: discovery_bootif, macaddress_eth0, ipaddress, ipaddress_eth0, interfaces: eth0 (example in case primary interface is named eth0)

Validations:

  • Must be Hash
>>>

POST /api/v2/discovered_hosts/:id/auto_provision
Execute rules against a discovered host

Params

Param Name Description
id
Required

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
Executa les regles contra tots els amfitrions detectats actualment

>>>

PUT /api/v2/discovered_hosts/:id/refresh_facts
S'estan refrescant els objectes d'interès d'un amfitrió descobert

Params

Param Name Description
id
Required

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
S'està reiniciant un amfitrió descobert

Params

Param Name Description
id
Required

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
S'estan reiniciant tots els amfitrions descoberts