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:

  • Must be a String

location_id
任意

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

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String

include
任意

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

Validations:

  • Must be an array of [“parameters”]


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

パラメーター

パラメーター名 記述
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.

show_hidden_parameters
任意

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

Validations:

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


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

パラメーター

パラメーター名 記述
hostgroup
必須

Validations:

  • Must be a Hash

hostgroup[name]
必須

ホストグループの名前

Validations:

  • Must be a String

hostgroup[description]
任意 , nil可

Host group description

Validations:

  • Must be a 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[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:

  • Must be a String

hostgroup[group_parameters_attributes][value]
必須

パラメーター値

Validations:

  • Must be a 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:

  • Must be a 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


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

パラメーター

パラメーター名 記述
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.

hostgroup
必須

Validations:

  • Must be a Hash

hostgroup[name]
任意

ホストグループの名前

Validations:

  • Must be a String

hostgroup[description]
任意 , nil可

Host group description

Validations:

  • Must be a 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[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:

  • Must be a String

hostgroup[group_parameters_attributes][value]
任意

パラメーター値

Validations:

  • Must be a 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:

  • Must be a 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


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

パラメーター

パラメーター名 記述
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.


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

パラメーター

パラメーター名 記述
name
必須

Validations:

  • Must be a String


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

パラメーター

パラメーター名 記述
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.

only
任意

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

Validations:

  • Must be an array of any type

children_hosts
任意

Operate on child hostgroup hosts

Validations:

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