GET /api/hostgroups
すべてのホストグループを一覧表示

GET /api/puppetclasses/:puppetclass_id/hostgroups
Puppet クラスのすべてのホストグループを一覧表示

GET /api/locations/:location_id/hostgroups
ロケーションごとにすべてのホストグループを一覧表示

GET /api/organizations/:organization_id/hostgroups
組織ごとにすべてのホストグループを一覧表示

パラメーター

パラメーター名 記述
puppetclass_id
任意

Puppet クラスの ID

Validations:

  • String

location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

search
任意

結果のフィルター

Validations:

  • String

order
任意

Sort field and order, eg. ‘id DESC’

Validations:

  • String

page
任意

結果のページネーション

Validations:

  • String

per_page
任意

要求ごとのエントリー数

Validations:

  • String

include
任意

含める追加の情報タイプの配列

Validations:

  • Must be an array of [“parameters”]

検索フィールド

フィールド名 タイプ 設定可能な値
architecture string
class string
config_group string
content_source string
content_view string
environment string
host string
id integer
label string
lifecycle_environment string
location string
location_id integer
medium string
name string
organization string
organization_id integer
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
params text
template string
title string

GET /api/hostgroups/:id
ホストグループの表示

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

show_hidden_parameters
任意

非表示のパラメーター値の表示

Validations:

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


POST /api/hostgroups
ホストグループの作成

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

hostgroup
必須

Validations:

  • Hash

hostgroup[name]
必須

ホストグループの名前

Validations:

  • String

hostgroup[description]
任意 , nil可

ホストグループの説明

Validations:

  • String

hostgroup[parent_id]
任意 , nil可

ホストグループの親 ID

Validations:

  • Must be a number.

hostgroup[environment_id]
任意 , nil可

環境 ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
任意 , nil可

コンピュートプロファイル ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
任意 , nil可

コンピュートリソース ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
任意 , nil可

オペレーティングシステム ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
任意 , nil可

アーキテクチャー ID

Validations:

  • Must be a number.

hostgroup[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
任意 , nil可

メディア ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
任意 , nil可

パーティションテーブル ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
任意 , nil可

サブネット ID

Validations:

  • Must be a number.

hostgroup[domain_id]
任意 , nil可

ドメイン ID

Validations:

  • Must be a number.

hostgroup[realm_id]
任意 , nil可

レルム ID

Validations:

  • Must be a number.

hostgroup[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
任意 , nil可

パラメーターの配列

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
必須

パラメーター名

Validations:

  • String

hostgroup[group_parameters_attributes][value]
必須

パラメーター値

Validations:

  • String

hostgroup[puppet_proxy_id]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

hostgroup[root_pass]
任意 , nil可

プロビジョニングされたホストの root パスワード

Validations:

  • String

hostgroup[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type

hostgroup[content_source_id]
任意

Content source ID

Validations:

  • Must be a number.

hostgroup[content_view_id]
任意

Content view ID

Validations:

  • Must be a number.

hostgroup[lifecycle_environment_id]
任意

Lifecycle environment ID

Validations:

  • Must be a number.

hostgroup[kickstart_repository_id]
任意

Kickstart repository ID

Validations:

  • Must be a number.


PUT /api/hostgroups/:id
ホストグループの更新

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

hostgroup
必須

Validations:

  • Hash

hostgroup[name]
任意

ホストグループの名前

Validations:

  • String

hostgroup[description]
任意 , nil可

ホストグループの説明

Validations:

  • String

hostgroup[parent_id]
任意 , nil可

ホストグループの親 ID

Validations:

  • Must be a number.

hostgroup[environment_id]
任意 , nil可

環境 ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
任意 , nil可

コンピュートプロファイル ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
任意 , nil可

コンピュートリソース ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
任意 , nil可

オペレーティングシステム ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
任意 , nil可

アーキテクチャー ID

Validations:

  • Must be a number.

hostgroup[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot.

hostgroup[medium_id]
任意 , nil可

メディア ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
任意 , nil可

パーティションテーブル ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
任意 , nil可

サブネット ID

Validations:

  • Must be a number.

hostgroup[domain_id]
任意 , nil可

ドメイン ID

Validations:

  • Must be a number.

hostgroup[realm_id]
任意 , nil可

レルム ID

Validations:

  • Must be a number.

hostgroup[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
任意 , nil可

パラメーターの配列

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
任意

パラメーター名

Validations:

  • String

hostgroup[group_parameters_attributes][value]
任意

パラメーター値

Validations:

  • String

hostgroup[puppet_proxy_id]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

hostgroup[root_pass]
任意 , nil可

プロビジョニングされたホストの root パスワード

Validations:

  • String

hostgroup[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type

hostgroup[content_source_id]
任意

Content source ID

Validations:

  • Must be a number.

hostgroup[content_view_id]
任意

Content view ID

Validations:

  • Must be a number.

hostgroup[lifecycle_environment_id]
任意

Lifecycle environment ID

Validations:

  • Must be a number.

hostgroup[kickstart_repository_id]
任意

Kickstart repository ID

Validations:

  • Must be a number.


DELETE /api/hostgroups/:id
ホストグループの削除

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


POST /api/hostgroups/:id/clone
ホストグループのクローン作成

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

name
必須

Validations:

  • String


PUT /api/hostgroups/:id/rebuild_config
オーケストレーション設定の再ビルド

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

only
任意

再ビルドのステップの制限。有効なステップは DHCP, DNS, TFTP です。

Validations:

  • Must be an array of any type

children_hosts
任意

子ホストグループのホストでの操作

Validations:

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