GET /api/hosts
List all hosts.

Parametry

Nazwa parametru Opis
search
opcjonalny

Filter results

Validations:

  • Must be String

order
opcjonalny

Sort results

Validations:

  • Must be String

page
opcjonalny

rezultat paginacji

Validations:

  • Must be String

per_page
opcjonalny

Liczba wpisów na jedno żądanie

Validations:

  • Must be String


GET /api/hosts/:id
Show a host.

Parametry

Nazwa parametru Opis
id
wymagany

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/hosts
Create a host.

Parametry

Nazwa parametru Opis
host
wymagany

Validations:

  • Must be a Hash

host[name]
wymagany

Validations:

  • Must be String

host[location_id]
wymagany

Wymagane, jeśli lokalizacja jest włączona

Validations:

  • Must be a number.

host[organization_id]
wymagany

Wymagane, jeśli organizacja jest włączona

Validations:

  • Must be a number.

host[environment_id]
opcjonalny

Wymagane, jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be String

host[ip]
opcjonalny

IPv4 address

Validations:

  • Must be String

host[ip6]
opcjonalny

IPv6 address

Validations:

  • Must be String

host[mac]
opcjonalny

Wymagane dla hosta z gołą maszyną (bez systemu), nie wymagane jeśli jest maszyną wirtualną

Validations:

  • Must be String

host[architecture_id]
opcjonalny

Wymagane, jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be a number.

host[domain_id]
opcjonalny

Wymagane, jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be a number.

host[realm_id]
opcjonalny

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcjonalny

Validations:

  • Must be a number.

host[puppetclass_ids]
opcjonalny

Validations:

  • Must be an array of any type

host[operatingsystem_id]
opcjonalny

Wymagane, jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be String

host[medium_id]
opcjonalny

wymagane, jeśli wdrożenie nie jest oparte na obrazie, host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be String

host[pxe_loader]
opcjonalny

DHCP filename option

Validations:

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

host[ptable_id]
opcjonalny

Wymagane, jeśli host jest zarządzany a domyslna partycja nie została zdefiniowana

Validations:

  • Must be a number.

host[subnet_id]
opcjonalny

IPv4 subnet

Validations:

  • Must be a number.

host[subnet6_id]
opcjonalny

IPv6 subnet

Validations:

  • Must be a number.

host[compute_resource_id]
opcjonalny

nil oznacza że host jest gołą maszyną

Validations:

  • Must be a number.

host[root_pass]
opcjonalny

wymagane jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów lub domyślne hasło ustawień

Validations:

  • Must be String

host[model_id]
opcjonalny

Validations:

  • Must be a number.

host[hostgroup_id]
opcjonalny

Validations:

  • Must be a number.

host[owner_id]
opcjonalny

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcjonalny

Validations:

  • Must be a number.

host[image_id]
opcjonalny

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcjonalny

Parametry hostów (tablica lub indeks hasza)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
wymagany

Nazwa parametru

Validations:

  • Must be String

host[host_parameters_attributes][value]
wymagany

Wartość parametru

Validations:

  • Must be String

host[build]
opcjonalny

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[enabled]
opcjonalny

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[provision_method]
opcjonalny

Validations:

  • Must be String

host[managed]
opcjonalny

Flaga o wartościach Prawda (host jest zarządzany) lub fałsz (nie jest). Uwaga: wartość również określa czy kilka parametrów jest wymaganych lub nie

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[progress_report_id]
opcjonalny

UUID do śledzenia statusu zadań orkiestracji, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be String

host[comment]
opcjonalny

Dodatkowe informacje o tym hoście

Validations:

  • Must be String

host[capabilities]
opcjonalny

Validations:

  • Must be String

host[compute_profile_id]
opcjonalny

Validations:

  • Must be a number.

host[compute_attributes]
opcjonalny

Validations:

  • Must be a Hash


PUT /api/hosts/:id
Update a host.

Parametry

Nazwa parametru Opis
id
wymagany

Validations:

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

host
wymagany

Validations:

  • Must be a Hash

host[name]
opcjonalny

Validations:

  • Must be String

host[environment_id]
opcjonalny

Validations:

  • Must be String

host[ip]
opcjonalny

IPv4 address, not required if using a subnet with dhcp proxy

Validations:

  • Must be String

host[ip6]
opcjonalny

IPv6 address

Validations:

  • Must be String

host[mac]
opcjonalny

not required if its a virtual machine

Validations:

  • Must be String

host[architecture_id]
opcjonalny

Validations:

  • Must be a number.

host[domain_id]
opcjonalny

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcjonalny

Validations:

  • Must be a number.

host[operatingsystem_id]
opcjonalny

Validations:

  • Must be String

host[puppetclass_ids]
opcjonalny

Validations:

  • Must be an array of any type

host[medium_id]
opcjonalny

Validations:

  • Must be a number.

host[ptable_id]
opcjonalny

Validations:

  • Must be a number.

host[subnet_id]
opcjonalny

IPv4 subnet

Validations:

  • Must be a number.

host[subnet6_id]
opcjonalny

IPv6 subnet

Validations:

  • Must be a number.

host[compute_resource_id]
opcjonalny

Validations:

  • Must be a number.

host[sp_subnet_id]
opcjonalny

Validations:

  • Must be a number.

host[model_id]
opcjonalny

Validations:

  • Must be a number.

host[hostgroup_id]
opcjonalny

Validations:

  • Must be a number.

host[owner_id]
opcjonalny

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcjonalny

Validations:

  • Must be a number.

host[image_id]
opcjonalny

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcjonalny

Validations:

  • Must be an array of any type

host[build]
opcjonalny

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[enabled]
opcjonalny

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[provision_method]
opcjonalny

Validations:

  • Must be String

host[managed]
opcjonalny

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[progress_report_id]
opcjonalny

UUID do śledzenia statusu zadań orkiestracji, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be String

host[capabilities]
opcjonalny

Validations:

  • Must be String

host[compute_attributes]
opcjonalny

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
Delete an host.

Parametry

Nazwa parametru Opis
id
wymagany

Validations:

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


GET /api/hosts/:id/status
Pokaż status hosta

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

Parametry

Nazwa parametru Opis
id
wymagany

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.