GET /api/hosts
모든 호스트 목록 나열

GET /api/hostgroups/:hostgroup_id/hosts
호스트 그룹 별 모든 호스트 나열

GET /api/locations/:location_id/hosts
위치별 호스트 나열

GET /api/organizations/:organization_id/hosts
조직 별 호스트 나열

GET /api/environments/:environment_id/hosts
환경 별 호스트 나열

Params

Param name Description
thin
optional

Only list ID and name of hosts

Validations:

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

hostgroup_id
optional

호스트 그룹 ID

Validations:

  • Must be a String

location_id
optional

위치 ID

Validations:

  • Must be a String

organization_id
optional

조직 ID

Validations:

  • Must be a String

environment_id
optional

환경 ID

Validations:

  • Must be a String

include
optional

Array of extra information types to include

Validations:

  • Must be one of: parameters, all_parameters.

search
optional

필터 결과

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

1 부터 페이지 번호

Validations:

  • Must be a number.

per_page
optional

반환할 페이지 당 결과 수

Validations:

  • Must be a number.

Search fields

Field name 유형 Possible values
architecture
boot_time
build true, false
class string
comment
compute_resource
compute_resource_id
config_group string
created_at
domain
domain_id
environment
facts string
global_status ok, warning, error
has_ip
has_mac
hostgroup
hostgroup_fullname
hostgroup_id
hostgroup_name
hostgroup_title
image
installed_at
ip
last_report
location
location_id
mac
managed true, false
model
name
organization
organization_id
origin
os
os_description
os_id
os_major string
os_minor string
os_title
owner string
owner_id
owner_type
params string
params_name
parent_hostgroup string
puppet_ca
puppet_proxy_id
puppetmaster
realm
realm_id
smart_proxy string
status.applied
status.enabled true, false
status.failed
status.failed_restarts
status.interesting true, false
status.pending
status.restarted
status.skipped
subnet
subnet.name
subnet6
subnet6.name
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup
usergroup.name
uuid

GET /api/hosts/:id
호스트 표시

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

id
required

Validations:

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

show_hidden_parameters
optional

Display hidden parameter values

Validations:

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


POST /api/hosts
호스트 생성

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
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 , nil allowed

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

Validations:

  • Must be a String

host[ip]
optional , nil allowed

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

Validations:

  • Must be a String

host[mac]
optional , nil allowed

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

Validations:

  • Must be a String

host[architecture_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[domain_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[realm_id]
optional , nil allowed

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional , nil allowed

Puppet 프록시 ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA 프록시 ID

Validations:

  • Must be a number.

host[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

host[config_group_ids]
optional , nil allowed

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional , nil allowed

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

Validations:

  • Must be a String

host[medium_id]
optional , nil allowed

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

Validations:

  • Must be a String

host[pxe_loader]
optional , nil allowed

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 , nil allowed

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

Validations:

  • Must be a number.

host[subnet_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[compute_resource_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[root_pass]
optional , nil allowed

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

Validations:

  • Must be a String

host[model_id]
optional , nil allowed

Validations:

  • Must be a number.

host[hostgroup_id]
optional , nil allowed

Validations:

  • Must be a number.

host[owner_id]
optional , nil allowed

Validations:

  • Must be a number.

host[owner_type]
optional , nil allowed

호스트의 소유자 유형

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optional , nil allowed

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional , nil allowed

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

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[host_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

host[host_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

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

host[build]
optional , nil allowed

Validations:

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

host[enabled]
optional , nil allowed

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

Validations:

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

host[provision_method]
optional , nil allowed

The method used to provision the host.

Validations:

  • Must be one of: build, image.

host[managed]
optional , nil allowed

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

Validations:

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

host[progress_report_id]
optional , nil allowed

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

Validations:

  • Must be a String

host[comment]
optional , nil allowed

호스트에 대한 추가 정보

Validations:

  • Must be a String

host[capabilities]
optional , nil allowed

Validations:

  • Must be a String

host[compute_profile_id]
optional , nil allowed

Validations:

  • Must be a number.

host[interfaces_attributes]
optional , nil allowed

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

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][ip]
optional , nil allowed

IPv4 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
optional , nil allowed

IPv6 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][type]
optional , nil allowed

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

Validations:

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

host[interfaces_attributes][name]
optional , nil allowed

인터페이스의 DNS 이름

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
optional , nil allowed

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optional , nil allowed

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][managed]
optional , nil allowed

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

Validations:

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

host[interfaces_attributes][primary]
optional , nil allowed

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

Validations:

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

host[interfaces_attributes][provision]
optional , nil allowed

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

Validations:

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

host[interfaces_attributes][username]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][password]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][provider]
optional , nil allowed

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

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil allowed

별칭 또는 VLAN 장치

Validations:

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

host[interfaces_attributes][tag]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
optional , nil allowed

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][mode]
optional , nil allowed

인터페이스의 본드 모드 (예: 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 , nil allowed

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

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
optional , nil allowed

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

Validations:

  • Must be a Hash

host[compute_attributes]
optional , nil allowed

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

Validations:

  • Must be a Hash


PUT /api/hosts/:id
호스트 업데이트

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

id
required

Validations:

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

host
required

Validations:

  • Must be a Hash

host[name]
optional

Validations:

  • Must be a String

host[location_id]
optional

Validations:

  • Must be a number.

host[organization_id]
optional

Validations:

  • Must be a number.

host[environment_id]
optional , nil allowed

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

Validations:

  • Must be a String

host[ip]
optional , nil allowed

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

Validations:

  • Must be a String

host[mac]
optional , nil allowed

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

Validations:

  • Must be a String

host[architecture_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[domain_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[realm_id]
optional , nil allowed

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional , nil allowed

Puppet 프록시 ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA 프록시 ID

Validations:

  • Must be a number.

host[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

host[config_group_ids]
optional , nil allowed

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional , nil allowed

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

Validations:

  • Must be a String

host[medium_id]
optional , nil allowed

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

Validations:

  • Must be a String

host[pxe_loader]
optional , nil allowed

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 , nil allowed

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

Validations:

  • Must be a number.

host[subnet_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[compute_resource_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[root_pass]
optional , nil allowed

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

Validations:

  • Must be a String

host[model_id]
optional , nil allowed

Validations:

  • Must be a number.

host[hostgroup_id]
optional , nil allowed

Validations:

  • Must be a number.

host[owner_id]
optional , nil allowed

Validations:

  • Must be a number.

host[owner_type]
optional , nil allowed

호스트의 소유자 유형

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optional , nil allowed

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional , nil allowed

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

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
optional

매개 변수의 이름

Validations:

  • Must be a String

host[host_parameters_attributes][value]
optional

매개 변수 값

Validations:

  • Must be a String

host[host_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

host[host_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

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

host[build]
optional , nil allowed

Validations:

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

host[enabled]
optional , nil allowed

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

Validations:

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

host[provision_method]
optional , nil allowed

The method used to provision the host.

Validations:

  • Must be one of: build, image.

host[managed]
optional , nil allowed

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

Validations:

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

host[progress_report_id]
optional , nil allowed

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

Validations:

  • Must be a String

host[comment]
optional , nil allowed

호스트에 대한 추가 정보

Validations:

  • Must be a String

host[capabilities]
optional , nil allowed

Validations:

  • Must be a String

host[compute_profile_id]
optional , nil allowed

Validations:

  • Must be a number.

host[interfaces_attributes]
optional , nil allowed

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

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][ip]
optional , nil allowed

IPv4 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
optional , nil allowed

IPv6 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][type]
optional , nil allowed

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

Validations:

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

host[interfaces_attributes][name]
optional , nil allowed

인터페이스의 DNS 이름

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
optional , nil allowed

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optional , nil allowed

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optional , nil allowed

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

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][managed]
optional , nil allowed

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

Validations:

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

host[interfaces_attributes][primary]
optional , nil allowed

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

Validations:

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

host[interfaces_attributes][provision]
optional , nil allowed

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

Validations:

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

host[interfaces_attributes][username]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][password]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][provider]
optional , nil allowed

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

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil allowed

별칭 또는 VLAN 장치

Validations:

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

host[interfaces_attributes][tag]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
optional , nil allowed

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][mode]
optional , nil allowed

인터페이스의 본드 모드 (예: 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 , nil allowed

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

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil allowed

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

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
optional , nil allowed

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

Validations:

  • Must be a Hash

host[compute_attributes]
optional , nil allowed

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

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
호스트 삭제

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

id
required

Validations:

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


GET /api/hosts/:id/enc
Get ENC values of 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

id
required

Validations:

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


GET /api/hosts/:id/status/:type
호스트 상태 가져오기

Returns string representing a host status of a given type

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

id
required

Validations:

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

type
required

상태 유형으로, 다음 중 하나일 수 있습니다.

  • global

  • configuration

  • build

Validations:

  • Must be one of: HostStatus::Global, configuration, build.


DELETE /api/hosts/:id/status/:type
Clear sub-status of host

Clears a host sub-status of a given type

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

id
required

Validations:

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

type
required

status type

Validations:

  • Must be one of: configuration, build.


GET /api/hosts/:id/vm_compute_attributes
호스트의 vm 속성 가져오기

Return the host's compute attributes that can be used to create a clone of this VM

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

id
required

Validations:

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


PUT /api/hosts/:id/disassociate
VM에서 호스트 연결 해제

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

id
required

Validations:

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


PUT /api/hosts/:id/power
호스트에서 전원 작업을 실행합니다

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

id
required

Validations:

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

power_action
required

전원 동작, 유효한 동작은 (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)입니다.

Validations:

  • Must be a String


GET /api/hosts/:id/power
Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.

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

id
required

Validations:

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


PUT /api/hosts/:id/boot
지정된 장치에서 호스트 부팅

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

id
required

Validations:

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

device
required

부팅 장치, 유효한 장치는 디스크, CDROM, PXE, BIOS입니다

Validations:

  • Must be a String


POST /api/hosts/facts
호스트의 팩트를 업로드하고 필요한 경우 호스트를 생성합니다

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

name
required

호스트의 호스트 이름

Validations:

  • Must be a String

facts
required

호스트의 팩트가 포함된 해시

Validations:

  • Must be a Hash

certname
optional

옵션: 호스트의 인증서 이름

Validations:

  • Must be a String

type
optional

옵션: 생성할 호스트의 STI 유형

Validations:

  • Must be a String


PUT /api/hosts/:id/rebuild_config
오케스트레이션 구성 다시 빌드

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

id
required

Validations:

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

only
optional

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
렌더링된 프로비저닝 템플릿 컨텐츠 미리 보기

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

id
required

Validations:

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

kind
required

템플릿 종류로, 사용 가능한 값은 다음과 같습니다:

Validations:

  • Must be a String