Param Name | Description |
---|---|
hostgroup_id Optional |
ホストグループの ID Validations:
|
location_id Optional |
ロケーションの ID Validations:
|
organization_id Optional |
組織の ID Validations:
|
environment_id Optional |
環境の ID Validations:
|
search Optional |
結果をフィルタ Validations:
|
order Optional |
結果をソート Validations:
|
page Optional |
結果をページ分割 Validations:
|
per_page Optional |
リクエストあたりのエントリ数 Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
host Required |
Validations:
|
host[name] Required |
Validations:
|
host[location_id] Required |
ロケーションが有効になっている場合に必要 Validations:
|
host[organization_id] Required |
組織が有効になっている場合に必要 Validations:
|
host[environment_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[ip] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
DHCP プロキシとサブネットを使用している場合は必要ではありません Validations:
|
host[mac] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ベアメタルでマネージドに設定されているホストである場合に必要です。仮想マシンの場合は必須ではありません Validations:
|
host[architecture_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[domain_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[realm_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[puppet_proxy_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[puppetclass_ids] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[operatingsystem_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[medium_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
イメージベースプロビジョニングではなく、ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[ptable_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストがマネージドであり、カスタムパーティションが定義されていない場合に必要 Validations:
|
host[subnet_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[compute_resource_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
nilは、ホストがベアメタルであることを意味します Validations:
|
host[root_pass] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値が設定でホストグループまたはデフォルトのパスワードから継承されていない場合に必要 Validations:
|
host[model_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[hostgroup_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[owner_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[owner_type] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストの所有者タイプ Validations:
|
host[puppet_ca_proxy_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[image_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[host_parameters_attributes] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Host's parameters (array or indexed hash) Validations:
|
host[host_parameters_attributes][name] Required |
Name of the parameter Validations:
|
host[host_parameters_attributes][value] Required |
Parameter value Validations:
|
host[build] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[enabled] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
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 (イメージベース) Validations:
|
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 Validations:
|
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 Validations:
|
host[comment] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
このホストに関する追加情報 Validations:
|
host[capabilities] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[compute_profile_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[interfaces_attributes] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストネットワークインターフェイス. Validations:
|
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. Validations:
|
host[interfaces_attributes][ip] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インターフェイスの IP アドレス Validations:
|
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 Validations:
|
host[interfaces_attributes][name] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インターフェイスの DNS 名 Validations:
|
host[interfaces_attributes][subnet_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インターフェイスの Foreman サブネット ID Validations:
|
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. Validations:
|
host[interfaces_attributes][identifier] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
デバイス識別子 例: eth0 or eth1.1 Validations:
|
host[interfaces_attributes][managed] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
このインタフェースは、 DHCP と DNS スマートプロキシ経由で管理する必要があり、それは、プロビジョニング中に設定する必要がありますか? Validations:
|
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. Validations:
|
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. Validations:
|
host[interfaces_attributes][username] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
BMCインタフェースの場合のみ。 Validations:
|
host[interfaces_attributes][password] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
BMCインタフェースの場合のみ。 Validations:
|
host[interfaces_attributes][provider] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インタフェースプロバイダ 例: IPMI. BMCインタフェースの場合のみ。 Validations:
|
host[interfaces_attributes][virtual] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
エイリアスもしくは VLAN デバイス Validations:
|
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. Validations:
|
host[interfaces_attributes][attached_to] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
このインタフェースが属するインタフェースの識別子 例: eth1 。※ 仮想インターフェイスの場合のみ Validations:
|
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. Validations:
|
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. Validations:
|
host[interfaces_attributes][bond_options] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
空白で区切られたオプション(例 : miimon=100 )。 bond インタフェースのみ. Validations:
|
host[interfaces_attributes][compute_attributes] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インタフェースのための追加のコンピュートリソース固有の属性。 Validations:
|
host[compute_attributes] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
追加のコンピュートリソース固有の属性 Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
host Required |
Validations:
|
host[name] Optional |
Validations:
|
host[location_id] Optional |
ロケーションが有効になっている場合に必要 Validations:
|
host[organization_id] Optional |
組織が有効になっている場合に必要 Validations:
|
host[environment_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[ip] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
DHCP プロキシとサブネットを使用している場合は必要ではありません Validations:
|
host[mac] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ベアメタルでマネージドに設定されているホストである場合に必要です。仮想マシンの場合は必須ではありません Validations:
|
host[architecture_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[domain_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[realm_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[puppet_proxy_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[puppetclass_ids] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[operatingsystem_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[medium_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
イメージベースプロビジョニングではなく、ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[ptable_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストがマネージドであり、カスタムパーティションが定義されていない場合に必要 Validations:
|
host[subnet_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値がホストグループから継承されていない場合に必要 Validations:
|
host[compute_resource_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
nilは、ホストがベアメタルであることを意味します Validations:
|
host[root_pass] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストが管理され、値が設定でホストグループまたはデフォルトのパスワードから継承されていない場合に必要 Validations:
|
host[model_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[hostgroup_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[owner_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[owner_type] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストの所有者タイプ Validations:
|
host[puppet_ca_proxy_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[image_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[host_parameters_attributes] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Host's parameters (array or indexed hash) Validations:
|
host[host_parameters_attributes][name] Optional |
Name of the parameter Validations:
|
host[host_parameters_attributes][value] Optional |
Parameter value Validations:
|
host[build] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[enabled] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
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 (イメージベース) Validations:
|
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 Validations:
|
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 Validations:
|
host[comment] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
このホストに関する追加情報 Validations:
|
host[capabilities] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[compute_profile_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[interfaces_attributes] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
ホストネットワークインターフェイス. Validations:
|
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. Validations:
|
host[interfaces_attributes][ip] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インターフェイスの IP アドレス Validations:
|
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 Validations:
|
host[interfaces_attributes][name] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インターフェイスの DNS 名 Validations:
|
host[interfaces_attributes][subnet_id] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インターフェイスの Foreman サブネット ID Validations:
|
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. Validations:
|
host[interfaces_attributes][identifier] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
デバイス識別子 例: eth0 or eth1.1 Validations:
|
host[interfaces_attributes][managed] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
このインタフェースは、 DHCP と DNS スマートプロキシ経由で管理する必要があり、それは、プロビジョニング中に設定する必要がありますか? Validations:
|
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. Validations:
|
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. Validations:
|
host[interfaces_attributes][username] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
BMCインタフェースの場合のみ。 Validations:
|
host[interfaces_attributes][password] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
BMCインタフェースの場合のみ。 Validations:
|
host[interfaces_attributes][provider] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インタフェースプロバイダ 例: IPMI. BMCインタフェースの場合のみ。 Validations:
|
host[interfaces_attributes][virtual] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
エイリアスもしくは VLAN デバイス Validations:
|
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. Validations:
|
host[interfaces_attributes][attached_to] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
このインタフェースが属するインタフェースの識別子 例: eth1 。※ 仮想インターフェイスの場合のみ Validations:
|
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. Validations:
|
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. Validations:
|
host[interfaces_attributes][bond_options] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
空白で区切られたオプション(例 : miimon=100 )。 bond インタフェースのみ. Validations:
|
host[interfaces_attributes][compute_attributes] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
インタフェースのための追加のコンピュートリソース固有の属性。 Validations:
|
host[compute_attributes] Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span> |
追加のコンピュートリソース固有の属性 Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Return value may either be one of the following:
missing
failed
pending
changed
unchanged
unreported
Param Name | Description |
---|---|
id Required |
Validations:
|
Returns string representing a host status of a given type
Param Name | Description |
---|---|
id Required |
Validations:
|
type Required |
status type, can be one of
Validations:
|
Return the host's compute attributes that can be used to create a clone of this VM
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
power_action Required |
パワーアクション、有効な操作 (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status) Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
device Required |
起動デバイス、有効なデバイスは、ディスク、 CDROM 、 PXE 、 BIOS です Validations:
|
Param Name | Description |
---|---|
name Required |
ホストのホスト名 Validations:
|
facts Required |
ホストのファクトを含むハッシュ Validations:
|
certname Optional |
オプション: ホストの証明書名 Validations:
|
type Optional |
optional: the STI type of host to create Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
kind Required |
Template kinds, available values: Validations:
|