GET /api/hostgroups
모든 호스트 그룹 목록 나열

GET /api/puppetclasses/:puppetclass_id/hostgroups
Puppet 클래스의 모든 호스트 그룹 목록 나열

GET /api/locations/:location_id/hostgroups
위치 별 모든 호스트 그룹 나열

GET /api/organizations/:organization_id/hostgroups
조직 별 모든 호스트 그룹 나열

Params

Param name Description
puppetclass_id
optional

Puppet 클래스 ID

Validations:

  • Must be a String

location_id
optional

위치 별 범위

Validations:

  • Must be a Integer

organization_id
optional

조직 별 범위

Validations:

  • Must be a Integer

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.

include
optional

Array of extra information types to include

Validations:

  • Must be an array of [“parameters”]

Search fields

Field name 유형 Possible values
architecture
class
config_group string
environment
host
id
label
location
location_id
medium
name
organization
organization_id
os
os_description
os_id
os_major
os_minor
os_title
params
template
title

GET /api/hostgroups/: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.

show_hidden_parameters
optional

Display hidden parameter values

Validations:

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


POST /api/hostgroups
호스트 그룹 생성

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

hostgroup
required

Validations:

  • Must be a Hash

hostgroup[name]
required

호스트 그룹의 이름

Validations:

  • Must be a String

hostgroup[description]
optional , nil allowed

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
optional , nil allowed

호스트 그룹의 부모 ID

Validations:

  • Must be a number.

hostgroup[environment_id]
optional , nil allowed

환경 ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
optional , nil allowed

컴퓨터 프로파일 ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
optional , nil allowed

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional , nil allowed

운영 체제 ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional , nil allowed

아키텍처 ID

Validations:

  • Must be a number.

hostgroup[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.

hostgroup[medium_id]
optional , nil allowed

미디어 ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional , nil allowed

파티션 테이블 ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional , nil allowed

서브넷 ID

Validations:

  • Must be a number.

hostgroup[subnet6_id]
optional , nil allowed

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
optional , nil allowed

도메인 ID

Validations:

  • Must be a number.

hostgroup[realm_id]
optional , nil allowed

영역 ID

Validations:

  • Must be a number.

hostgroup[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

hostgroup[config_group_ids]
optional , nil allowed

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil allowed

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
required

매개 변수의 이름

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
required

매개 변수 값

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

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

hostgroup[group_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

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

hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet 프록시 ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA 프록시 ID

Validations:

  • Must be a number.

hostgroup[root_pass]
optional , nil allowed

프로비저닝된 호스트의 root 암호

Validations:

  • Must be a String

hostgroup[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type


PUT /api/hostgroups/: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.

hostgroup
required

Validations:

  • Must be a Hash

hostgroup[name]
optional

호스트 그룹의 이름

Validations:

  • Must be a String

hostgroup[description]
optional , nil allowed

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
optional , nil allowed

호스트 그룹의 부모 ID

Validations:

  • Must be a number.

hostgroup[environment_id]
optional , nil allowed

환경 ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
optional , nil allowed

컴퓨터 프로파일 ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
optional , nil allowed

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional , nil allowed

운영 체제 ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional , nil allowed

아키텍처 ID

Validations:

  • Must be a number.

hostgroup[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.

hostgroup[medium_id]
optional , nil allowed

미디어 ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional , nil allowed

파티션 테이블 ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional , nil allowed

서브넷 ID

Validations:

  • Must be a number.

hostgroup[subnet6_id]
optional , nil allowed

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
optional , nil allowed

도메인 ID

Validations:

  • Must be a number.

hostgroup[realm_id]
optional , nil allowed

영역 ID

Validations:

  • Must be a number.

hostgroup[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

hostgroup[config_group_ids]
optional , nil allowed

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil allowed

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
optional

매개 변수의 이름

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
optional

매개 변수 값

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

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

hostgroup[group_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

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

hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet 프록시 ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA 프록시 ID

Validations:

  • Must be a number.

hostgroup[root_pass]
optional , nil allowed

프로비저닝된 호스트의 root 암호

Validations:

  • Must be a String

hostgroup[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type


DELETE /api/hostgroups/: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.


POST /api/hostgroups/:id/clone
호스트 그룹 복제

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


PUT /api/hostgroups/: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, 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

children_hosts
optional

Operate on child hostgroup hosts

Validations:

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