GET /api/v2/discovered_hosts
List all discovered hosts

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

search
optional

filtrera resultat

Validations:

  • Must be a String

order
optional

sortera resultat

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

antal poster per begäran

Validations:

  • Must be a String


GET /api/v2/discovered_hosts/:id
Show a discovered host

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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
Create a discovered host for testing (use /facts to create new hosts)

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

discovered_host
optional , nil allowed

Validations:

  • Must be a Hash

discovered_host[name]
required

Validations:

  • Must be a String

discovered_host[ip]
required

Validations:

  • Must be a String

discovered_host[mac]
required

Validations:

  • Must be a String

discovered_host[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2 or PXELinux by default)

Validations:

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


PUT /api/v2/discovered_hosts/:id
Provision a discovered host

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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 , nil allowed

Validations:

  • Must be a Hash

discovered_host[name]
optional , nil allowed

Validations:

  • Must be a String

discovered_host[environment_id]
optional , nil allowed

Validations:

  • Must be a String

discovered_host[ip]
optional , nil allowed

not required if using a subnet with DHCP proxy

Validations:

  • Must be a String

discovered_host[mac]
optional , nil allowed

not required if it's a virtual machine

Validations:

  • Must be a String

discovered_host[architecture_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[domain_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[puppet_proxy_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[puppet_class_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

discovered_host[operatingsystem_id]
optional , nil allowed

Validations:

  • Must be a String

discovered_host[medium_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[ptable_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[subnet_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[sp_subnet_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[model_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[hostgroup_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[owner_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[puppet_ca_proxy_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[image_id]
optional , nil allowed

Validations:

  • Must be a number.

discovered_host[host_parameters_attributes]
optional , nil allowed

Validations:

  • Must be an array of any type

discovered_host[build]
optional , nil allowed

Validations:

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

discovered_host[enabled]
optional , nil allowed

Validations:

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

discovered_host[provision_method]
optional , nil allowed

Validations:

  • Must be a String

discovered_host[managed]
optional , nil allowed

Validations:

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

discovered_host[progress_report_id]
optional , nil allowed

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

Validations:

  • Must be a String

discovered_host[capabilities]
optional , nil allowed

Validations:

  • Must be a String

discovered_host[root_pass]
optional , nil allowed

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

Validations:

  • Must be a String

discovered_host[pxe_loader]
optional , nil allowed

DHCP filename option (Grub2 or PXELinux by default)

Validations:

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


DELETE /api/v2/discovered_hosts/:id
Delete a discovered host

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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
Upload facts for a host, creating the host if required

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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 a Hash


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

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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
Execute rules against all currently discovered hosts

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer


PUT /api/v2/discovered_hosts/:id/refresh_facts
Refreshing the facts of a discovered host

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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
Rebooting a discovered host

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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
Rebooting all discovered hosts

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer