パラメーター名 | 記述 |
---|---|
thin 任意 |
ホストの一覧 ID および名前のみ Validations:
|
hostgroup_id 任意 |
ホストグループの ID Validations:
|
location_id 任意 |
ロケーションの ID Validations:
|
organization_id 任意 |
組織の ID Validations:
|
environment_id 任意 |
環境の ID Validations:
|
include 任意 |
含める追加の情報タイプの配列 Validations:
|
search 任意 |
結果のフィルター Validations:
|
order 任意 |
フィールドと順序のソート (例: ‘id DESC’) Validations:
|
page 任意 |
結果のページネーション Validations:
|
per_page 任意 |
要求ごとのエントリー数 Validations:
|
フィールド名 | タイプ | 設定可能な値 |
---|---|---|
ansible_role | string | |
architecture | string | |
build | true, false | |
class | string | |
comment | text | |
compute_resource | string | |
compute_resource_id | integer | |
config_group | string | |
domain | string | |
domain_id | integer | |
environment | string | |
execution_status | ok, error | |
facts | string | |
global_status | ok, warning, error | |
has_ip | string | |
has_mac | string | |
hostgroup | string | |
hostgroup_fullname | string | |
hostgroup_id | integer | |
hostgroup_name | string | |
hostgroup_title | string | |
image | string | |
installed_at | datetime | |
ip | string | |
job_invocation.id | string | |
job_invocation.result | cancelled, failed, pending, success | |
last_report | datetime | |
location | string | |
location_id | integer | |
mac | string | |
managed | true, false | |
model | string | |
name | string | |
organization | string | |
organization_id | integer | |
origin | string | |
os | string | |
os_description | string | |
os_id | integer | |
os_major | string | |
os_minor | string | |
os_title | string | |
owner | string | |
owner_id | integer | |
owner_type | string | |
params | string | |
parent_hostgroup | string | |
puppet_ca | string | |
puppet_proxy_id | integer | |
puppetmaster | string | |
realm | string | |
realm_id | integer | |
smart_proxy | string | |
status.applied | integer | |
status.enabled | true, false | |
status.failed | integer | |
status.failed_restarts | integer | |
status.interesting | true, false | |
status.pending | integer | |
status.restarted | integer | |
status.skipped | integer | |
subnet | string | |
subnet.name | text | |
subnet6 | string | |
subnet6.name | text | |
user.firstname | string | |
user.lastname | string | |
user.login | string | |
user.mail | string | |
usergroup | string | |
usergroup.name | string | |
uuid | string |
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
show_hidden_parameters 任意 |
非表示のパラメーター値の表示 Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
host 必須 |
Validations:
|
host[name] 必須 |
Validations:
|
host[location_id] 必須 |
ロケーションが有効にされている場合に必須です。 Validations:
|
host[organization_id] 必須 |
組織が有効にされている場合に必須です。 Validations:
|
host[environment_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[ip] 任意 , nil可 |
DHCP プロキシーを使用するサブネットを使用する場合は不要です Validations:
|
host[mac] 任意 , nil可 |
管理ホストがベアメタルの場合に必須です。仮想マシンの場合は不要です。 Validations:
|
host[architecture_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[domain_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[realm_id] 任意 , nil可 |
Validations:
|
host[puppet_proxy_id] 任意 , nil可 |
Puppet プロキシー ID Validations:
|
host[puppet_ca_proxy_id] 任意 , nil可 |
Puppet CA プロキシー ID Validations:
|
host[puppetclass_ids] 任意 , nil可 |
Validations:
|
host[config_group_ids] 任意 , nil可 |
関連付けられた設定グループの ID Validations:
|
host[operatingsystem_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[medium_id] 任意 , nil可 |
イメージベースのプロビジョニングでない場合で、ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[pxe_loader] 任意 , nil可 |
DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux) Validations:
|
host[ptable_id] 任意 , nil可 |
ホストが管理されており、カスタムパーティションが定義されていない場合に必須です。 Validations:
|
host[subnet_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[compute_resource_id] 任意 , nil可 |
Nil はホストがベアメタルであることを意味します Validations:
|
host[root_pass] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていないか、または設定済みのデフォルトパスワードである場合に必須です。 Validations:
|
host[model_id] 任意 , nil可 |
Validations:
|
host[hostgroup_id] 任意 , nil可 |
Validations:
|
host[owner_id] 任意 , nil可 |
Validations:
|
host[owner_type] 任意 , nil可 |
ホストの所有者タイプ Validations:
|
host[image_id] 任意 , nil可 |
Validations:
|
host[host_parameters_attributes] 任意 , nil可 |
ホストのパラメーター (配列またはインデックス化されたハッシュ) Validations:
|
host[host_parameters_attributes][name] 必須 |
パラメーター名 Validations:
|
host[host_parameters_attributes][value] 必須 |
パラメーター値 Validations:
|
host[build] 任意 , nil可 |
Validations:
|
host[enabled] 任意 , nil可 |
このホストを Foreman レポート内に組み込む Validations:
|
host[provision_method] 任意 , nil可 |
このメソッドは、ホストのプロビジョニングに使用されます。 Validations:
|
host[managed] 任意 , nil可 |
ホストを管理対象とするかどうかについての True/False フラグです。注意: この値は複数のパラメーターが必要となるかどうかも決定します。 Validations:
|
host[progress_report_id] 任意 , nil可 |
オーケストレーションタスクの状態を追跡するための UUID。GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] 任意 , nil可 |
このホストについての追加情報 Validations:
|
host[capabilities] 任意 , nil可 |
Validations:
|
host[compute_profile_id] 任意 , nil可 |
Validations:
|
host[interfaces_attributes] 任意 , nil可 |
ホストのネットワークインターフェース Validations:
|
host[interfaces_attributes][mac] 任意 , nil可 |
インターフェースの MAC アドレス。ベアメタルの管理対象インターフェースに必要です。 Validations:
|
host[interfaces_attributes][ip] 任意 , nil可 |
インターフェースの IPv4 アドレス Validations:
|
host[interfaces_attributes][ip6] 任意 , nil可 |
インターフェースの IPv6 アドレス Validations:
|
host[interfaces_attributes][type] 任意 , nil可 |
インターフェースタイプ (bmc など)。デフォルト値は interface Validations:
|
host[interfaces_attributes][name] 任意 , nil可 |
インターフェースの DNS 名 Validations:
|
host[interfaces_attributes][subnet_id] 任意 , nil可 |
IPv4 インターフェースの Foreman サブネット ID Validations:
|
host[interfaces_attributes][subnet6_id] 任意 , nil可 |
IPv6 インターフェースの Foreman サブネット ID Validations:
|
host[interfaces_attributes][domain_id] 任意 , nil可 |
インターフェースの Foreman ドメイン ID。管理対象ホストのプライマリーインターフェースに必要 Validations:
|
host[interfaces_attributes][identifier] 任意 , nil可 |
デバイス ID。例: eth0 または eth1.1 Validations:
|
host[interfaces_attributes][managed] 任意 , nil可 |
このインターフェースは DHCP および DNS スマートプロキシーで管理し、プロビジョニング時に設定される必要がありますか? Validations:
|
host[interfaces_attributes][primary] 任意 , nil可 |
このインターフェースをホストの FQDN の構築に使用する必要がありますか? 各管理対象ホストには 1 つのプライマリーインターフェースがある必要があります。 Validations:
|
host[interfaces_attributes][provision] 任意 , nil可 |
このインターフェースを PXELinux の TFTP に使用する必要がありますか (イメージベースのホストの場合は SSH)? 各管理対象ホストには 1 つのプロビジョンインターフェースがある必要があります。 Validations:
|
host[interfaces_attributes][username] 任意 , nil可 |
BMC インターフェスのみ。 Validations:
|
host[interfaces_attributes][password] 任意 , nil可 |
BMC インターフェスのみ。 Validations:
|
host[interfaces_attributes][provider] 任意 , nil可 |
インターフェースプロバイダー (例: IPMI)。BMC インターフェースの場合にのみ使用できます。 Validations:
|
host[interfaces_attributes][virtual] 任意 , nil可 |
エイリアスまたは VLAN デバイス Validations:
|
host[interfaces_attributes][tag] 任意 , nil可 |
VLAN タグ。この属性はサブネット VLAN ID より優先されます。仮想インターフェースの場合のみ使用されます。 Validations:
|
host[interfaces_attributes][mtu] 任意 , nil可 |
MTU。この属性はサブネット MTU より優先されます。 Validations:
|
host[interfaces_attributes][attached_to] 任意 , nil可 |
このインターフェースが属するインターフェースの ID (例: eth1)。仮想インターフェースの場合にのみ使用できます。 Validations:
|
host[interfaces_attributes][mode] 任意 , nil可 |
インターフェースのボンドモードです (例: balance-rr)。ボンドインターフェースにのみ使用されます。 Validations:
|
host[interfaces_attributes][attached_devices] 任意 , nil可 |
接続されたインターフェースの ID `['eth1', 'eth2']`。ボンドインターフェースの場合、これらはスレーブになります (ボンドおよびブリッジインターフェースの場合のみ)。 Validations:
|
host[interfaces_attributes][bond_options] 任意 , nil可 |
スペースで区切られたオプション (例: e.g. miimon=100)。ボンドインターフェースの場合のみ使用します。 Validations:
|
host[interfaces_attributes][compute_attributes] 任意 , nil可 |
インターフェースの追加のコンピュートリソース固有の属性。 Validations:
|
host[compute_attributes] 任意 , nil可 |
追加のコンピュートリソース固有の属性。 Validations:
|
host[ansible_role_ids] 任意 |
IDs of associated ansible roles Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
host 必須 |
Validations:
|
host[name] 任意 |
Validations:
|
host[location_id] 任意 |
ロケーションが有効にされている場合に必須です。 Validations:
|
host[organization_id] 任意 |
組織が有効にされている場合に必須です。 Validations:
|
host[environment_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[ip] 任意 , nil可 |
DHCP プロキシーを使用するサブネットを使用する場合は不要です Validations:
|
host[mac] 任意 , nil可 |
管理ホストがベアメタルの場合に必須です。仮想マシンの場合は不要です。 Validations:
|
host[architecture_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[domain_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[realm_id] 任意 , nil可 |
Validations:
|
host[puppet_proxy_id] 任意 , nil可 |
Puppet プロキシー ID Validations:
|
host[puppet_ca_proxy_id] 任意 , nil可 |
Puppet CA プロキシー ID Validations:
|
host[puppetclass_ids] 任意 , nil可 |
Validations:
|
host[config_group_ids] 任意 , nil可 |
関連付けられた設定グループの ID Validations:
|
host[operatingsystem_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[medium_id] 任意 , nil可 |
イメージベースのプロビジョニングでない場合で、ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[pxe_loader] 任意 , nil可 |
DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux) Validations:
|
host[ptable_id] 任意 , nil可 |
ホストが管理されており、カスタムパーティションが定義されていない場合に必須です。 Validations:
|
host[subnet_id] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていない場合に必須です。 Validations:
|
host[compute_resource_id] 任意 , nil可 |
Nil はホストがベアメタルであることを意味します Validations:
|
host[root_pass] 任意 , nil可 |
ホストが管理されており、値がホストグループから継承されていないか、または設定済みのデフォルトパスワードである場合に必須です。 Validations:
|
host[model_id] 任意 , nil可 |
Validations:
|
host[hostgroup_id] 任意 , nil可 |
Validations:
|
host[owner_id] 任意 , nil可 |
Validations:
|
host[owner_type] 任意 , nil可 |
ホストの所有者タイプ Validations:
|
host[image_id] 任意 , nil可 |
Validations:
|
host[host_parameters_attributes] 任意 , nil可 |
ホストのパラメーター (配列またはインデックス化されたハッシュ) Validations:
|
host[host_parameters_attributes][name] 任意 |
パラメーター名 Validations:
|
host[host_parameters_attributes][value] 任意 |
パラメーター値 Validations:
|
host[build] 任意 , nil可 |
Validations:
|
host[enabled] 任意 , nil可 |
このホストを Foreman レポート内に組み込む Validations:
|
host[provision_method] 任意 , nil可 |
このメソッドは、ホストのプロビジョニングに使用されます。 Validations:
|
host[managed] 任意 , nil可 |
ホストを管理対象とするかどうかについての True/False フラグです。注意: この値は複数のパラメーターが必要となるかどうかも決定します。 Validations:
|
host[progress_report_id] 任意 , nil可 |
オーケストレーションタスクの状態を追跡するための UUID。GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] 任意 , nil可 |
このホストについての追加情報 Validations:
|
host[capabilities] 任意 , nil可 |
Validations:
|
host[compute_profile_id] 任意 , nil可 |
Validations:
|
host[interfaces_attributes] 任意 , nil可 |
ホストのネットワークインターフェース Validations:
|
host[interfaces_attributes][mac] 任意 , nil可 |
インターフェースの MAC アドレス。ベアメタルの管理対象インターフェースに必要です。 Validations:
|
host[interfaces_attributes][ip] 任意 , nil可 |
インターフェースの IPv4 アドレス Validations:
|
host[interfaces_attributes][ip6] 任意 , nil可 |
インターフェースの IPv6 アドレス Validations:
|
host[interfaces_attributes][type] 任意 , nil可 |
インターフェースタイプ (bmc など)。デフォルト値は interface Validations:
|
host[interfaces_attributes][name] 任意 , nil可 |
インターフェースの DNS 名 Validations:
|
host[interfaces_attributes][subnet_id] 任意 , nil可 |
IPv4 インターフェースの Foreman サブネット ID Validations:
|
host[interfaces_attributes][subnet6_id] 任意 , nil可 |
IPv6 インターフェースの Foreman サブネット ID Validations:
|
host[interfaces_attributes][domain_id] 任意 , nil可 |
インターフェースの Foreman ドメイン ID。管理対象ホストのプライマリーインターフェースに必要 Validations:
|
host[interfaces_attributes][identifier] 任意 , nil可 |
デバイス ID。例: eth0 または eth1.1 Validations:
|
host[interfaces_attributes][managed] 任意 , nil可 |
このインターフェースは DHCP および DNS スマートプロキシーで管理し、プロビジョニング時に設定される必要がありますか? Validations:
|
host[interfaces_attributes][primary] 任意 , nil可 |
このインターフェースをホストの FQDN の構築に使用する必要がありますか? 各管理対象ホストには 1 つのプライマリーインターフェースがある必要があります。 Validations:
|
host[interfaces_attributes][provision] 任意 , nil可 |
このインターフェースを PXELinux の TFTP に使用する必要がありますか (イメージベースのホストの場合は SSH)? 各管理対象ホストには 1 つのプロビジョンインターフェースがある必要があります。 Validations:
|
host[interfaces_attributes][username] 任意 , nil可 |
BMC インターフェスのみ。 Validations:
|
host[interfaces_attributes][password] 任意 , nil可 |
BMC インターフェスのみ。 Validations:
|
host[interfaces_attributes][provider] 任意 , nil可 |
インターフェースプロバイダー (例: IPMI)。BMC インターフェースの場合にのみ使用できます。 Validations:
|
host[interfaces_attributes][virtual] 任意 , nil可 |
エイリアスまたは VLAN デバイス Validations:
|
host[interfaces_attributes][tag] 任意 , nil可 |
VLAN タグ。この属性はサブネット VLAN ID より優先されます。仮想インターフェースの場合のみ使用されます。 Validations:
|
host[interfaces_attributes][mtu] 任意 , nil可 |
MTU。この属性はサブネット MTU より優先されます。 Validations:
|
host[interfaces_attributes][attached_to] 任意 , nil可 |
このインターフェースが属するインターフェースの ID (例: eth1)。仮想インターフェースの場合にのみ使用できます。 Validations:
|
host[interfaces_attributes][mode] 任意 , nil可 |
インターフェースのボンドモードです (例: balance-rr)。ボンドインターフェースにのみ使用されます。 Validations:
|
host[interfaces_attributes][attached_devices] 任意 , nil可 |
接続されたインターフェースの ID `['eth1', 'eth2']`。ボンドインターフェースの場合、これらはスレーブになります (ボンドおよびブリッジインターフェースの場合のみ)。 Validations:
|
host[interfaces_attributes][bond_options] 任意 , nil可 |
スペースで区切られたオプション (例: e.g. miimon=100)。ボンドインターフェースの場合のみ使用します。 Validations:
|
host[interfaces_attributes][compute_attributes] 任意 , nil可 |
インターフェースの追加のコンピュートリソース固有の属性。 Validations:
|
host[compute_attributes] 任意 , nil可 |
追加のコンピュートリソース固有の属性。 Validations:
|
host[ansible_role_ids] 任意 |
IDs of associated ansible roles Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
Return value may either be one of the following:
Alerts disabled
No reports
Error
Out of sync
Active
Pending
No changes
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
Returns string representing a host status of a given type
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
type 必須 |
ステータスタイプ。以下のいずれか
Validations:
|
Return the host's compute attributes that can be used to create a clone of this VM
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
power_action 必須 |
パワーアクション。有効なアクションは (on/start)、(off/stop)、(soft/reboot)、(cycle/reset)、(state/status) です。 Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
device 必須 |
ブートデバイス。有効なデバイスはディスク、CDROM、PXE、BIOS です。 Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
name 必須 |
ホストのホスト名 Validations:
|
facts 必須 |
ホストのファクトを含むハッシュ Validations:
|
certname 任意 |
オプション: ホストの証明書名 Validations:
|
type 任意 |
オプション: 作成するホストの STI タイプ Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
only 任意 |
再ビルドのステップの制限。有効なステップは DHCP, DNS, TFTP です。 Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
kind 必須 |
テンプレート種類、利用可能な値: Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
host_ids 必須 |
IDs of hosts to play roles on Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
パラメーター名 | 記述 |
---|---|
location_id 任意 |
ロケーション別のスコープ Validations:
|
organization_id 任意 |
組織別のスコープ Validations:
|
id 必須 |
Validations:
|
ansible_role_ids 必須 |
Ansible roles to assign to a host Validations:
|