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

Parameter

Parametername Beschreibung
thin
optional

Only list ID and name of hosts

Validations:

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

hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String

location_id
optional

Standortkennung

Validations:

  • Must be a String

organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String

environment_id
optional

Umgebungskennung

Validations:

  • Must be a String

include
optional

Array of extra information types to include

Validations:

  • Must be an array of [“parameters”, “all_parameters”]

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Ergebnisse sortieren

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


GET /api/hosts/:id
Host anzeigen

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.

show_hidden_parameters
optional

Display hidden parameter values

Validations:

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


POST /api/hosts
Host erstellen

Parameter

Parametername Beschreibung
host
verpflichtend

Validations:

  • Must be a Hash

host[name]
verpflichtend

Validations:

  • Must be a 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 , nil erlaubt

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

Validations:

  • Must be a String

host[ip]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[mac]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[architecture_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

host[domain_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

host[realm_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional , nil erlaubt

Puppet-Proxy-Kennung

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional , nil erlaubt

Puppet-CA-Proxy-Kennung

Validations:

  • Must be a number.

host[puppetclass_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type

host[config_group_ids]
optional , nil erlaubt

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[medium_id]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[pxe_loader]
optional , nil erlaubt

DHCP-Dateinamensoption (Standardmäßig Grub2/PXELinux)

Validations:

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

host[ptable_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

host[subnet_id]
optional , nil erlaubt

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 erlaubt

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

Validations:

  • Must be a number.

host[root_pass]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[model_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[hostgroup_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_type]
optional , nil erlaubt

Eigentümertyp des Hosts

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional , nil erlaubt

Hostparameter (Array oder indizierter Hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
verpflichtend

Name des Parameters

Validations:

  • Must be a String

host[host_parameters_attributes][value]
verpflichtend

Parameterwert

Validations:

  • Must be a String

host[build]
optional , nil erlaubt

Validations:

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

host[enabled]
optional , nil erlaubt

Diesen Host in das Foreman-Reporting aufnehmen

Validations:

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

host[provision_method]
optional , nil erlaubt

Methode, die zur Bereitstellung des Hosts verwendet wurde. Mögliche Bereitstellungsmethoden sind build (Netzwerkbasierend), image (Abbildbasierend)

Validations:

  • Must be a String

host[managed]
optional , nil erlaubt

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 one of: true, false, 1, 0

host[progress_report_id]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[comment]
optional , nil erlaubt

Weitere Informationen über diesen Host

Validations:

  • Must be a String

host[capabilities]
optional , nil erlaubt

Validations:

  • Must be a String

host[compute_profile_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[interfaces_attributes]
optional , nil erlaubt

Netzwerkschnittstelle des Hosts

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][ip]
optional , nil erlaubt

IPv4-Adresse der Schnittstelle

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
optional , nil erlaubt

IPv6-Adresse der Schnittstelle

Validations:

  • Must be a String

host[interfaces_attributes][type]
optional , nil erlaubt

Schnittstellentyp, z.B. BMC. Standard ist interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
optional , nil erlaubt

DNS-Name der Schnittstelle

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
optional , nil erlaubt

Foreman-ID des IPv4-Subnetzes zur Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optional , nil erlaubt

Foreman-ID des IPv6-Subnetzes zur Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][managed]
optional , nil erlaubt

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

Validations:

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

host[interfaces_attributes][primary]
optional , nil erlaubt

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

Validations:

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

host[interfaces_attributes][provision]
optional , nil erlaubt

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

Validations:

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

host[interfaces_attributes][username]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][password]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
optional , nil erlaubt

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

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil erlaubt

Alias oder VLAN-Gerät

Validations:

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

host[interfaces_attributes][tag]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][attached_to]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][mode]
optional , nil erlaubt

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

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
optional , nil erlaubt

Kennungen von verbundenen Schnittstellen, z.B. `['eth1', 'eth2']`. Für Bond-Schnittstellen sind diese die Slaves. Nur für Bond- und Bridge-Schnittstellen.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
optional , nil erlaubt

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

Validations:

  • Must be a Hash

host[compute_attributes]
optional , nil erlaubt

Zusätzliche Rechenressourcen-spezifische Attribute

Validations:

  • Must be a Hash


PUT /api/hosts/:id
Host Aktualisieren

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

host[location_id]
optional

erforderlich, wenn Standorte aktiviert sind

Validations:

  • Must be a number.

host[organization_id]
optional

erforderlich, wenn Organisationen aktiviert sind

Validations:

  • Must be a number.

host[environment_id]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[ip]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[mac]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[architecture_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

host[domain_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

host[realm_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional , nil erlaubt

Puppet-Proxy-Kennung

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional , nil erlaubt

Puppet-CA-Proxy-Kennung

Validations:

  • Must be a number.

host[puppetclass_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type

host[config_group_ids]
optional , nil erlaubt

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[medium_id]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[pxe_loader]
optional , nil erlaubt

DHCP-Dateinamensoption (Standardmäßig Grub2/PXELinux)

Validations:

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

host[ptable_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

host[subnet_id]
optional , nil erlaubt

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 erlaubt

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

Validations:

  • Must be a number.

host[root_pass]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[model_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[hostgroup_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_type]
optional , nil erlaubt

Eigentümertyp des Hosts

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional , nil erlaubt

Hostparameter (Array oder indizierter Hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
optional

Name des Parameters

Validations:

  • Must be a String

host[host_parameters_attributes][value]
optional

Parameterwert

Validations:

  • Must be a String

host[build]
optional , nil erlaubt

Validations:

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

host[enabled]
optional , nil erlaubt

Diesen Host in das Foreman-Reporting aufnehmen

Validations:

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

host[provision_method]
optional , nil erlaubt

Methode, die zur Bereitstellung des Hosts verwendet wurde. Mögliche Bereitstellungsmethoden sind build (Netzwerkbasierend), image (Abbildbasierend)

Validations:

  • Must be a String

host[managed]
optional , nil erlaubt

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 one of: true, false, 1, 0

host[progress_report_id]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[comment]
optional , nil erlaubt

Weitere Informationen über diesen Host

Validations:

  • Must be a String

host[capabilities]
optional , nil erlaubt

Validations:

  • Must be a String

host[compute_profile_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[interfaces_attributes]
optional , nil erlaubt

Netzwerkschnittstelle des Hosts

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][ip]
optional , nil erlaubt

IPv4-Adresse der Schnittstelle

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
optional , nil erlaubt

IPv6-Adresse der Schnittstelle

Validations:

  • Must be a String

host[interfaces_attributes][type]
optional , nil erlaubt

Schnittstellentyp, z.B. BMC. Standard ist interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
optional , nil erlaubt

DNS-Name der Schnittstelle

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
optional , nil erlaubt

Foreman-ID des IPv4-Subnetzes zur Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optional , nil erlaubt

Foreman-ID des IPv6-Subnetzes zur Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][managed]
optional , nil erlaubt

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

Validations:

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

host[interfaces_attributes][primary]
optional , nil erlaubt

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

Validations:

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

host[interfaces_attributes][provision]
optional , nil erlaubt

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

Validations:

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

host[interfaces_attributes][username]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][password]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
optional , nil erlaubt

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

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil erlaubt

Alias oder VLAN-Gerät

Validations:

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

host[interfaces_attributes][tag]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][attached_to]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][mode]
optional , nil erlaubt

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

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
optional , nil erlaubt

Kennungen von verbundenen Schnittstellen, z.B. `['eth1', 'eth2']`. Für Bond-Schnittstellen sind diese die Slaves. Nur für Bond- und Bridge-Schnittstellen.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil erlaubt

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

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
optional , nil erlaubt

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

Validations:

  • Must be a Hash

host[compute_attributes]
optional , nil erlaubt

Zusätzliche Rechenressourcen-spezifische Attribute

Validations:

  • Must be a Hash


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

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/enc
Get ENC values of 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.


GET /api/hosts/:id/status
Konfigurationsstatus des Hosts abholen

Return value may either be one of the following:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

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.


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

Returns string representing a host status of a given type

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.

type
verpflichtend

Statustyp, einer von

  • Global

  • Konfiguration

  • Build

Validations:

  • 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

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.


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

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.


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

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.

power_action
verpflichtend

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

Validations:

  • Must be a String


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

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.

device
verpflichtend

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

Validations:

  • Must be a String


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

Parameter

Parametername Beschreibung
name
verpflichtend

Hostname des Hosts

Validations:

  • Must be a String

facts
verpflichtend

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

Validations:

  • Must be a Hash

certname
optional

optional: Certname des Hosts

Validations:

  • Must be a String

type
optional

optional: der STI-Typ des zu erstellenden Hosts

Validations:

  • Must be a String


PUT /api/hosts/:id/rebuild_config
Orchestrierungs-Konfig neu erstellen

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.

only
optional

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
Inhaltsvorschau der gerenderten Bereitstellungsvorlage

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.

kind
verpflichtend

Vorlagenarten, verfügbare Werte: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP

Validations:

  • Must be a String