GET /api/hosts
ホスト一覧

GET /api/hostgroups/:hostgroup_id/hosts
ホストグループのすべてのホストを一覧表示

GET /api/locations/:location_id/hosts
ロケーションごとのホストの一覧

GET /api/organizations/:organization_id/hosts
組織ごとのホストの一覧

GET /api/environments/:environment_id/hosts
環境ごとのホストの一覧

Params

Param Name Description
hostgroup_id
Optional

ホストグループの ID


Value:

Must be String

location_id
Optional

ロケーションの ID


Value:

Must be String

organization_id
Optional

組織の ID


Value:

Must be String

environment_id
Optional

環境の ID


Value:

Must be String

search
Optional

結果をフィルタ


Value:

Must be String

order
Optional

結果をソート


Value:

Must be String

page
Optional

結果をページ分割


Value:

Must be String

per_page
Optional

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


Value:

Must be String


GET /api/hosts/:id
ホストの表示

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
ホストの作成

Params

Param Name Description
host
Required

Value:

Must be a Hash

host[name]
Required

Value:

Must be String

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

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


Value:

Must be String

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

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


Value:

Must be String

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

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


Value:

Must be String

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

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


Value:

Must be a number.

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

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


Value:

Must be a number.

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

Value:

Must be a number.

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

Value:

Must be a number.

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

Value:

Must be an array of any type

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

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


Value:

Must be String

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

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


Value:

Must be String

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

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


Value:

Must be a number.

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

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


Value:

Must be a number.

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

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


Value:

Must be a number.

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

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


Value:

Must be String

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

Value:

Must be a number.

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

Value:

Must be a number.

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

Value:

Must be a number.

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

ホストの所有者タイプ


Value:

Must be one of: User, Usergroup.

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

Value:

Must be a number.

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

Value:

Must be a number.

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

Value:

Must be an array of any type

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

Value:

Must be 'true' or 'false'

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

Value:

Must be 'true' or 'false'

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

The method used to provision the host. Possible provision_methods may be build (ネットワークベース), image (イメージベース)


Value:

Must be String

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

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not


Value:

Must be 'true' or 'false'

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

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


Value:

Must be String

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

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


Value:

Must be String

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

Value:

Must be String

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

Value:

Must be a number.

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

ホストネットワークインターフェイス.


Value:

Must be an Array of nested elements

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

MAC address of interface. Required for managed interfaces on bare metal.


Value:

Must be String

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

インターフェイスの IP アドレス


Value:

Must be String

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

Interface type, e.g. bmc. Default is interface


Value:

Must be one of: interface, bmc, bond, bridge.

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

インターフェイスの DNS 名


Value:

Must be String

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

インターフェイスの Foreman サブネット ID


Value:

Must be Fixnum

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

Foreman domain ID of interface. Required for primary interfaces on managed hosts.


Value:

Must be Fixnum

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

デバイス識別子 例: eth0 or eth1.1


Value:

Must be String

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

このインタフェースは、 DHCP と DNS スマートプロキシ経由で管理する必要があり、それは、プロビジョニング中に設定する必要がありますか?


Value:

Must be 'true' or 'false'

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

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.


Value:

Must be 'true' or 'false'

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

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.


Value:

Must be 'true' or 'false'

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

BMCインタフェースの場合のみ。


Value:

Must be String

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

BMCインタフェースの場合のみ。


Value:

Must be String

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

インタフェースプロバイダ 例: IPMI. BMCインタフェースの場合のみ。


Value:

Must be one of: IPMI.

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

エイリアスもしくは VLAN デバイス


Value:

Must be 'true' or 'false'

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

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.


Value:

Must be String

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

このインタフェースが属するインタフェースの識別子 例: eth1 。※ 仮想インターフェイスの場合のみ


Value:

Must be String

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

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.


Value:

Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

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

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.


Value:

Must be an array of any type

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

空白で区切られたオプション(例 : miimon=100 )。 bond インタフェースのみ.


Value:

Must be String

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

インタフェースのための追加のコンピュートリソース固有の属性。


Value:

Must be Hash

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

追加のコンピュートリソース固有の属性


Value:

Must be Hash


PUT /api/hosts/:id
ホストの更新

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 , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

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


Value:

Must be String

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

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


Value:

Must be String

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

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


Value:

Must be String

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

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


Value:

Must be a number.

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

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


Value:

Must be a number.

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

Value:

Must be a number.

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

Value:

Must be a number.

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

Value:

Must be an array of any type

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

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


Value:

Must be String

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

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


Value:

Must be String

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

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


Value:

Must be a number.

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

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


Value:

Must be a number.

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

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


Value:

Must be a number.

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

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


Value:

Must be String

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

Value:

Must be a number.

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

Value:

Must be a number.

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

Value:

Must be a number.

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

ホストの所有者タイプ


Value:

Must be one of: User, Usergroup.

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

Value:

Must be a number.

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

Value:

Must be a number.

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

Value:

Must be an array of any type

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

Value:

Must be 'true' or 'false'

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

Value:

Must be 'true' or 'false'

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

The method used to provision the host. Possible provision_methods may be build (ネットワークベース), image (イメージベース)


Value:

Must be String

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

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not


Value:

Must be 'true' or 'false'

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

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


Value:

Must be String

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

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


Value:

Must be String

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

Value:

Must be String

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

Value:

Must be a number.

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

ホストネットワークインターフェイス.


Value:

Must be an Array of nested elements

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

MAC address of interface. Required for managed interfaces on bare metal.


Value:

Must be String

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

インターフェイスの IP アドレス


Value:

Must be String

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

Interface type, e.g. bmc. Default is interface


Value:

Must be one of: interface, bmc, bond, bridge.

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

インターフェイスの DNS 名


Value:

Must be String

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

インターフェイスの Foreman サブネット ID


Value:

Must be Fixnum

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

Foreman domain ID of interface. Required for primary interfaces on managed hosts.


Value:

Must be Fixnum

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

デバイス識別子 例: eth0 or eth1.1


Value:

Must be String

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

このインタフェースは、 DHCP と DNS スマートプロキシ経由で管理する必要があり、それは、プロビジョニング中に設定する必要がありますか?


Value:

Must be 'true' or 'false'

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

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.


Value:

Must be 'true' or 'false'

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

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.


Value:

Must be 'true' or 'false'

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

BMCインタフェースの場合のみ。


Value:

Must be String

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

BMCインタフェースの場合のみ。


Value:

Must be String

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

インタフェースプロバイダ 例: IPMI. BMCインタフェースの場合のみ。


Value:

Must be one of: IPMI.

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

エイリアスもしくは VLAN デバイス


Value:

Must be 'true' or 'false'

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

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.


Value:

Must be String

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

このインタフェースが属するインタフェースの識別子 例: eth1 。※ 仮想インターフェイスの場合のみ


Value:

Must be String

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

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.


Value:

Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

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

Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces.


Value:

Must be an array of any type

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

空白で区切られたオプション(例 : miimon=100 )。 bond インタフェースのみ.


Value:

Must be String

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

インタフェースのための追加のコンピュートリソース固有の属性。


Value:

Must be Hash

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

追加のコンピュートリソース固有の属性


Value:

Must be Hash


DELETE /api/hosts/:id
ホストの削除

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
Get configuration status of host

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.


GET /api/hosts/:id/status/:type
ホストのステータス取得

Returns string representing a host status of a given type

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.

type
Required

status type, can be one of

  • global

  • configuration

  • build


Value:

Must be one of: HostStatus::Global, configuration, build.


GET /api/hosts/:id/vm_compute_attributes
ホストのVM属性を取得

Return the host's compute attributes that can be used to create a clone of this VM

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.


PUT /api/hosts/:id/puppetrun
ホスト上の Puppet エージェントの実行を強制

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.


PUT /api/hosts/:id/disassociate
VM からホストの関連付けを解除

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.


PUT /api/hosts/:id/power
ホストの電源操作を実行します

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.

power_action
Required

パワーアクション、有効な操作 (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)


Value:

Must be String


PUT /api/hosts/:id/boot
指定されたデバイスからホストを起動

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.

device
Required

起動デバイス、有効なデバイスは、ディスク、 CDROM 、 PXE 、 BIOS です


Value:

Must be String


POST /api/hosts/facts
ホストのファクトをアップロードし、必要に応じてホストを作成する

Params

Param Name Description
name
Required

ホストのホスト名


Value:

Must be String

facts
Required

ホストのファクトを含むハッシュ


Value:

Must be Hash

certname
Optional

オプション: ホストの証明書名


Value:

Must be String

type
Optional

optional: the STI type of host to create


Value:

Must be String


PUT /api/hosts/:id/rebuild_config
Rebuild orchestration config

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.


GET /api/hosts/:id/template/:kind
Preview rendered provisioning template content

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.

kind
Required

Template kinds, available values:


Value:

Must be String