GET /api/hosts
Alle Hosts auflisten

GET /api/hostgroups/:hostgroup_id/hosts
Alle Hosts für eine Hostgruppe auflisten

GET /api/locations/:location_id/hosts
Hosts pro Standort auflisten

GET /api/organizations/:organization_id/hosts
Hosts pro Organisation auflisten

GET /api/environments/:environment_id/hosts
Hosts pro Umgebung auflisten

Params

Param Name Description
hostgroup_id
Optional

Kennung der Hostgruppe


Value: Must be String
location_id
Optional

Standortkennung


Value: Must be String
organization_id
Optional

Kennung der Organisation


Value: Must be String
environment_id
Optional

Umgebungskennung


Value: Must be String
search
Optional

Ergebnisse filtern


Value: Must be String
order
Optional

Ergebnisse sortieren


Value: Must be String
page
Optional

Ergebnisse nummerieren


Value: Must be String
per_page
Optional

Anzahl der Einträge pro Anfrage


Value: Must be String

GET /api/hosts/:id
Host anzeigen

Params

Param Name Description
id
Required

Value: 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
Host erstellen

Params

Param Name Description
host
Required

Value: Must be a Hash
host[name]
Required

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

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


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

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


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

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


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

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


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

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


Value: Must be a number.
host[realm_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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

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

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

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


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

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


Value: Must be String
host[ptable_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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


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

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


Value: Must be a number.
host[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[root_pass]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[model_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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

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

Value: Must be a number.
host[owner_type]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Eigentümertyp des Hosts


Value: Must be one of: User, Usergroup.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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

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

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

Value: Must be 'true' or 'false'
host[enabled]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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

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


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[comment]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Weitere Informationen über diesen Host


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

Value: Must be String
host[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[interfaces_attributes]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Netzwerkschnittstelle des Hosts


Value: Must be an Array of nested elements
host[interfaces_attributes][mac]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

MAC-Adresse der Schnittstelle. Erforderlich für gemanagte Bare-Metal-Schnittstellen.


Value: Must be String
host[interfaces_attributes][ip]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

IP-Adresse der Schnittstelle


Value: Must be String
host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Schnittstellentyp, z.B. BMC. Standard ist interface


Value: Must be one of: interface, bmc, bond.
host[interfaces_attributes][name]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

DNS-Name der Schnittstelle


Value: Must be String
host[interfaces_attributes][subnet_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Foreman-Subnetzkennung der Schnittstelle


Value: Must be Fixnum
host[interfaces_attributes][domain_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Foreman-Domänen-Kennung der Schnittstelle. Erforderlich für Primärschnittstellen auf gemanagten Hosts.


Value: Must be Fixnum
host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Gerätebezeichner, z.B. eth0 oder eth1.1


Value: Must be String
host[interfaces_attributes][managed]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Soll diese Schnittstelle über DHCP- und DNS-Smart-Proxy verwaltet werden, oder soll sie bei der Bereitstellung konfiguriert werden?


Value: Must be 'true' or 'false'
host[interfaces_attributes][primary]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Soll diese Schnittstelle zum Erstellen des FQDN des Hosts verwendet werden? Jeder gemanagte Host muss eine Primärschnittstelle aufweisen.


Value: Must be 'true' or 'false'
host[interfaces_attributes][provision]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Soll diese Schnittstelle für TFTP von PXELinux (oder SSH für image-basierte Hosts) verwendet werden? Jeder gemanagte Host muss eine Bereitstellungsschnittstelle aufweisen.


Value: Must be 'true' or 'false'
host[interfaces_attributes][username]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Nur für BMC-Schnittstellen.


Value: Must be String
host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Nur für BMC-Schnittstellen.


Value: Must be String
host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Schnittstellen-Provider, z.B. IPMI. Nur für BMC-Schnittstellen.


Value: Must be one of: IPMI.
host[interfaces_attributes][virtual]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Alias oder VLAN-Gerät


Value: Must be 'true' or 'false'
host[interfaces_attributes][tag]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

VLAN-Tag, dieses Atttribut hat Vorrang vor der Subnetz-VLAN-Kennung. Nur für virtuelle Schnittstellen.


Value: Must be String
host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Kennung der Schnittstelle, zu der diese Schnittstelle gehört, z.B. eth1. Nur für virtuelle Schnittstellen.


Value: Must be String
host[interfaces_attributes][mode]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Bond-Modus der Schnittstelle, z.B. balance-rr. Ausschließlich für Bond-Schnittstellen.


Value: Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
host[interfaces_attributes][attached_devices]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Kennungen der Slave-Schnittstellen, z.B. `[‘eth1’, ‘eth2’]`. Ausschließlich für Bond-Schnittstellen.


Value: Must be an array of any type
host[interfaces_attributes][bond_options]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Durch Leerzeichen getrennte Optionen, z.B. miimon=100. Ausschließlich für Bond-Schnittstellen.


Value: Must be String
host[interfaces_attributes][compute_attributes]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Zusätzliche rechnerressourcen-spezifische Attribute für die Schnittstelle.


Value: Must be Hash
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Zusätzliche rechnerressourcen-spezifische Attribute


Value: Must be Hash

PUT /api/hosts/:id
Host Aktualisieren

Params

Param Name Description
id
Required

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

Value: Must be a Hash
host[name]
Optional

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

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


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

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


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

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


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

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


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

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


Value: Must be a number.
host[realm_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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

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

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

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


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

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


Value: Must be String
host[ptable_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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


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

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


Value: Must be a number.
host[compute_resource_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be a number.
host[root_pass]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[model_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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

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

Value: Must be a number.
host[owner_type]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Eigentümertyp des Hosts


Value: Must be one of: User, Usergroup.
host[puppet_ca_proxy_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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

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

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

Value: Must be 'true' or 'false'
host[enabled]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be 'true' or 'false'
host[provision_method]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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

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


Value: Must be 'true' or 'false'
host[progress_report_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

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


Value: Must be String
host[comment]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Weitere Informationen über diesen Host


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

Value: Must be String
host[compute_profile_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Value: Must be a number.
host[interfaces_attributes]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Netzwerkschnittstelle des Hosts


Value: Must be an Array of nested elements
host[interfaces_attributes][mac]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

MAC-Adresse der Schnittstelle. Erforderlich für gemanagte Bare-Metal-Schnittstellen.


Value: Must be String
host[interfaces_attributes][ip]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

IP-Adresse der Schnittstelle


Value: Must be String
host[interfaces_attributes][type]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Schnittstellentyp, z.B. BMC. Standard ist interface


Value: Must be one of: interface, bmc, bond.
host[interfaces_attributes][name]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

DNS-Name der Schnittstelle


Value: Must be String
host[interfaces_attributes][subnet_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Foreman-Subnetzkennung der Schnittstelle


Value: Must be Fixnum
host[interfaces_attributes][domain_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Foreman-Domänen-Kennung der Schnittstelle. Erforderlich für Primärschnittstellen auf gemanagten Hosts.


Value: Must be Fixnum
host[interfaces_attributes][identifier]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Gerätebezeichner, z.B. eth0 oder eth1.1


Value: Must be String
host[interfaces_attributes][managed]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Soll diese Schnittstelle über DHCP- und DNS-Smart-Proxy verwaltet werden, oder soll sie bei der Bereitstellung konfiguriert werden?


Value: Must be 'true' or 'false'
host[interfaces_attributes][primary]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Soll diese Schnittstelle zum Erstellen des FQDN des Hosts verwendet werden? Jeder gemanagte Host muss eine Primärschnittstelle aufweisen.


Value: Must be 'true' or 'false'
host[interfaces_attributes][provision]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Soll diese Schnittstelle für TFTP von PXELinux (oder SSH für image-basierte Hosts) verwendet werden? Jeder gemanagte Host muss eine Bereitstellungsschnittstelle aufweisen.


Value: Must be 'true' or 'false'
host[interfaces_attributes][username]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Nur für BMC-Schnittstellen.


Value: Must be String
host[interfaces_attributes][password]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Nur für BMC-Schnittstellen.


Value: Must be String
host[interfaces_attributes][provider]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Schnittstellen-Provider, z.B. IPMI. Nur für BMC-Schnittstellen.


Value: Must be one of: IPMI.
host[interfaces_attributes][virtual]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Alias oder VLAN-Gerät


Value: Must be 'true' or 'false'
host[interfaces_attributes][tag]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

VLAN-Tag, dieses Atttribut hat Vorrang vor der Subnetz-VLAN-Kennung. Nur für virtuelle Schnittstellen.


Value: Must be String
host[interfaces_attributes][attached_to]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Kennung der Schnittstelle, zu der diese Schnittstelle gehört, z.B. eth1. Nur für virtuelle Schnittstellen.


Value: Must be String
host[interfaces_attributes][mode]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Bond-Modus der Schnittstelle, z.B. balance-rr. Ausschließlich für Bond-Schnittstellen.


Value: Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.
host[interfaces_attributes][attached_devices]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Kennungen der Slave-Schnittstellen, z.B. `[‘eth1’, ‘eth2’]`. Ausschließlich für Bond-Schnittstellen.


Value: Must be an array of any type
host[interfaces_attributes][bond_options]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Durch Leerzeichen getrennte Optionen, z.B. miimon=100. Ausschließlich für Bond-Schnittstellen.


Value: Must be String
host[interfaces_attributes][compute_attributes]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Zusätzliche rechnerressourcen-spezifische Attribute für die Schnittstelle.


Value: Must be Hash
host[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Zusätzliche rechnerressourcen-spezifische Attribute


Value: Must be Hash

DELETE /api/hosts/:id
Host löschen

Params

Param Name Description
id
Required

Value: 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
Konfigurationsstatus des Hosts abholen

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

Params

Param Name Description
id
Required

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

GET /api/hosts/:id/status/:type
Hoststatus abholen

Returns string representing a host status of a given type

Params

Param Name Description
id
Required

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

status type, can be one of

  • global

  • configuration

  • build


Value: Must be one of: HostStatus::Global, configuration, build.

GET /api/hosts/:id/vm_compute_attributes
VM-Attribute des Hosts abrufen

Return the host's compute attributes that can be used to create a clone of this VM

Params

Param Name Description
id
Required

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

PUT /api/hosts/:id/puppetrun
Puppet-Agent-Lauf auf dem Host erzwingen

Params

Param Name Description
id
Required

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

PUT /api/hosts/:id/disassociate
Host von einer VM lösen

Params

Param Name Description
id
Required

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

PUT /api/hosts/:id/power
Power-Operation auf Host ausführen

Params

Param Name Description
id
Required

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

Power-Atkionen, gültige Aktionen sind (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)


Value: Must be String

PUT /api/hosts/:id/boot
Host von angegebenem Gerät starten

Params

Param Name Description
id
Required

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

Boot Device, gültige Geräte sind Festplatte, CD-Rom, PXE, BIOS


Value: Must be String

POST /api/hosts/facts
Fakten für einen Host hochladen mit Erstellung des Hosts, wenn erforderlich

Params

Param Name Description
name
Required

Hostname des Hosts


Value: Must be String
facts
Required

Hash, der die Fakten für den Host enthält


Value: Must be Hash
certname
Optional

optional: Certname des Hosts


Value: Must be String
type
Optional

optional: der STI-Typ des zu erstellenden Hosts


Value: Must be String

PUT /api/hosts/:id/rebuild_config
Rebuild orchestration config

Params

Param Name Description
id
Required

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