GET /api/hosts
List all hosts.

Params

Param Name Description
search
Optional

Filter results


Value:

Must be String

order
Optional

Sort results


Value:

Must be String

page
Optional

結果をページ分割


Value:

Must be String

per_page
Optional

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


Value:

Must be String


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

Params

Param Name Description
id
Required

Value:

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

Value:

Must be a Hash

host[name]
Required

Value:

Must be String

host[environment_id]
Optional

ホストが管理され、値がホストグループから継承されていない場合に必要


Value:

Must be String

host[ip]
Optional

DHCP プロキシとサブネットを使用している場合は必要ではありません


Value:

Must be String

host[mac]
Optional

ベアメタルでマネージドに設定されているホストである場合に必要です。仮想マシンの場合は必須ではありません


Value:

Must be String

host[architecture_id]
Optional

ホストが管理され、値がホストグループから継承されていない場合に必要


Value:

Must be a number.

host[domain_id]
Optional

ホストが管理され、値がホストグループから継承されていない場合に必要


Value:

Must be a number.

host[realm_id]
Optional

Value:

Must be a number.

host[puppet_proxy_id]
Optional

Value:

Must be a number.

host[puppet_class_ids]
Optional

Value:

Must be an array of any type

host[operatingsystem_id]
Optional

ホストが管理され、値がホストグループから継承されていない場合に必要


Value:

Must be String

host[medium_id]
Optional

イメージベースプロビジョニングではなく、ホストが管理され、値がホストグループから継承されていない場合に必要


Value:

Must be String

host[ptable_id]
Optional

ホストがマネージドであり、カスタムパーティションが定義されていない場合に必要


Value:

Must be a number.

host[subnet_id]
Optional

ホストが管理され、値がホストグループから継承されていない場合に必要


Value:

Must be a number.

host[compute_resource_id]
Optional

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


Value:

Must be a number.

host[root_pass]
Optional

ホストが管理され、値が設定でホストグループまたはデフォルトのパスワードから継承されていない場合に必要


Value:

Must be String

host[model_id]
Optional

Value:

Must be a number.

host[hostgroup_id]
Optional

Value:

Must be a number.

host[owner_id]
Optional

Value:

Must be a number.

host[puppet_ca_proxy_id]
Optional

Value:

Must be a number.

host[image_id]
Optional

Value:

Must be a number.

host[host_parameters_attributes]
Optional

Host's parameters (array or indexed hash)


Value:

Must be an Array of nested elements

host[host_parameters_attributes][name]
Required

Name of the parameter


Value:

Must be String

host[host_parameters_attributes][value]
Required

Parameter value


Value:

Must be String

host[build]
Optional

Value:

Must be 'true' or 'false'

host[enabled]
Optional

Value:

Must be 'true' or 'false'

host[provision_method]
Optional

Value:

Must be String

host[managed]
Optional

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


Value:

Must be 'true' or 'false'

host[progress_report_id]
Optional

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


Value:

Must be String

host[comment]
Optional

このホストに関する追加情報


Value:

Must be String

host[capabilities]
Optional

Value:

Must be String

host[compute_profile_id]
Optional

Value:

Must be a number.

host[compute_attributes]
Optional

Value:

Must be a Hash


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

Params

Param Name Description
id
Required

Value:

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

Value:

Must be a Hash

host[name]
Optional

Value:

Must be String

host[environment_id]
Optional

Value:

Must be String

host[ip]
Optional

not required if using a subnet with dhcp proxy


Value:

Must be String

host[mac]
Optional

not required if its a virtual machine


Value:

Must be String

host[architecture_id]
Optional

Value:

Must be a number.

host[domain_id]
Optional

Value:

Must be a number.

host[puppet_proxy_id]
Optional

Value:

Must be a number.

host[operatingsystem_id]
Optional

Value:

Must be String

host[puppet_class_ids]
Optional

Value:

Must be an array of any type

host[medium_id]
Optional

Value:

Must be a number.

host[ptable_id]
Optional

Value:

Must be a number.

host[subnet_id]
Optional

Value:

Must be a number.

host[compute_resource_id]
Optional

Value:

Must be a number.

host[sp_subnet_id]
Optional

Value:

Must be a number.

host[model_id]
Optional

Value:

Must be a number.

host[hostgroup_id]
Optional

Value:

Must be a number.

host[owner_id]
Optional

Value:

Must be a number.

host[puppet_ca_proxy_id]
Optional

Value:

Must be a number.

host[image_id]
Optional

Value:

Must be a number.

host[host_parameters_attributes]
Optional

Value:

Must be an array of any type

host[build]
Optional

Value:

Must be 'true' or 'false'

host[enabled]
Optional

Value:

Must be 'true' or 'false'

host[provision_method]
Optional

Value:

Must be String

host[managed]
Optional

Value:

Must be 'true' or 'false'

host[progress_report_id]
Optional

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


Value:

Must be String

host[capabilities]
Optional

Value:

Must be String

host[compute_attributes]
Optional

Value:

Must be a Hash


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

Params

Param Name Description
id
Required

Value:

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

Value:

Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.