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 String

location_id
Optional

ロケーションのスコープ

Validations:

  • Must be Integer

organization_id
Optional

組織のスコープ

Validations:

  • Must be Integer

search
Optional

結果をフィルタ

Validations:

  • Must be String

order
Optional

結果をソート

Validations:

  • Must be String

page
Optional

結果をページ分割

Validations:

  • Must be String

per_page
Optional

リクエストあたりのエントリ数

Validations:

  • Must be String


GET /api/hostgroups/:id
ホストグループの確認

Params

Param Name Description
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
ホストグループの作成

Params

Param Name Description
hostgroup
Required

Validations:

  • Must be a Hash

hostgroup[name]
Required

Name of the host group

Validations:

  • Must be String

hostgroup[parent_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Parent ID of the host group

Validations:

  • Must be a number.

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

環境 ID

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

アーキテクチャ ID

Validations:

  • Must be a number.

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

Media ID

Validations:

  • Must be a number.

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

Partition table ID

Validations:

  • Must be a number.

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

Puppet CA proxy ID

Validations:

  • Must be a number.

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

Subnet ID

Validations:

  • Must be a number.

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

Domain ID

Validations:

  • Must be a number.

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

Realm ID

Validations:

  • Must be a number.

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

Puppet proxy ID

Validations:

  • Must be a number.

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

Root password on provisioned hosts

Validations:

  • Must be String

hostgroup[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type


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

Params

Param Name Description
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

Name of the host group

Validations:

  • Must be String

hostgroup[parent_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Parent ID of the host group

Validations:

  • Must be a number.

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

環境 ID

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

アーキテクチャ ID

Validations:

  • Must be a number.

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

Media ID

Validations:

  • Must be a number.

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

Partition table ID

Validations:

  • Must be a number.

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

Puppet CA proxy ID

Validations:

  • Must be a number.

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

Subnet ID

Validations:

  • Must be a number.

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

Domain ID

Validations:

  • Must be a number.

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

Realm ID

Validations:

  • Must be a number.

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

Puppet proxy ID

Validations:

  • Must be a number.

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

Root password on provisioned hosts

Validations:

  • Must be String

hostgroup[location_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type


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

Params

Param Name Description
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
name
Required

Validations:

  • Must be String