GET /api/hosts
List all hosts.

Parameter

Parametername Beschreibung
search
optional

Filter results

Validations:

  • Must be String

order
optional

Sort results

Validations:

  • Must be String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be String


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

Parameter

Parametername Beschreibung
id
verpflichtend

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.

Parameter

Parametername Beschreibung
host
verpflichtend

Validations:

  • Must be a Hash

host[name]
verpflichtend

Validations:

  • Must be String

host[location_id]
verpflichtend

erforderlich, wenn Standorte aktiviert sind

Validations:

  • Must be a number.

host[organization_id]
verpflichtend

erforderlich, wenn Organisationen aktiviert sind

Validations:

  • Must be a number.

host[environment_id]
optional

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be String

host[ip]
optional

nicht erforderlich, wenn ein Subnetz mit DHCP-Proxy verwendet wird

Validations:

  • Must be String

host[mac]
optional

erforderlich für Bare-Metal-Host, nicht erforderlich, wenn der Host eine virtuelle Maschine ist

Validations:

  • Must be String

host[architecture_id]
optional

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[domain_id]
optional

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[realm_id]
optional

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional

Validations:

  • Must be a number.

host[puppetclass_ids]
optional

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be String

host[medium_id]
optional

erforderlich, wenn die Bereitstellung nicht image-basiert, der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be String

host[ptable_id]
optional

erforderlich, wenn der Host gemanagt und keine spezifische Partition definiert ist

Validations:

  • Must be a number.

host[subnet_id]
optional

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[compute_resource_id]
optional

“nil” bedeutet, dass es sich um einen Bare-Metal-Host handelt

Validations:

  • Must be a number.

host[root_pass]
optional

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe oder einem Standardpasswort in den Einstellungen vererbt ist

Validations:

  • Must be String

host[model_id]
optional

Validations:

  • Must be a number.

host[hostgroup_id]
optional

Validations:

  • Must be a number.

host[owner_id]
optional

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional

Validations:

  • Must be a number.

host[image_id]
optional

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
verpflichtend

Name des Parameters

Validations:

  • Must be String

host[host_parameters_attributes][value]
verpflichtend

Parameterwert

Validations:

  • Must be String

host[build]
optional

Validations:

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

host[enabled]
optional

Validations:

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

host[provision_method]
optional

Validations:

  • Must be String

host[managed]
optional

True/False-Flag, ob ein Host gemanagt oder ungemanagt ist. Hinweis: Dieser Wert bestimmt außerdem, ob mehrere Parameter erforderlich sind oder nicht.

Validations:

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

host[progress_report_id]
optional

UUID zum Tracken des Status der Orchestrierungsaufgaben, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be String

host[comment]
optional

Weitere Informationen über diesen Host

Validations:

  • Must be String

host[capabilities]
optional

Validations:

  • Must be String

host[compute_profile_id]
optional

Validations:

  • Must be a number.

host[compute_attributes]
optional

Validations:

  • Must be a Hash


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

Parameter

Parametername Beschreibung
id
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

host[name]
optional

Validations:

  • Must be String

host[environment_id]
optional

Validations:

  • Must be String

host[ip]
optional

not required if using a subnet with dhcp proxy

Validations:

  • Must be String

host[mac]
optional

not required if its a virtual machine

Validations:

  • Must be String

host[architecture_id]
optional

Validations:

  • Must be a number.

host[domain_id]
optional

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional

Validations:

  • Must be a number.

host[operatingsystem_id]
optional

Validations:

  • Must be String

host[puppetclass_ids]
optional

Validations:

  • Must be an array of any type

host[medium_id]
optional

Validations:

  • Must be a number.

host[ptable_id]
optional

Validations:

  • Must be a number.

host[subnet_id]
optional

Validations:

  • Must be a number.

host[compute_resource_id]
optional

Validations:

  • Must be a number.

host[sp_subnet_id]
optional

Validations:

  • Must be a number.

host[model_id]
optional

Validations:

  • Must be a number.

host[hostgroup_id]
optional

Validations:

  • Must be a number.

host[owner_id]
optional

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional

Validations:

  • Must be a number.

host[image_id]
optional

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional

Validations:

  • Must be an array of any type

host[build]
optional

Validations:

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

host[enabled]
optional

Validations:

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

host[provision_method]
optional

Validations:

  • Must be String

host[managed]
optional

Validations:

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

host[progress_report_id]
optional

UUID zum Tracken des Status der Orchestrierungsaufgaben, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be String

host[capabilities]
optional

Validations:

  • Must be String

host[compute_attributes]
optional

Validations:

  • Must be a Hash


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

Parameter

Parametername Beschreibung
id
verpflichtend

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
Hoststatus abholen

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

Parameter

Parametername Beschreibung
id
verpflichtend

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.