GET /api/hosts/:host_id/interfaces
Alle Host-Schnittstellen auflisten

GET /api/domains/:domain_id/interfaces
Alle Schnittstellen für Domäne auflisten

GET /api/subnets/:subnet_id/interfaces
Alle Schnittstellen für das Subnetz auflisten

Parameter

Parametername Beschreibung
host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be String

domain_id
optional

Kennung oder Name der Domäne

Validations:

  • Must be String

subnet_id
optional

Kennung oder Name des Subnetzes

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/:host_id/interfaces/:id
Schnittstelle für den Host anzeigen

Parameter

Parametername Beschreibung
host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be String

id
verpflichtend

Kennung oder Name der Schnittstelle

Validations:

  • Must be String


POST /api/hosts/:host_id/interfaces
Schnittstelle auf einem Host erstellen

Parameter

Parametername Beschreibung
host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be String

interface
verpflichtend

Schnittstelleninformation

Validations:

  • Must be a Hash

interface[mac]
optional , nil erlaubt

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

Validations:

  • Must be String

interface[ip]
optional , nil erlaubt

IP-Adresse der Schnittstelle

Validations:

  • Must be String

interface[type]
optional , nil erlaubt

Schnittstellentyp, z.B. BMC. Standard ist interface

Validations:

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

interface[name]
optional , nil erlaubt

DNS-Name der Schnittstelle

Validations:

  • Must be String

interface[subnet_id]
optional , nil erlaubt

Foreman-Subnetzkennung der Schnittstelle

Validations:

  • Must be Fixnum

interface[domain_id]
optional , nil erlaubt

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

Validations:

  • Must be Fixnum

interface[identifier]
optional , nil erlaubt

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

Validations:

  • Must be String

interface[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 'true' or 'false' or '1' or '0'

interface[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 'true' or 'false' or '1' or '0'

interface[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 'true' or 'false' or '1' or '0'

interface[username]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be String

interface[password]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be String

interface[provider]
optional , nil erlaubt

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

Validations:

  • Must be one of: IPMI.

interface[virtual]
optional , nil erlaubt

Alias oder VLAN-Gerät

Validations:

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

interface[tag]
optional , nil erlaubt

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

Validations:

  • Must be String

interface[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 String

interface[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.

interface[attached_devices]
optional , nil erlaubt

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

Validations:

  • Must be an array of any type

interface[bond_options]
optional , nil erlaubt

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

Validations:

  • Must be String

interface[compute_attributes]
optional , nil erlaubt

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

Validations:

  • Must be Hash


PUT /api/hosts/:host_id/interfaces/:id
Host-Schnittstelle aktualisieren

Parameter

Parametername Beschreibung
host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be String

id
verpflichtend

Kennung der Schnittstelle

Validations:

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

interface
verpflichtend

Schnittstelleninformation

Validations:

  • Must be a Hash

interface[mac]
optional , nil erlaubt

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

Validations:

  • Must be String

interface[ip]
optional , nil erlaubt

IP-Adresse der Schnittstelle

Validations:

  • Must be String

interface[type]
optional , nil erlaubt

Schnittstellentyp, z.B. BMC. Standard ist interface

Validations:

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

interface[name]
optional , nil erlaubt

DNS-Name der Schnittstelle

Validations:

  • Must be String

interface[subnet_id]
optional , nil erlaubt

Foreman-Subnetzkennung der Schnittstelle

Validations:

  • Must be Fixnum

interface[domain_id]
optional , nil erlaubt

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

Validations:

  • Must be Fixnum

interface[identifier]
optional , nil erlaubt

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

Validations:

  • Must be String

interface[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 'true' or 'false' or '1' or '0'

interface[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 'true' or 'false' or '1' or '0'

interface[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 'true' or 'false' or '1' or '0'

interface[username]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be String

interface[password]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be String

interface[provider]
optional , nil erlaubt

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

Validations:

  • Must be one of: IPMI.

interface[virtual]
optional , nil erlaubt

Alias oder VLAN-Gerät

Validations:

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

interface[tag]
optional , nil erlaubt

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

Validations:

  • Must be String

interface[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 String

interface[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.

interface[attached_devices]
optional , nil erlaubt

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

Validations:

  • Must be an array of any type

interface[bond_options]
optional , nil erlaubt

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

Validations:

  • Must be String

interface[compute_attributes]
optional , nil erlaubt

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

Validations:

  • Must be Hash


DELETE /api/hosts/:host_id/interfaces/:id
Host-Schnittstelle löschen

Parameter

Parametername Beschreibung
host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be String

id
verpflichtend

Kennung der Schnittstelle

Validations:

  • Must be String