GET /api/hosts/:host_id/interfaces
ホストのインターフェイス一覧

GET /api/domains/:domain_id/interfaces
ドメインのインターフェイス一覧

GET /api/subnets/:subnet_id/interfaces
サブネットのインターフェイス一覧

Params

Param Name Description
host_id
Required

ホストの ID または名前

Validations:

  • Must be String

domain_id
Optional

ドメインの ID または名前

Validations:

  • Must be String

subnet_id
Optional

サブネットの ID または名前

Validations:

  • Must be String

page
Optional

結果をページ分割

Validations:

  • Must be String

per_page
Optional

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

Validations:

  • Must be String


GET /api/hosts/:host_id/interfaces/:id
ホストのインターフェイスを表示

Params

Param Name Description
host_id
Required

ホストの ID または名前

Validations:

  • Must be String

id
Required

インターフェイスの ID または名前

Validations:

  • Must be String


POST /api/hosts/:host_id/interfaces
ホストにインターフェイスを作成

Params

Param Name Description
host_id
Required

ホストの ID または名前

Validations:

  • Must be String

interface
Required

インターフェイス情報

Validations:

  • Must be a Hash

interface[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

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

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

Validations:

  • Must be String

interface[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.

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

インターフェイスの DNS 名

Validations:

  • Must be String

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

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

Validations:

  • Must be Fixnum

interface[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

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

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

Validations:

  • Must be String

interface[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'

interface[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'

interface[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'

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be one of: IPMI.

interface[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'

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

interface[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.

interface[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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be Hash


PUT /api/hosts/:host_id/interfaces/:id
ホストのインターフェイスを更新

Params

Param Name Description
host_id
Required

ホストの ID または名前

Validations:

  • Must be String

id
Required

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

interface
Required

インターフェイス情報

Validations:

  • Must be a Hash

interface[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

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

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

Validations:

  • Must be String

interface[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.

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

インターフェイスの DNS 名

Validations:

  • Must be String

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

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

Validations:

  • Must be Fixnum

interface[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

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

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

Validations:

  • Must be String

interface[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'

interface[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'

interface[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'

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be one of: IPMI.

interface[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'

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be String

interface[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.

interface[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

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

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

Validations:

  • Must be String

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

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

Validations:

  • Must be Hash


DELETE /api/hosts/:host_id/interfaces/:id
ホストのインタフェースを削除する

Params

Param Name Description
host_id
Required

ホストの ID または名前

Validations:

  • Must be String

id
Required

インターフェイスの ID

Validations:

  • Must be String