Params

Param Name Description
id
Required

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
Required

Validations:

  • Must be a Hash

host[name]
Optional

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • 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>

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be a number.

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

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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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

ホストの所有者タイプ

Validations:

  • 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>

Validations:

  • Must be a number.

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

Validations:

  • Must be a number.

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:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
Optional

Name of the parameter

Validations:

  • Must be String

host[host_parameters_attributes][value]
Optional

Parameter value

Validations:

  • Must be String

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

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

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

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

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:

  • Must be String

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

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

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

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:

  • Must be String

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

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

Validations:

  • Must be String

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

Validations:

  • Must be String

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

Validations:

  • Must be a number.

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

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

Validations:

  • 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.

Validations:

  • Must be String

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

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

Validations:

  • 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

Validations:

  • 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 名

Validations:

  • 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

Validations:

  • 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.

Validations:

  • 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

Validations:

  • Must be String

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

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

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

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:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

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:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • 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 デバイス

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

インターフェースのボンドモードです (例: 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]
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:

  • 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 インタフェースのみ.

Validations:

  • Must be String

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

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

Validations:

  • Must be Hash

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

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

Validations:

  • Must be Hash