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

Beispiele

GET /api/hosts/host368/interfaces
200
{
  "total": 3,
  "subtotal": 3,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-11-07 08:37:16 UTC",
      "updated_at": "2019-11-07 08:37:16 UTC",
      "managed": true,
      "identifier": null,
      "id": 53,
      "name": "host368",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host368",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-11-07 08:37:16 UTC",
      "updated_at": "2019-11-07 08:37:16 UTC",
      "managed": true,
      "identifier": "eth184",
      "id": 54,
      "name": null,
      "ip": "0.0.0.38",
      "ip6": null,
      "mac": "00:33:45:ab:00:4e",
      "mtu": null,
      "fqdn": null,
      "primary": false,
      "provision": false,
      "type": "interface",
      "virtual": false
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-11-07 08:37:16 UTC",
      "updated_at": "2019-11-07 08:37:16 UTC",
      "managed": true,
      "identifier": "eth185",
      "id": 55,
      "name": null,
      "ip": "0.0.0.39",
      "ip6": null,
      "mac": "00:33:45:ab:00:4f",
      "mtu": null,
      "fqdn": null,
      "primary": false,
      "provision": false,
      "type": "bond",
      "mode": "balance-rr",
      "attached_devices": "",
      "bond_options": "",
      "virtual": true
    }
  ]
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be a String

domain_id
optional

Kennung oder Name der Domäne

Validations:

  • Must be a String

subnet_id
optional

Kennung oder Name des Subnetzes

Validations:

  • Must be a String

page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.

per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.


GET /api/hosts/:host_id/interfaces/:id
Schnittstelle für den Host anzeigen

Beispiele

GET /api/hosts/host369/interfaces/57
200
{
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "domain_id": null,
  "domain_name": null,
  "created_at": "2019-11-07 08:37:16 UTC",
  "updated_at": "2019-11-07 08:37:16 UTC",
  "managed": true,
  "identifier": "eth186",
  "id": 57,
  "name": null,
  "ip": "0.0.0.40",
  "ip6": null,
  "mac": "00:33:45:ab:00:50",
  "mtu": null,
  "fqdn": null,
  "primary": false,
  "provision": false,
  "type": "interface",
  "virtual": false
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be a String

id
verpflichtend

Kennung oder Name der Schnittstelle

Validations:

  • Must be a String


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

Beispiele

POST /api/hosts/26/interfaces
{
  "interface": {
    "name": "谚喪駏篬庿濱麢鐨耼孞",
    "ip": "10.0.1.1",
    "mac": "AA:AA:AA:AA:AA:AA",
    "username": "foo",
    "password": "bar",
    "provider": "IPMI",
    "type": "bmc",
    "ip6": "2001:db8::1"
  }
}
422
{
  "error": {
    "id": null,
    "errors": {
      "name": [
        "hostname can contain only lowercase letters, numbers, dashes and dots according to RFC921, RFC952 and RFC1123"
      ]
    },
    "full_messages": [
      "Name hostname can contain only lowercase letters, numbers, dashes and dots according to RFC921, RFC952 and RFC1123"
    ]
  }
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be a 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 a String

interface[ip]
optional , nil erlaubt

IPv4-Adresse der Schnittstelle

Validations:

  • Must be a String

interface[ip6]
optional , nil erlaubt

IPv6-Adresse der Schnittstelle

Validations:

  • Must be a 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 a String

interface[subnet_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv4 Schnittstelle

Validations:

  • Must be a number.

interface[subnet6_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv6 Schnittstelle

Validations:

  • Must be a number.

interface[domain_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

interface[identifier]
optional , nil erlaubt

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

Validations:

  • Must be a 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 one of: true, false, 1, 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 one of: true, false, 1, 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 one of: true, false, 1, 0.

interface[username]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

interface[password]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

interface[provider]
optional , nil erlaubt

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

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
optional , nil erlaubt

Alias oder VLAN-Gerät

Validations:

  • Must be one of: true, false, 1, 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 a String

interface[mtu]
optional , nil erlaubt

MTU. Dieser Wert hat Vorrang über die Subnetz MTU.

Validations:

  • Must be a Integer

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

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

interface[bond_options]
optional , nil erlaubt

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

Validations:

  • Must be a String

interface[compute_attributes]
optional , nil erlaubt

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

Validations:

  • Must be a Hash


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

Beispiele

PUT /api/hosts/host360/interfaces/30
{
  "interface": {
    "name": "test.foreman.com",
    "ip": "10.0.1.1",
    "mac": "AA:AA:AA:AA:AA:AA",
    "username": "foo",
    "password": "bar",
    "provider": "IPMI",
    "ip6": "2001:db8::1"
  }
}
200
{
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "domain_id": null,
  "domain_name": null,
  "created_at": "2019-11-07 08:37:15 UTC",
  "updated_at": "2019-11-07 08:37:15 UTC",
  "managed": true,
  "identifier": "eth169",
  "id": 30,
  "name": "test.foreman.com",
  "ip": "10.0.1.1",
  "ip6": "2001:db8::1",
  "mac": "aa:aa:aa:aa:aa:aa",
  "mtu": null,
  "fqdn": "test.foreman.com",
  "primary": false,
  "provision": false,
  "type": "interface",
  "virtual": false
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be a 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 a String

interface[ip]
optional , nil erlaubt

IPv4-Adresse der Schnittstelle

Validations:

  • Must be a String

interface[ip6]
optional , nil erlaubt

IPv6-Adresse der Schnittstelle

Validations:

  • Must be a 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 a String

interface[subnet_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv4 Schnittstelle

Validations:

  • Must be a number.

interface[subnet6_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv6 Schnittstelle

Validations:

  • Must be a number.

interface[domain_id]
optional , nil erlaubt

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

Validations:

  • Must be a number.

interface[identifier]
optional , nil erlaubt

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

Validations:

  • Must be a 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 one of: true, false, 1, 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 one of: true, false, 1, 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 one of: true, false, 1, 0.

interface[username]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

interface[password]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

interface[provider]
optional , nil erlaubt

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

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
optional , nil erlaubt

Alias oder VLAN-Gerät

Validations:

  • Must be one of: true, false, 1, 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 a String

interface[mtu]
optional , nil erlaubt

MTU. Dieser Wert hat Vorrang über die Subnetz MTU.

Validations:

  • Must be a Integer

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

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

interface[bond_options]
optional , nil erlaubt

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

Validations:

  • Must be a String

interface[compute_attributes]
optional , nil erlaubt

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

Validations:

  • Must be a Hash


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

Beispiele

DELETE /api/hosts/32/interfaces/45
{
  "interface": {}
}
422
{
  "error": {
    "id": 45,
    "errors": {
      "primary": [
        "can't delete primary interface of managed host"
      ],
      "provision": [
        "can't delete provision interface of managed host"
      ]
    },
    "full_messages": [
      "Primary can't delete primary interface of managed host",
      "Provision can't delete provision interface of managed host"
    ]
  }
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
verpflichtend

Kennung oder Name des Hosts

Validations:

  • Must be a String

id
verpflichtend

Kennung der Schnittstelle

Validations:

  • Must be a String