GET /api/hosts
List all hosts.

Params

Param Name Description
search
Optional

Filter results

Validations:

  • Must be String

order
Optional

Sort results

Validations:

  • Must be String

page
Optional

結果のページネーション

Validations:

  • Must be String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be String


GET /api/hosts/:id
Show a host.

Params

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


POST /api/hosts
Create a host.

Params

Param Name Description
host
Required

Validations:

  • Must be a Hash

host[name]
Required

Validations:

  • Must be String

host[location_id]
Required

ロケーションが有効にされている場合に必須です。

Validations:

  • Must be a number.

host[organization_id]
Required

組織が有効にされている場合に必須です。

Validations:

  • Must be a number.

host[environment_id]
Optional

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be String

host[ip]
Optional

IPv4 アドレス

Validations:

  • Must be String

host[ip6]
Optional

IPv6 アドレス

Validations:

  • Must be String

host[mac]
Optional

管理ホストがベアメタルの場合に必須です。仮想マシンの場合は不要です。

Validations:

  • Must be String

host[architecture_id]
Optional

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[domain_id]
Optional

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[realm_id]
Optional

Validations:

  • Must be a number.

host[puppet_proxy_id]
Optional

Validations:

  • Must be a number.

host[puppetclass_ids]
Optional

Validations:

  • Must be an array of any type

host[operatingsystem_id]
Optional

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be String

host[medium_id]
Optional

イメージベースのプロビジョニングでない場合で、ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be String

host[pxe_loader]
Optional

DHCP ファイル名オプション

Validations:

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

host[ptable_id]
Optional

ホストが管理されており、カスタムパーティションが定義されていない場合に必須です。

Validations:

  • Must be a number.

host[subnet_id]
Optional

IPv4 subnet

Validations:

  • Must be a number.

host[subnet6_id]
Optional

IPv6 subnet

Validations:

  • Must be a number.

host[compute_resource_id]
Optional

Nil はホストがベアメタルであることを意味します

Validations:

  • Must be a number.

host[root_pass]
Optional

ホストが管理されており、値がホストグループから継承されていないか、または設定済みのデフォルトパスワードである場合に必須です。

Validations:

  • Must be String

host[model_id]
Optional

Validations:

  • Must be a number.

host[hostgroup_id]
Optional

Validations:

  • Must be a number.

host[owner_id]
Optional

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
Optional

Validations:

  • Must be a number.

host[image_id]
Optional

Validations:

  • Must be a number.

host[host_parameters_attributes]
Optional

ホストのパラメーター (配列またはインデックス化されたハッシュ)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
Required

パラメーター名

Validations:

  • Must be String

host[host_parameters_attributes][value]
Required

パラメーター値

Validations:

  • Must be String

host[build]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[enabled]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[provision_method]
Optional

Validations:

  • Must be String

host[managed]
Optional

ホストを管理対象とするかどうかについての True/False フラグです。注意: この値は複数のパラメーターが必要となるかどうかも決定します。

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[progress_report_id]
Optional

オーケストレーションタスクの状態を追跡するための UUID。GET /api/orchestration/:UUID/tasks

Validations:

  • Must be String

host[comment]
Optional

このホストについての追加情報

Validations:

  • Must be String

host[capabilities]
Optional

Validations:

  • Must be String

host[compute_profile_id]
Optional

Validations:

  • Must be a number.

host[compute_attributes]
Optional

Validations:

  • Must be a Hash


PUT /api/hosts/:id
Update a host.

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.

host
Required

Validations:

  • Must be a Hash

host[name]
Optional

Validations:

  • Must be String

host[environment_id]
Optional

Validations:

  • Must be String

host[ip]
Optional

IPv4 address, not required if using a subnet with dhcp proxy

Validations:

  • Must be String

host[ip6]
Optional

IPv6 アドレス

Validations:

  • Must be String

host[mac]
Optional

not required if its a virtual machine

Validations:

  • Must be String

host[architecture_id]
Optional

Validations:

  • Must be a number.

host[domain_id]
Optional

Validations:

  • Must be a number.

host[puppet_proxy_id]
Optional

Validations:

  • Must be a number.

host[operatingsystem_id]
Optional

Validations:

  • Must be String

host[puppetclass_ids]
Optional

Validations:

  • Must be an array of any type

host[medium_id]
Optional

Validations:

  • Must be a number.

host[ptable_id]
Optional

Validations:

  • Must be a number.

host[subnet_id]
Optional

IPv4 subnet

Validations:

  • Must be a number.

host[subnet6_id]
Optional

IPv6 subnet

Validations:

  • Must be a number.

host[compute_resource_id]
Optional

Validations:

  • Must be a number.

host[sp_subnet_id]
Optional

Validations:

  • Must be a number.

host[model_id]
Optional

Validations:

  • Must be a number.

host[hostgroup_id]
Optional

Validations:

  • Must be a number.

host[owner_id]
Optional

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
Optional

Validations:

  • Must be a number.

host[image_id]
Optional

Validations:

  • Must be a number.

host[host_parameters_attributes]
Optional

Validations:

  • Must be an array of any type

host[build]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[enabled]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[provision_method]
Optional

Validations:

  • Must be String

host[managed]
Optional

Validations:

  • Must be 'true' or 'false' or '1' or '0'

host[progress_report_id]
Optional

オーケストレーションタスクの状態を追跡するための UUID。GET /api/orchestration/:UUID/tasks

Validations:

  • Must be String

host[capabilities]
Optional

Validations:

  • Must be String

host[compute_attributes]
Optional

Validations:

  • Must be a Hash


DELETE /api/hosts/:id
Delete an host.

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.


GET /api/hosts/:id/status
ホストの状態の取得

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

Params

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