GET /api/hosts/:host_id/interfaces
Lista wszystkich interfejsów hostu

GET /api/domains/:domain_id/interfaces
Lista wszystkich interfejsów domeny

GET /api/subnets/:subnet_id/interfaces
Lista wszystkich interfejsów podsieci

Przykłady

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
    }
  ]
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
wymagany

ID lub nazwa hosta

Validations:

  • Must be a String

domain_id
opcjonalny

ID lub nazwa domeny

Validations:

  • Must be a String

subnet_id
opcjonalny

ID lub nazwa podsieci

Validations:

  • Must be a String

page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.

per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.


GET /api/hosts/:host_id/interfaces/:id
Pokaż interfejs dla hosta

Przykłady

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
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
wymagany

ID lub nazwa hosta

Validations:

  • Must be a String

id
wymagany

ID lub nazwa dla interfejsu

Validations:

  • Must be a String


POST /api/hosts/:host_id/interfaces
Utwórz interfejs na hoście

Przykłady

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"
    ]
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
wymagany

ID lub nazwa hosta

Validations:

  • Must be a String

interface
wymagany

Informacje o interfejsie

Validations:

  • Must be a Hash

interface[mac]
opcjonalny , nil dopuszczalny

MAC adres interfejsu. Wymagany do zarządzania interfejsem maszyny

Validations:

  • Must be a String

interface[ip]
opcjonalny , nil dopuszczalny

IPv4 address of interface

Validations:

  • Must be a String

interface[ip6]
opcjonalny , nil dopuszczalny

IPv6 address of interface

Validations:

  • Must be a String

interface[type]
opcjonalny , nil dopuszczalny

Typ interfejsu, np. BMC. Domyślnie ma wartość interface

Validations:

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

interface[name]
opcjonalny , nil dopuszczalny

Nazwa DNS interfejsu

Validations:

  • Must be a String

interface[subnet_id]
opcjonalny , nil dopuszczalny

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

interface[subnet6_id]
opcjonalny , nil dopuszczalny

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

interface[domain_id]
opcjonalny , nil dopuszczalny

ID domeny interfejsu Foremana. Wymagany dla pierwszego interfejsu zarządzanego hostu

Validations:

  • Must be a number.

interface[identifier]
opcjonalny , nil dopuszczalny

identyfikator wejścia, np. eth0 lub eth1.1

Validations:

  • Must be a String

interface[managed]
opcjonalny , nil dopuszczalny

Czy na pewno interfejs powinien być zarządzany przez DHCP i DNS smart proxy i powinien być konfigurowany podczas dostawy?

Validations:

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

interface[primary]
opcjonalny , nil dopuszczalny

Czy interfejs ma zostać użyty do konstrukcji FQDN hosta? Każdy zarządzany host potrzebuje jednego pierwszego interfejsu.

Validations:

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

interface[provision]
opcjonalny , nil dopuszczalny

Czy interfejs ma zostać użyty przez TFTP dla PXELinux (lub SSH dla bazującego na obrazie hostu)? Każdy zarządzany host potrzebuje jednego interfejsu - dostawcy

Validations:

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

interface[username]
opcjonalny , nil dopuszczalny

Tylko dla interfejsu BMC.

Validations:

  • Must be a String

interface[password]
opcjonalny , nil dopuszczalny

Tylko dla interfejsu BMC.

Validations:

  • Must be a String

interface[provider]
opcjonalny , nil dopuszczalny

Dostawca interfejsu,np. IPMI. Tylko dla interfejsu BMC.

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
opcjonalny , nil dopuszczalny

Alias lub urządzenie VLAN

Validations:

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

interface[tag]
opcjonalny , nil dopuszczalny

VLAN tag, ten atrybut ma pierwszeństwo przed podsiecią VLAN ID. tylko dla wirtualnych interfejsów.

Validations:

  • Must be a String

interface[mtu]
opcjonalny , nil dopuszczalny

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

interface[attached_to]
opcjonalny , nil dopuszczalny

Identyfikator interfejsu do rozpoznania do kogo on należy, np. eth1. Tylko dla wirtualnych interfejsów.

Validations:

  • Must be a String

interface[mode]
opcjonalny , nil dopuszczalny

Bond Mode interfejsu np. balance-rr. Tylko dla złączonych interfejsów

Validations:

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

interface[attached_devices]
opcjonalny , nil dopuszczalny

Identyfikatory zależnych interfejsów,np. ['eth1', 'eth2']. Tylko dla złączonych interfejsów.

Validations:

  • Must be an array of any type

interface[bond_options]
opcjonalny , nil dopuszczalny

Oddzielone odstępem opcje, np. miiom=100. Tylko dla złączonych interfejsów.

Validations:

  • Must be a String

interface[compute_attributes]
opcjonalny , nil dopuszczalny

Dodatkowe zasoby obliczeniowe specyficznych atrybutów interfejsu.

Validations:

  • Must be a Hash


PUT /api/hosts/:host_id/interfaces/:id
Aktualizuj interfejs hosta

Przykłady

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
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
wymagany

ID lub nazwa hosta

Validations:

  • Must be a String

id
wymagany

ID interfejsu

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
wymagany

Informacje o interfejsie

Validations:

  • Must be a Hash

interface[mac]
opcjonalny , nil dopuszczalny

MAC adres interfejsu. Wymagany do zarządzania interfejsem maszyny

Validations:

  • Must be a String

interface[ip]
opcjonalny , nil dopuszczalny

IPv4 address of interface

Validations:

  • Must be a String

interface[ip6]
opcjonalny , nil dopuszczalny

IPv6 address of interface

Validations:

  • Must be a String

interface[type]
opcjonalny , nil dopuszczalny

Typ interfejsu, np. BMC. Domyślnie ma wartość interface

Validations:

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

interface[name]
opcjonalny , nil dopuszczalny

Nazwa DNS interfejsu

Validations:

  • Must be a String

interface[subnet_id]
opcjonalny , nil dopuszczalny

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

interface[subnet6_id]
opcjonalny , nil dopuszczalny

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

interface[domain_id]
opcjonalny , nil dopuszczalny

ID domeny interfejsu Foremana. Wymagany dla pierwszego interfejsu zarządzanego hostu

Validations:

  • Must be a number.

interface[identifier]
opcjonalny , nil dopuszczalny

identyfikator wejścia, np. eth0 lub eth1.1

Validations:

  • Must be a String

interface[managed]
opcjonalny , nil dopuszczalny

Czy na pewno interfejs powinien być zarządzany przez DHCP i DNS smart proxy i powinien być konfigurowany podczas dostawy?

Validations:

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

interface[primary]
opcjonalny , nil dopuszczalny

Czy interfejs ma zostać użyty do konstrukcji FQDN hosta? Każdy zarządzany host potrzebuje jednego pierwszego interfejsu.

Validations:

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

interface[provision]
opcjonalny , nil dopuszczalny

Czy interfejs ma zostać użyty przez TFTP dla PXELinux (lub SSH dla bazującego na obrazie hostu)? Każdy zarządzany host potrzebuje jednego interfejsu - dostawcy

Validations:

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

interface[username]
opcjonalny , nil dopuszczalny

Tylko dla interfejsu BMC.

Validations:

  • Must be a String

interface[password]
opcjonalny , nil dopuszczalny

Tylko dla interfejsu BMC.

Validations:

  • Must be a String

interface[provider]
opcjonalny , nil dopuszczalny

Dostawca interfejsu,np. IPMI. Tylko dla interfejsu BMC.

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
opcjonalny , nil dopuszczalny

Alias lub urządzenie VLAN

Validations:

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

interface[tag]
opcjonalny , nil dopuszczalny

VLAN tag, ten atrybut ma pierwszeństwo przed podsiecią VLAN ID. tylko dla wirtualnych interfejsów.

Validations:

  • Must be a String

interface[mtu]
opcjonalny , nil dopuszczalny

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

interface[attached_to]
opcjonalny , nil dopuszczalny

Identyfikator interfejsu do rozpoznania do kogo on należy, np. eth1. Tylko dla wirtualnych interfejsów.

Validations:

  • Must be a String

interface[mode]
opcjonalny , nil dopuszczalny

Bond Mode interfejsu np. balance-rr. Tylko dla złączonych interfejsów

Validations:

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

interface[attached_devices]
opcjonalny , nil dopuszczalny

Identyfikatory zależnych interfejsów,np. ['eth1', 'eth2']. Tylko dla złączonych interfejsów.

Validations:

  • Must be an array of any type

interface[bond_options]
opcjonalny , nil dopuszczalny

Oddzielone odstępem opcje, np. miiom=100. Tylko dla złączonych interfejsów.

Validations:

  • Must be a String

interface[compute_attributes]
opcjonalny , nil dopuszczalny

Dodatkowe zasoby obliczeniowe specyficznych atrybutów interfejsu.

Validations:

  • Must be a Hash


DELETE /api/hosts/:host_id/interfaces/:id
Usuń interfejs z hosta

Przykłady

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"
    ]
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

host_id
wymagany

ID lub nazwa hosta

Validations:

  • Must be a String

id
wymagany

ID interfejsu

Validations:

  • Must be a String