GET /api/hosts/:host_id/interfaces
호스트의 모든 인터페이스 목록 나열

GET /api/domains/:domain_id/interfaces
도메인의 모든 인터페이스 목록 나열

GET /api/subnets/:subnet_id/interfaces
서브넷의 모든 인터페이스 목록 나열

Examples

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

Params

Param Name Description
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
Required

ID 또는 호스트 이름

Validations:

  • Must be a String

domain_id
Optional

ID 또는 도메인 이름

Validations:

  • Must be a String

subnet_id
Optional

ID 또는 서브넷 이름

Validations:

  • Must be a String

page
Optional

1 부터 페이지 번호

Validations:

  • Must be a number.

per_page
Optional

반환할 페이지 당 결과 수

Validations:

  • Must be a number.


GET /api/hosts/:host_id/interfaces/:id
호스트의 인터페이스 표시

Examples

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
}

Params

Param Name Description
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
Required

ID 또는 호스트 이름

Validations:

  • Must be a String

id
Required

ID 또는 인터페이스 이름

Validations:

  • Must be a String


POST /api/hosts/:host_id/interfaces
호스트에 인터페이스 생성

Examples

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

Params

Param Name Description
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
Required

ID 또는 호스트 이름

Validations:

  • Must be a String

interface
Required

인터페이스 정보

Validations:

  • Must be a Hash

interface[mac]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 MAC 주소입니다. 베어 메탈에서 관리형 인터페이스에 필요합니다.

Validations:

  • Must be a String

interface[ip]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

IPv4 address of interface

Validations:

  • Must be a String

interface[ip6]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

IPv6 address of interface

Validations:

  • Must be a String

interface[type]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스 유형(예: bmc)입니다. 기본값은 interface입니다.

Validations:

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

interface[name]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 DNS 이름

Validations:

  • Must be a String

interface[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

interface[subnet6_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

interface[domain_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 Foreman 도메인 ID입니다. 관리형 호스트의 기본 인터페이스에 필요합니다.

Validations:

  • Must be a number.

interface[identifier]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

장치 식별자. 예: eth0 또는 eth1.1

Validations:

  • Must be a String

interface[managed]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

이 인터페이스는 DHCP 및 DNS 스마트 프록시를 통해 관리하고 프로비저닝 동안 설정해야 합니까?

Validations:

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

interface[primary]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

호스트의 FQDN을 구성하는 데 이 인터페이스를 사용하시겠습니까? 관리형 호스트마다 기본 인터페이스가 하나씩 필요합니다.

Validations:

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

interface[provision]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

이 인터페이스를 PXELinux의 TFTP(또는 이미지 기반 호스트의 SSH)에 사용하시겠습니까? 관리형 호스트마다 프로비저닝 인터페이스가 하나씩 필요합니다.

Validations:

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

interface[username]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

BMC 인터페이스만 해당합니다.

Validations:

  • Must be a String

interface[password]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

BMC 인터페이스만 해당합니다.

Validations:

  • Must be a String

interface[provider]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스 공급자 (예: IPMI). BMC 인터페이스의 경우에만 사용할 수 있습니다.

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

별칭 또는 VLAN 장치

Validations:

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

interface[tag]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

VLAN 태그입니다. 이 속성은 서브넷 VLAN ID 보다 우선합니다. 가상 인터페이스의 경우에만 사용됩니다.

Validations:

  • Must be a String

interface[mtu]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

interface[attached_to]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

이 인터페이스가 속한 인터페이스의 ID (예: eth1) 가상 인터페이스의 경우에만 사용할 수 있습니다.

Validations:

  • Must be a String

interface[mode]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 본드 모드 (예: balance-rr). 본드 인터페이스에만 사용됩니다.

Validations:

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

interface[attached_devices]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

연결된 인터페이스의 ID(예: ['eth1', 'eth2'])입니다. 본드 인터페이스의 경우 슬레이브가 됩니다. 본드 및 브리지 인터페이스에만 적용됩니다.

Validations:

  • Must be an array of any type

interface[bond_options]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

공백으로 구분된 옵션 (예: miimon=100). 본드 인터페이스의 경우에만 사용합니다.

Validations:

  • Must be a String

interface[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 컴퓨팅 리소스별 추가 속성입니다.

Validations:

  • Must be a Hash


PUT /api/hosts/:host_id/interfaces/:id
호스트 인터페이스 업데이트

Examples

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
}

Params

Param Name Description
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
Required

ID 또는 호스트 이름

Validations:

  • Must be a String

id
Required

인터페이스 ID

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
Required

인터페이스 정보

Validations:

  • Must be a Hash

interface[mac]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 MAC 주소입니다. 베어 메탈에서 관리형 인터페이스에 필요합니다.

Validations:

  • Must be a String

interface[ip]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

IPv4 address of interface

Validations:

  • Must be a String

interface[ip6]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

IPv6 address of interface

Validations:

  • Must be a String

interface[type]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스 유형(예: bmc)입니다. 기본값은 interface입니다.

Validations:

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

interface[name]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 DNS 이름

Validations:

  • Must be a String

interface[subnet_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

interface[subnet6_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

interface[domain_id]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 Foreman 도메인 ID입니다. 관리형 호스트의 기본 인터페이스에 필요합니다.

Validations:

  • Must be a number.

interface[identifier]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

장치 식별자. 예: eth0 또는 eth1.1

Validations:

  • Must be a String

interface[managed]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

이 인터페이스는 DHCP 및 DNS 스마트 프록시를 통해 관리하고 프로비저닝 동안 설정해야 합니까?

Validations:

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

interface[primary]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

호스트의 FQDN을 구성하는 데 이 인터페이스를 사용하시겠습니까? 관리형 호스트마다 기본 인터페이스가 하나씩 필요합니다.

Validations:

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

interface[provision]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

이 인터페이스를 PXELinux의 TFTP(또는 이미지 기반 호스트의 SSH)에 사용하시겠습니까? 관리형 호스트마다 프로비저닝 인터페이스가 하나씩 필요합니다.

Validations:

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

interface[username]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

BMC 인터페이스만 해당합니다.

Validations:

  • Must be a String

interface[password]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

BMC 인터페이스만 해당합니다.

Validations:

  • Must be a String

interface[provider]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스 공급자 (예: IPMI). BMC 인터페이스의 경우에만 사용할 수 있습니다.

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

별칭 또는 VLAN 장치

Validations:

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

interface[tag]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

VLAN 태그입니다. 이 속성은 서브넷 VLAN ID 보다 우선합니다. 가상 인터페이스의 경우에만 사용됩니다.

Validations:

  • Must be a String

interface[mtu]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

interface[attached_to]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

이 인터페이스가 속한 인터페이스의 ID (예: eth1) 가상 인터페이스의 경우에만 사용할 수 있습니다.

Validations:

  • Must be a String

interface[mode]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 본드 모드 (예: balance-rr). 본드 인터페이스에만 사용됩니다.

Validations:

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

interface[attached_devices]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

연결된 인터페이스의 ID(예: ['eth1', 'eth2'])입니다. 본드 인터페이스의 경우 슬레이브가 됩니다. 본드 및 브리지 인터페이스에만 적용됩니다.

Validations:

  • Must be an array of any type

interface[bond_options]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

공백으로 구분된 옵션 (예: miimon=100). 본드 인터페이스의 경우에만 사용합니다.

Validations:

  • Must be a String

interface[compute_attributes]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

인터페이스의 컴퓨팅 리소스별 추가 속성입니다.

Validations:

  • Must be a Hash


DELETE /api/hosts/:host_id/interfaces/:id
호스트 인터페이스 삭제

Examples

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

Params

Param Name Description
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
Required

ID 또는 호스트 이름

Validations:

  • Must be a String

id
Required

인터페이스 ID

Validations:

  • Must be a String