Examples

POST /api/hosts
{
  "host": {
    "name": "testhost11",
    "environment_id": 334344675,
    "domain_id": 22495316,
    "ptable_id": 1007981711,
    "medium_id": 980190962,
    "architecture_id": 501905019,
    "operatingsystem_id": 1073012828,
    "puppet_proxy_id": 182953976,
    "compute_resource_id": 980190962,
    "root_pass": "xybxa6JUkz63w",
    "location_id": 255093256,
    "organization_id": 447626438,
    "interfaces_attributes": {
      "1": {
        "primary": true,
        "ip": "10.0.0.20",
        "mac": "00:11:22:33:44:00"
      },
      "2": {
        "type": "bmc",
        "provider": "IPMI",
        "mac": "00:11:22:33:44:01"
      },
      "3": {
        "mac": "00:11:22:33:44:02",
        "_destroy": 1
      }
    }
  }
}
201
{
  "ip": "10.0.0.20",
  "ip6": null,
  "environment_id": 334344675,
  "environment_name": "production",
  "last_report": null,
  "mac": "00:11:22:33:44:00",
  "realm_id": null,
  "realm_name": null,
  "sp_mac": "00:11:22:33:44:01",
  "sp_ip": null,
  "sp_name": null,
  "domain_id": 22495316,
  "domain_name": "mydomain.net",
  "architecture_id": 501905019,
  "architecture_name": "x86_64",
  "operatingsystem_id": 1073012828,
  "operatingsystem_name": "RHEL 6.1",
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": 1007981711,
  "ptable_name": "ptable8",
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": "Grub UEFI",
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "enabled": true,
  "managed": true,
  "use_image": null,
  "image_file": "",
  "uuid": null,
  "compute_resource_id": 980190962,
  "compute_resource_name": "bigcompute",
  "compute_profile_id": null,
  "compute_profile_name": null,
  "capabilities": [
    "build",
    "image",
    "new_volume"
  ],
  "provision_method": "build",
  "certname": "testhost11.mydomain.net",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-09-11 14:31:57 UTC",
  "updated_at": "2019-09-11 14:31:57 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "Warning",
  "uptime_seconds": null,
  "organization_id": 447626438,
  "organization_name": "Organization 1",
  "location_id": 255093256,
  "location_name": "Location 1",
  "puppet_status": 0,
  "model_name": null,
  "configuration_status": 0,
  "configuration_status_label": "No reports",
  "build_status": 0,
  "build_status_label": "Installed",
  "name": "testhost11.mydomain.net",
  "id": 95,
  "puppet_proxy_id": 182953976,
  "puppet_proxy_name": "Puppetmaster Proxy",
  "puppet_ca_proxy_id": 182953976,
  "puppet_ca_proxy_name": "Puppetmaster Proxy",
  "puppet_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "puppet_ca_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "hostgroup_name": null,
  "hostgroup_title": null,
  "parameters": [],
  "all_parameters": [
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 716195090,
      "name": "os1",
      "parameter_type": null,
      "value": "os1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 665394701,
      "name": "parameter",
      "parameter_type": null,
      "value": "value1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": null,
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": null,
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": null,
      "value": "myvalue"
    }
  ],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": 22495316,
      "domain_name": "mydomain.net",
      "created_at": "2019-09-11 14:31:57 UTC",
      "updated_at": "2019-09-11 14:31:57 UTC",
      "managed": true,
      "identifier": null,
      "id": 101,
      "name": "testhost11.mydomain.net",
      "ip": "10.0.0.20",
      "ip6": null,
      "mac": "00:11:22:33:44:00",
      "mtu": null,
      "fqdn": "testhost11.mydomain.net",
      "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-09-11 14:31:57 UTC",
      "updated_at": "2019-09-11 14:31:57 UTC",
      "managed": true,
      "identifier": null,
      "id": 102,
      "name": null,
      "ip": null,
      "ip6": null,
      "mac": "00:11:22:33:44:01",
      "mtu": null,
      "fqdn": null,
      "primary": false,
      "provision": false,
      "type": "bmc",
      "username": null,
      "password": null,
      "provider": "IPMI",
      "virtual": false
    }
  ],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "permissions": {
    "view_hosts": true,
    "create_hosts": true,
    "edit_hosts": true,
    "destroy_hosts": true,
    "build_hosts": true,
    "power_hosts": true,
    "console_hosts": true,
    "ipmi_boot_hosts": true,
    "puppetrun_hosts": true
  }
}

Params

Param Name Description
location_id
Optional

위치 별 범위

Validations:

  • Must be a Integer

organization_id
Optional

조직 별 범위

Validations:

  • Must be a Integer

host
Required

Validations:

  • Must be a Hash

host[name]
Required

Validations:

  • Must be a String

host[location_id]
Required

Validations:

  • Must be a number.

host[organization_id]
Required

Validations:

  • Must be a number.

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

호스트가 관리되고 있으며 값이 호스트 그룹에서 상속되지 않은 경우에 필요합니다

Validations:

  • Must be a String

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

DHCP 프록시를 갖는 서브넷을 사용할 필요가 없습니다

Validations:

  • Must be a String

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

관리 호스트가 베어 메탈일 경우 필요하지만 가상 머신일 경우 필요하지 않습니다

Validations:

  • Must be a String

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

호스트가 관리되고 있으며 값이 호스트 그룹에서 상속되지 않은 경우에 필요합니다

Validations:

  • Must be a number.

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

호스트가 관리되고 있으며 값이 호스트 그룹에서 상속되지 않은 경우에 필요합니다

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Puppet 프록시 ID

Validations:

  • Must be a number.

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

Puppet CA 프록시 ID

Validations:

  • Must be a number.

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

Validations:

  • Must be an array of any type

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

IDs of associated config groups

Validations:

  • Must be an array of any type

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

호스트가 관리되고 있으며 값이 호스트 그룹에서 상속되지 않은 경우에 필요합니다

Validations:

  • Must be a String

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

이미지 기반의 프로비저닝이 아니고 호스트가 관리되어 값이 호스트 그룹에서 상속되지 않은 경우에 필요합니다

Validations:

  • Must be a String

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

DHCP filename option (Grub2/PXELinux by default)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

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

호스트가 관리되고 있으며 사용자 정의 파티션이 정의되고 있지 않은 경우에 필요합니다

Validations:

  • Must be a number.

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

호스트가 관리되고 있으며 값이 호스트 그룹에서 상속되지 않은 경우에 필요합니다

Validations:

  • Must be a number.

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

nil은 호스트가 베어 메탈임을 의미합니다

Validations:

  • Must be a number.

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

호스트가 관리되고 있으며 값이 호스트 그룹이나 설정의 기본값 암호에서 상속되지 않은 경우에 필요합니다

Validations:

  • Must be a String

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

호스트의 소유자 유형

Validations:

  • Must be one of: User, Usergroup.

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

Validations:

  • Must be a number.

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

호스트의 매개 변수(배열 또는 인덱싱된 해시)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
Required

매개 변수의 이름

Validations:

  • Must be a String

host[host_parameters_attributes][value]
Required

매개 변수 값

Validations:

  • Must be a String

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

Validations:

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

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

이 호스트를 Foreman 보고서에 포함

Validations:

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

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

The method used to provision the host.

Validations:

  • Must be one of: build, image.

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

호스트를 관리할 지 또는 관리하지 않을지에 대한 True/False 플래그입니다. 알림: 이 값은 여러 매개 변수가 필요할 지 또는 필요하지 않을 지에 대한 여부를 결정합니다

Validations:

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

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

오케스트레이션 작업 상태를 추적하기 위한 UUID, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

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

호스트에 대한 추가 정보

Validations:

  • Must be a String

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

Validations:

  • Must be a String

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

Validations:

  • Must be a number.

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

호스트의 네트워크 인터페이스입니다.

Validations:

  • Must be an Array of nested elements

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

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

Validations:

  • Must be a String

host[interfaces_attributes][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

host[interfaces_attributes][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

host[interfaces_attributes][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.

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

인터페이스의 DNS 이름

Validations:

  • Must be a String

host[interfaces_attributes][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.

host[interfaces_attributes][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.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a String

host[interfaces_attributes][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.

host[interfaces_attributes][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.

host[interfaces_attributes][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.

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a String

host[interfaces_attributes][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.

host[interfaces_attributes][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.

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

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

Validations:

  • Must be a String

host[interfaces_attributes][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

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

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

Validations:

  • Must be a String

host[interfaces_attributes][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.

host[interfaces_attributes][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

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

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

Validations:

  • Must be a String

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

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

Validations:

  • Must be a Hash

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

컴퓨팅 리소스별 추가 속성입니다.

Validations:

  • Must be a Hash