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
環境ごとにホストを一覧表示

パラメーター

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

Only list ID and name of hosts

Validations:

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

hostgroup_id
任意

ホストグループの ID

Validations:

  • Must be a String

location_id
任意

ロケーションの ID

Validations:

  • Must be a String

organization_id
任意

組織の ID

Validations:

  • Must be a String

environment_id
任意

環境の ID

Validations:

  • Must be a String

include
任意

含める追加の情報タイプの配列

Validations:

  • Must be an array of [“parameters”, “all_parameters”]

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


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

パラメーター

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

show_hidden_parameters
任意

非表示のパラメーター値の表示

Validations:

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


POST /api/hosts
ホストの作成

パラメーター

パラメーター名 記述
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]
任意 , nil可

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

Validations:

  • Must be a String

host[ip]
任意 , nil可

DHCP プロキシーを使用するサブネットを使用する場合は不要です

Validations:

  • Must be a String

host[mac]
任意 , nil可

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

Validations:

  • Must be a String

host[architecture_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[domain_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[realm_id]
任意 , nil可

Validations:

  • Must be a number.

host[puppet_proxy_id]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

host[puppetclass_ids]
任意 , nil可

Validations:

  • Must be an array of any type

host[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

host[operatingsystem_id]
任意 , nil可

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

Validations:

  • Must be a String

host[medium_id]
任意 , nil可

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

Validations:

  • Must be a String

host[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

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

host[ptable_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[subnet_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[compute_resource_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[root_pass]
任意 , nil可

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

Validations:

  • Must be a String

host[model_id]
任意 , nil可

Validations:

  • Must be a number.

host[hostgroup_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_type]
任意 , nil可

ホストの所有者タイプ

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
任意 , nil可

Validations:

  • Must be a number.

host[host_parameters_attributes]
任意 , nil可

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

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]
任意 , nil可

Validations:

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

host[enabled]
任意 , nil可

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

Validations:

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

host[provision_method]
任意 , nil可

ホストをプロビジョニングするために使用されたメソッド。使用可能な provision_methods は build (ネットワークベース), image (イメージベース)

Validations:

  • Must be a String

host[managed]
任意 , nil可

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

Validations:

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

host[progress_report_id]
任意 , nil可

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

Validations:

  • Must be a String

host[comment]
任意 , nil可

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

Validations:

  • Must be a String

host[capabilities]
任意 , nil可

Validations:

  • Must be a String

host[compute_profile_id]
任意 , nil可

Validations:

  • Must be a number.

host[interfaces_attributes]
任意 , nil可

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

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
任意 , nil可

インターフェースの MAC アドレス。ベアメタルの管理対象インターフェースに必要です。

Validations:

  • Must be a String

host[interfaces_attributes][ip]
任意 , nil可

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

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
任意 , nil可

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

Validations:

  • Must be a String

host[interfaces_attributes][type]
任意 , nil可

インターフェースタイプ (bmc など)。デフォルト値は interface

Validations:

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

host[interfaces_attributes][name]
任意 , nil可

インターフェースの DNS 名

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
任意 , nil可

インターフェースの Foreman ドメイン ID。管理対象ホストのプライマリーインターフェースに必要

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
任意 , nil可

デバイス ID。例: eth0 または eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
任意 , nil可

このインターフェースは DHCP および DNS スマートプロキシーで管理し、プロビジョニング時に設定される必要がありますか?

Validations:

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

host[interfaces_attributes][primary]
任意 , nil可

このインターフェースをホストの FQDN の構築に使用する必要がありますか? 各管理対象ホストには 1 つのプライマリーインターフェースがある必要があります。

Validations:

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

host[interfaces_attributes][provision]
任意 , nil可

このインターフェースを PXELinux の TFTP に使用する必要がありますか (イメージベースのホストの場合は SSH)? 各管理対象ホストには 1 つのプロビジョンインターフェースがある必要があります。

Validations:

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

host[interfaces_attributes][username]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • Must be a String

host[interfaces_attributes][password]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • Must be a String

host[interfaces_attributes][provider]
任意 , nil可

インターフェースプロバイダー (例: IPMI)。BMC インターフェースの場合にのみ使用できます。

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
任意 , nil可

エイリアスまたは VLAN デバイス

Validations:

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

host[interfaces_attributes][tag]
任意 , nil可

VLAN タグ。この属性はサブネット VLAN ID より優先されます。仮想インターフェースの場合のみ使用されます。

Validations:

  • Must be a String

host[interfaces_attributes][attached_to]
任意 , nil可

このインターフェースが属するインターフェースの ID (例: eth1)。仮想インターフェースの場合にのみ使用できます。

Validations:

  • Must be a String

host[interfaces_attributes][mode]
任意 , nil可

インターフェースのボンドモードです (例: balance-rr)。ボンドインターフェースにのみ使用されます。

Validations:

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

host[interfaces_attributes][attached_devices]
任意 , nil可

接続されたインターフェースの ID `['eth1', 'eth2']`。ボンドインターフェースの場合、これらはスレーブになります (ボンドおよびブリッジインターフェースの場合のみ)。

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
任意 , nil可

スペースで区切られたオプション (例: e.g. miimon=100)。ボンドインターフェースの場合のみ使用します。

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
任意 , nil可

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

Validations:

  • Must be a Hash

host[compute_attributes]
任意 , nil可

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

Validations:

  • Must be a Hash


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

パラメーター

パラメーター名 記述
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[location_id]
任意

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

Validations:

  • Must be a number.

host[organization_id]
任意

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

Validations:

  • Must be a number.

host[environment_id]
任意 , nil可

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

Validations:

  • Must be a String

host[ip]
任意 , nil可

DHCP プロキシーを使用するサブネットを使用する場合は不要です

Validations:

  • Must be a String

host[mac]
任意 , nil可

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

Validations:

  • Must be a String

host[architecture_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[domain_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[realm_id]
任意 , nil可

Validations:

  • Must be a number.

host[puppet_proxy_id]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

host[puppetclass_ids]
任意 , nil可

Validations:

  • Must be an array of any type

host[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

host[operatingsystem_id]
任意 , nil可

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

Validations:

  • Must be a String

host[medium_id]
任意 , nil可

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

Validations:

  • Must be a String

host[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

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

host[ptable_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[subnet_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[compute_resource_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[root_pass]
任意 , nil可

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

Validations:

  • Must be a String

host[model_id]
任意 , nil可

Validations:

  • Must be a number.

host[hostgroup_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_type]
任意 , nil可

ホストの所有者タイプ

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
任意 , nil可

Validations:

  • Must be a number.

host[host_parameters_attributes]
任意 , nil可

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

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]
任意 , nil可

Validations:

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

host[enabled]
任意 , nil可

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

Validations:

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

host[provision_method]
任意 , nil可

ホストをプロビジョニングするために使用されたメソッド。使用可能な provision_methods は build (ネットワークベース), image (イメージベース)

Validations:

  • Must be a String

host[managed]
任意 , nil可

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

Validations:

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

host[progress_report_id]
任意 , nil可

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

Validations:

  • Must be a String

host[comment]
任意 , nil可

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

Validations:

  • Must be a String

host[capabilities]
任意 , nil可

Validations:

  • Must be a String

host[compute_profile_id]
任意 , nil可

Validations:

  • Must be a number.

host[interfaces_attributes]
任意 , nil可

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

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
任意 , nil可

インターフェースの MAC アドレス。ベアメタルの管理対象インターフェースに必要です。

Validations:

  • Must be a String

host[interfaces_attributes][ip]
任意 , nil可

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

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
任意 , nil可

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

Validations:

  • Must be a String

host[interfaces_attributes][type]
任意 , nil可

インターフェースタイプ (bmc など)。デフォルト値は interface

Validations:

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

host[interfaces_attributes][name]
任意 , nil可

インターフェースの DNS 名

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
任意 , nil可

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

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
任意 , nil可

インターフェースの Foreman ドメイン ID。管理対象ホストのプライマリーインターフェースに必要

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
任意 , nil可

デバイス ID。例: eth0 または eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
任意 , nil可

このインターフェースは DHCP および DNS スマートプロキシーで管理し、プロビジョニング時に設定される必要がありますか?

Validations:

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

host[interfaces_attributes][primary]
任意 , nil可

このインターフェースをホストの FQDN の構築に使用する必要がありますか? 各管理対象ホストには 1 つのプライマリーインターフェースがある必要があります。

Validations:

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

host[interfaces_attributes][provision]
任意 , nil可

このインターフェースを PXELinux の TFTP に使用する必要がありますか (イメージベースのホストの場合は SSH)? 各管理対象ホストには 1 つのプロビジョンインターフェースがある必要があります。

Validations:

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

host[interfaces_attributes][username]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • Must be a String

host[interfaces_attributes][password]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • Must be a String

host[interfaces_attributes][provider]
任意 , nil可

インターフェースプロバイダー (例: IPMI)。BMC インターフェースの場合にのみ使用できます。

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
任意 , nil可

エイリアスまたは VLAN デバイス

Validations:

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

host[interfaces_attributes][tag]
任意 , nil可

VLAN タグ。この属性はサブネット VLAN ID より優先されます。仮想インターフェースの場合のみ使用されます。

Validations:

  • Must be a String

host[interfaces_attributes][attached_to]
任意 , nil可

このインターフェースが属するインターフェースの ID (例: eth1)。仮想インターフェースの場合にのみ使用できます。

Validations:

  • Must be a String

host[interfaces_attributes][mode]
任意 , nil可

インターフェースのボンドモードです (例: balance-rr)。ボンドインターフェースにのみ使用されます。

Validations:

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

host[interfaces_attributes][attached_devices]
任意 , nil可

接続されたインターフェースの ID `['eth1', 'eth2']`。ボンドインターフェースの場合、これらはスレーブになります (ボンドおよびブリッジインターフェースの場合のみ)。

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
任意 , nil可

スペースで区切られたオプション (例: e.g. miimon=100)。ボンドインターフェースの場合のみ使用します。

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
任意 , nil可

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

Validations:

  • Must be a Hash

host[compute_attributes]
任意 , nil可

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

Validations:

  • Must be a Hash


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

パラメーター

パラメーター名 記述
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/enc
ホストの ENC 値の取得

パラメーター

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


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

Return value may either be one of the following:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

パラメーター

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


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

Returns string representing a host status of a given type

パラメーター

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

type
必須

ステータスタイプ。以下のいずれか

  • global

  • configuration

  • build

Validations:

  • 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

パラメーター

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


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

パラメーター

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


PUT /api/hosts/:id/power
ホストでパワー操作を実行します

パラメーター

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

power_action
必須

パワーアクション。有効なアクションは (on/start)、(off/stop)、(soft/reboot)、(cycle/reset)、(state/status) です。

Validations:

  • Must be a String


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

パラメーター

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

device
必須

ブートデバイス。有効なデバイスはディスク、CDROM、PXE、BIOS です。

Validations:

  • Must be a String


POST /api/hosts/facts
ホストのファクトをアップロードし、必要な場合はホストを作成します

パラメーター

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

ホストのホスト名

Validations:

  • Must be a String

facts
必須

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

Validations:

  • Must be a Hash

certname
任意

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

Validations:

  • Must be a String

type
任意

オプション: 作成するホストの STI タイプ

Validations:

  • Must be a String


PUT /api/hosts/:id/rebuild_config
オーケストレーション設定の再ビルド

パラメーター

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

only
任意

再ビルドのステップの制限。有効なステップは DHCP, DNS, TFTP です。

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
テンプレートコンテンツのプロビジョニング中にプレビューがレンダリングされました

パラメーター

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

kind
必須

テンプレート種類、利用可能な値: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP

Validations:

  • Must be a String