GET /api/hosts
List all hosts.

パラメーター

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

Filter results

Validations:

  • Must be a String

order
任意

Sort results

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


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

パラメーター

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

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.

パラメーター

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

Validations:

  • Must be a Hash

host[name]
必須

Validations:

  • Must be a String

host[location_id]
必須

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

Validations:

  • Must be a number.

host[organization_id]
必須

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

Validations:

  • Must be a number.

host[environment_id]
任意

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

Validations:

  • Must be a String

host[ip]
任意

IPv4 address

Validations:

  • Must be a String

host[ip6]
任意

IPv6 address

Validations:

  • Must be a String

host[mac]
任意

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

Validations:

  • Must be a String

host[architecture_id]
任意

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

Validations:

  • Must be a number.

host[domain_id]
任意

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

Validations:

  • Must be a number.

host[realm_id]
任意

Validations:

  • Must be a number.

host[puppet_proxy_id]
任意

Validations:

  • Must be a number.

host[puppetclass_ids]
任意

Validations:

  • Must be an array of any type

host[operatingsystem_id]
任意

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

Validations:

  • Must be a String

host[medium_id]
任意

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

Validations:

  • Must be a String

host[pxe_loader]
任意

DHCP filename option

Validations:

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

host[ptable_id]
任意

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

Validations:

  • Must be a number.

host[subnet_id]
任意

IPv4 subnet

Validations:

  • Must be a number.

host[subnet6_id]
任意

IPv6 subnet

Validations:

  • Must be a number.

host[compute_resource_id]
任意

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

Validations:

  • Must be a number.

host[root_pass]
任意

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

Validations:

  • Must be a String

host[model_id]
任意

Validations:

  • Must be a number.

host[hostgroup_id]
任意

Validations:

  • Must be a number.

host[owner_id]
任意

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
任意

Validations:

  • Must be a number.

host[image_id]
任意

Validations:

  • Must be a number.

host[host_parameters_attributes]
任意

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

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
必須

パラメーター名

Validations:

  • Must be a String

host[host_parameters_attributes][value]
必須

パラメーター値

Validations:

  • Must be a String

host[build]
任意

Validations:

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

host[enabled]
任意

このホストを Foreman レポート内に組み込む

Validations:

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

host[provision_method]
任意

Validations:

  • Must be a String

host[managed]
任意

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

Validations:

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

host[progress_report_id]
任意

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

Validations:

  • Must be a String

host[comment]
任意

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

Validations:

  • Must be a String

host[capabilities]
任意

Validations:

  • Must be a String

host[compute_profile_id]
任意

Validations:

  • Must be a number.

host[compute_attributes]
任意

Validations:

  • Must be a Hash


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

パラメーター

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

host
必須

Validations:

  • Must be a Hash

host[name]
任意

Validations:

  • Must be a String

host[environment_id]
任意

Validations:

  • Must be a String

host[ip]
任意

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

Validations:

  • Must be a String

host[ip6]
任意

IPv6 address

Validations:

  • Must be a String

host[mac]
任意

not required if its a virtual machine

Validations:

  • Must be a String

host[architecture_id]
任意

Validations:

  • Must be a number.

host[domain_id]
任意

Validations:

  • Must be a number.

host[puppet_proxy_id]
任意

Validations:

  • Must be a number.

host[operatingsystem_id]
任意

Validations:

  • Must be a String

host[puppetclass_ids]
任意

Validations:

  • Must be an array of any type

host[medium_id]
任意

Validations:

  • Must be a number.

host[ptable_id]
任意

Validations:

  • Must be a number.

host[subnet_id]
任意

IPv4 subnet

Validations:

  • Must be a number.

host[subnet6_id]
任意

IPv6 subnet

Validations:

  • Must be a number.

host[compute_resource_id]
任意

Validations:

  • Must be a number.

host[sp_subnet_id]
任意

Validations:

  • Must be a number.

host[model_id]
任意

Validations:

  • Must be a number.

host[hostgroup_id]
任意

Validations:

  • Must be a number.

host[owner_id]
任意

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
任意

Validations:

  • Must be a number.

host[image_id]
任意

Validations:

  • Must be a number.

host[host_parameters_attributes]
任意

Validations:

  • Must be an array of any type

host[build]
任意

Validations:

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

host[enabled]
任意

Validations:

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

host[provision_method]
任意

Validations:

  • Must be a String

host[managed]
任意

Validations:

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

host[progress_report_id]
任意

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

Validations:

  • Must be a String

host[capabilities]
任意

Validations:

  • Must be a String

host[compute_attributes]
任意

Validations:

  • Must be a Hash


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

パラメーター

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


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

Return value may either be one of the following:

  • missing

  • failed

  • pending

  • changed

  • unchanged

  • unreported

パラメーター

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

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.